Main line shape model class. More...

#include <lineshapemodel.h>

Public Member Functions
	Model (Index n=0) noexcept
	Default init just sets the size.

	Model (const std::vector< SingleSpeciesModel > &assm) noexcept
	Init from copying a vector.

	Model (const Model &m) noexcept
	Init from copying itself.

	Model (std::vector< SingleSpeciesModel > &&assm) noexcept
	Init from moving a vector.

	Model (Model &&m) noexcept
	Init from moving a itself.

Model &	operator= (const Model &m)=default
	Copy and equals.

Model &	operator= (Model &&m)=default
	Move and equals.

	Model (Numeric sgam, Numeric nself, Numeric agam, Numeric nair, Numeric psf, std::array< Numeric, 12 > aer_interp={0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}) noexcept
	Standard HITRAN init.

bool	OK (Type type, bool self, bool bath, const std::size_t nspecies) const noexcept
	The Model is good to use.

Index	nelem () const noexcept
	Number of species in Model.

Index	size () const
	Number of species in Model.

void	resize (Index n)
	Resize function for Model.

void	reserve (Index n)
	Reserve function for Model.

SingleSpeciesModel &	operator[] (Index i)
	Get a SingleSpeciesModel.

const SingleSpeciesModel &	operator[] (Index i) const
	Get a SingleSpeciesModel.

auto	begin ()

auto	end ()

auto	begin () const

auto	end () const

auto	cbegin () const

auto	cend () const

const std::vector< SingleSpeciesModel > &	Data () const noexcept
	The line shape model data.

std::vector< SingleSpeciesModel > &	Data () noexcept
	The line shape model data reference.

void	Remove (Index i, ArrayOfSpeciesTag &specs)
	Remove species and data at position.

void	Remove (Index i, ArrayOfSpecies &specs)

void	SetLineMixingModel (SingleSpeciesModel x)
	Sets the same line mixing model to all species.

std::pair< bool, bool >	Match (const Model &other) const noexcept

bifstream &	read (bifstream &bif)
	Binary read for Model.

bofstream &	write (bofstream &bof) const
	Binary write for Model.

Numeric	G0 (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	D0 (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	G2 (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	D2 (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	ETA (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	FVC (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	Y (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	G (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	DV (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dG0dT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dD0dT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dG2dT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dD2dT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dETAdT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dFVCdT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dYdT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dGdT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Numeric	dDVdT (Numeric T, Numeric T0, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT

Private Attributes
std::vector< SingleSpeciesModel >	mdata

Friends
std::istream &	from_linefunctiondata (std::istream &data, Type &type, bool &self, bool &bath, Model &m, ArrayOfSpecies &species)

std::istream &	from_artscat4 (std::istream &is, Type &type, bool &self, bool &bath, Model &m, ArrayOfSpecies &species, const QuantumIdentifier &qid)

std::ostream &	operator<< (std::ostream &, const Model &)

std::istream &	operator>> (std::istream &, Model &)

Detailed Description

Main line shape model class.

Computes the line shape parameters for a given atmosphere

Definition at line 647 of file lineshapemodel.h.

Constructor & Destructor Documentation

◆ Model() [1/6]

LineShape::Model::Model ( Index n = 0 )

inlinenoexcept

Default init just sets the size.

Definition at line 653 of file lineshapemodel.h.

◆ Model() [2/6]

LineShape::Model::Model ( const std::vector< SingleSpeciesModel > & assm )

inlineexplicitnoexcept

Init from copying a vector.

Definition at line 656 of file lineshapemodel.h.

◆ Model() [3/6]

LineShape::Model::Model ( const Model & m )

inlinenoexcept

Init from copying itself.

Definition at line 659 of file lineshapemodel.h.

◆ Model() [4/6]

LineShape::Model::Model ( std::vector< SingleSpeciesModel > && assm )

inlineexplicitnoexcept

Init from moving a vector.

Definition at line 662 of file lineshapemodel.h.

◆ Model() [5/6]

LineShape::Model::Model ( Model && m )

inlinenoexcept

Init from moving a itself.

Definition at line 665 of file lineshapemodel.h.

◆ Model() [6/6]

LineShape::Model::Model	(	Numeric	sgam,
		Numeric	nself,
		Numeric	agam,
		Numeric	nair,
		Numeric	psf,
		std::array< Numeric, 12 >	aer_interp = `{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}`
	)

noexcept

Standard HITRAN init.

Parameters

[in]	sgam	Self pressure broadening coefficient
[in]	nself	Self pressure broadening exponent
[in]	agam	Air pressure broadening coefficient
[in]	nair	Air pressure broadening exponent
[in]	psf	All pressure shifting coefficient
[in]	interp	The interpolation variable for AER type line mixing

Definition at line 1079 of file lineshapemodel.cc.

Member Function Documentation

◆ begin() [1/2]

auto LineShape::Model::begin ( )

inline

Definition at line 732 of file lineshapemodel.h.

References mdata.

◆ begin() [2/2]

auto LineShape::Model::begin ( ) const

inline

Definition at line 735 of file lineshapemodel.h.

References mdata.

◆ cbegin()

auto LineShape::Model::cbegin ( ) const

inline

Definition at line 738 of file lineshapemodel.h.

References mdata.

◆ cend()

auto LineShape::Model::cend ( ) const

inline

Definition at line 739 of file lineshapemodel.h.

References mdata.

◆ D0()

Numeric LineShape::Model::D0	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

◆ D2()

Numeric LineShape::Model::D2	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

◆ Data() [1/2]

const std::vector< SingleSpeciesModel > & LineShape::Model::Data ( ) const

inlinenoexcept

The line shape model data.

Definition at line 742 of file lineshapemodel.h.

References mdata.

Referenced by LineShape::hitran_model(), LineShape::lblrtm_model(), LineShape::ModelMetaDataArray(), LineShape::ModelShape2MetaData(), Absorption::ReadFromArtscat5Stream(), Absorption::SingleLine::SetLineMixing2AER(), LineShape::LegacyLineMixingData::vector2modellm(), and LineShape::LegacyPressureBroadeningData::vector2modelpb().

◆ Data() [2/2]

std::vector< SingleSpeciesModel > & LineShape::Model::Data ( )

inlinenoexcept

The line shape model data reference.

Definition at line 745 of file lineshapemodel.h.

References mdata.

◆ dD0dT()

Numeric LineShape::Model::dD0dT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ dD2dT()

Numeric LineShape::Model::dD2dT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ dDVdT()

Numeric LineShape::Model::dDVdT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ dETAdT()

Numeric LineShape::Model::dETAdT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ dFVCdT()

Numeric LineShape::Model::dFVCdT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ dG0dT()

Numeric LineShape::Model::dG0dT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ dG2dT()

Numeric LineShape::Model::dG2dT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ dGdT()

Numeric LineShape::Model::dGdT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ DV()

Numeric LineShape::Model::DV	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

◆ dYdT()

Numeric LineShape::Model::dYdT	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

◆ end() [1/2]

auto LineShape::Model::end ( )

inline

Definition at line 733 of file lineshapemodel.h.

References mdata.

◆ end() [2/2]

auto LineShape::Model::end ( ) const

inline

Definition at line 736 of file lineshapemodel.h.

References mdata.

◆ ETA()

Numeric LineShape::Model::ETA	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

◆ FVC()

Numeric LineShape::Model::FVC	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

◆ G()

Numeric LineShape::Model::G	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

◆ G0()

Numeric LineShape::Model::G0	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

◆ G2()

Numeric LineShape::Model::G2	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

◆ Match()

std::pair< bool, bool > LineShape::Model::Match ( const Model & other ) const

noexcept

Definition at line 1199 of file lineshapemodel.cc.

◆ nelem()

Index LineShape::Model::nelem ( ) const

inlinenoexcept

Number of species in Model.

Definition at line 697 of file lineshapemodel.h.

References mdata.

◆ OK()

bool LineShape::Model::OK	(	Type	type,
		bool	self,
		bool	bath,
		const std::size_t	nspecies
	)		const

noexcept

The Model is good to use.

Returns: true/false

Definition at line 1173 of file lineshapemodel.cc.

◆ operator=() [1/2]

Model & LineShape::Model::operator= ( const Model & m )

default

Copy and equals.

◆ operator=() [2/2]

Model & LineShape::Model::operator= ( Model && m )

default

Move and equals.

◆ operator[]() [1/2]

SingleSpeciesModel & LineShape::Model::operator[] ( Index i )

inline

Get a SingleSpeciesModel.

Parameters

[in] i Position in mdata

Returns: reference to SingleSpeciesModel

Definition at line 723 of file lineshapemodel.h.

References mdata.

◆ operator[]() [2/2]

const SingleSpeciesModel & LineShape::Model::operator[] ( Index i ) const

inline

Get a SingleSpeciesModel.

Parameters

[in] i Position in mdata

Returns: reference to SingleSpeciesModel

Definition at line 730 of file lineshapemodel.h.

References mdata.

◆ read()

bifstream & LineShape::Model::read ( bifstream & bif )

Binary read for Model.

Definition at line 1213 of file lineshapemodel.cc.

References mdata.

Referenced by Absorption::SingleLine::read().

◆ Remove() [1/2]

void LineShape::Model::Remove	(	Index	i,
		ArrayOfSpecies &	specs
	)

Definition at line 1186 of file lineshapemodel.cc.

References mdata.

◆ Remove() [2/2]

void LineShape::Model::Remove	(	Index	i,
		ArrayOfSpeciesTag &	specs
	)

Remove species and data at position.

Uses standard algorithm "erase" to remove, see it for behavior when an error occurs

Parameters

[in] i Index of position to remove

Definition at line 1181 of file lineshapemodel.cc.

References mdata.

Referenced by LineShape::from_artscat4().

◆ reserve()

void LineShape::Model::reserve ( Index n )

inline

Reserve function for Model.

Just reserves, does nothing with the new data

Parameters

[in] n New reserves of mspecies and mdata

Definition at line 716 of file lineshapemodel.h.

References mdata.

◆ resize()

void LineShape::Model::resize ( Index n )

inline

Resize function for Model.

Just resizes, does nothing with the new data

Parameters

[in] n New size of mspecies and mdata

Definition at line 708 of file lineshapemodel.h.

References mdata.

◆ SetLineMixingModel()

void LineShape::Model::SetLineMixingModel ( SingleSpeciesModel x )

Sets the same line mixing model to all species.

Looks at x and sets it Y, G and DV values to all the Y, G, and DV values in this

If LM_AER is used, Interp data is written over as well otherwise it remains untouched

Parameters

[in] x Model containing new line mixing data

Definition at line 1191 of file lineshapemodel.cc.

References mdata.

Referenced by Absorption::ReadFromArtscat5Stream(), and Absorption::SingleLine::SetLineMixing2SecondOrderData().

◆ size()

Index LineShape::Model::size ( ) const

inline

Number of species in Model.

Definition at line 700 of file lineshapemodel.h.

References mdata.

◆ write()

bofstream & LineShape::Model::write ( bofstream & bof ) const

Binary write for Model.

Definition at line 1219 of file lineshapemodel.cc.

References mdata.

Referenced by Absorption::SingleLine::write().

◆ Y()

Numeric LineShape::Model::Y	(	Numeric	T,
		Numeric	T0,
		Numeric	P,
		const Vector &	vmrs
	)		const

Referenced by ENUMCLASS().

Friends And Related Function Documentation

◆ from_artscat4

std::istream & from_artscat4	(	std::istream &	is,
		Type &	type,
		bool &	self,
		bool &	bath,
		Model &	m,
		ArrayOfSpecies &	species,
		const QuantumIdentifier &	qid
	)

friend

◆ from_linefunctiondata

std::istream & from_linefunctiondata	(	std::istream &	data,
		Type &	type,
		bool &	self,
		bool &	bath,
		Model &	m,
		ArrayOfSpecies &	species
	)

friend

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Model &	m
	)

friend

Definition at line 546 of file lineshapemodel.cc.

◆ operator>>

std::istream & operator>>	(	std::istream &	is,
		Model &	m
	)

friend

Definition at line 551 of file lineshapemodel.cc.

Member Data Documentation

◆ mdata

std::vector<SingleSpeciesModel> LineShape::Model::mdata

private

Definition at line 649 of file lineshapemodel.h.

Referenced by begin(), cbegin(), cend(), Data(), end(), LineShape::from_artscat4(), LineShape::from_linefunctiondata(), nelem(), operator[](), read(), Remove(), reserve(), resize(), SetLineMixingModel(), size(), and write().

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Model() [1/6]

◆ Model() [2/6]

◆ Model() [3/6]

◆ Model() [4/6]

◆ Model() [5/6]

◆ Model() [6/6]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ D0()

◆ D2()

◆ Data() [1/2]

◆ Data() [2/2]

◆ dD0dT()

◆ dD2dT()

◆ dDVdT()

◆ dETAdT()

◆ dFVCdT()

◆ dG0dT()

◆ dG2dT()

◆ dGdT()

◆ DV()

◆ dYdT()

◆ end() [1/2]

◆ end() [2/2]

◆ ETA()

◆ FVC()

◆ G()

◆ G0()

◆ G2()

◆ Match()

◆ nelem()

◆ OK()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ read()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ reserve()

◆ resize()

◆ SetLineMixingModel()

◆ size()

◆ write()

◆ Y()

Friends And Related Function Documentation

◆ from_artscat4

◆ from_linefunctiondata

◆ operator<<

◆ operator>>

Member Data Documentation

◆ mdata