#include <absorptionlines.h>

Public Member Functions
	Lines (bool selfbroadening_=false, bool bathbroadening_=false, CutoffType cutoff_=CutoffType::None, MirroringType mirroring_=MirroringType::None, PopulationType population_=PopulationType::LTE, NormalizationType normalization_=NormalizationType::None, LineShape::Type lineshapetype_=LineShape::Type::DP, Numeric T0_=296, Numeric cutofffreq_=-1, Numeric linemixinglimit_=-1, QuantumIdentifier quantumidentity_=QuantumIdentifier(), ArrayOfSpecies broadeningspecies_={}, Array< SingleLine > lines_={})
	Default initialization.

	Lines (bool selfbroadening_, bool bathbroadening_, size_t nlines, CutoffType cutoff_, MirroringType mirroring_, PopulationType population_, NormalizationType normalization_, LineShape::Type lineshapetype_, Numeric T0_, Numeric cutofffreq_, Numeric linemixinglimit_, QuantumIdentifier quantumidentity_, ArrayOfSpecies broadeningspecies_, const Quantum::Number::LocalState &metalocalquanta, const LineShape::Model &metamodel)
	XML-tag initialization.

void	AppendSingleLine (SingleLine &&sl)
	Appends a single line to the absorption lines.

void	AppendSingleLine (const SingleLine &sl)
	Appends a single line to the absorption lines.

bool	MatchWithExternal (const SingleLineExternal &sle, const QuantumIdentifier &quantumidentity) const ARTS_NOEXCEPT
	Checks if an external line matches this structure.

std::pair< bool, bool >	Match (const Lines &l) const noexcept
	Checks if another line list matches this structure.

void	sort_by_frequency ()
	Sort inner line list by frequency.

void	sort_by_einstein ()
	Sort inner line list by Einstein coefficient.

String	SpeciesName () const noexcept
	Species Name.

String	LineShapeMetaData () const noexcept
	Meta data for the line shape if it exists.

Species::Species	Species () const noexcept
	Species Enum.

Species::IsotopeRecord	Isotopologue () const noexcept
	Isotopologue Index.

Index	NumLines () const noexcept
	Number of lines.

void	MakeLineShapeModelCommon ()
	Make a common line shape if possible.

Index	NumBroadeners () const ARTS_NOEXCEPT
	Number of broadening species.

Index	NumLocalQuanta () const noexcept
	Number of broadening species.

Index	ZeemanCount (size_t k, Zeeman::Polarization type) const ARTS_NOEXCEPT
	Returns the number of Zeeman split lines.

Numeric	ZeemanStrength (size_t k, Zeeman::Polarization type, Index i) const ARTS_NOEXCEPT
	Returns the strength of a Zeeman split line.

Numeric	ZeemanSplitting (size_t k, Zeeman::Polarization type, Index i) const ARTS_NOEXCEPT
	Returns the splitting of a Zeeman split line.

void	SetAutomaticZeeman () noexcept
	Set Zeeman effect for all lines that have the correct quantum numbers.

Numeric	F_mean (Numeric T=0) const noexcept
	Mean frequency by weight of line strength.

Numeric	F_mean (const ConstVectorView &wgts) const noexcept
	Mean frequency by weight of line strengt.

bool	OnTheFlyLineMixing () const noexcept
	On-the-fly line mixing.

bool	DoLineMixing (Numeric P) const noexcept
	Returns if the pressure should do line mixing.

bool	DoVmrDerivative (const QuantumIdentifier &qid) const noexcept

bool	AnyLinemixing () const noexcept

LineShape::Output	ShapeParameters (size_t k, Numeric T, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT
	Line shape parameters.

LineShape::Output	ShapeParameters (size_t k, Numeric T, Numeric P, size_t pos) const ARTS_NOEXCEPT
	Line shape parameters.

LineShape::Output	ShapeParameters_dT (size_t k, Numeric T, Numeric P, const Vector &vmrs) const ARTS_NOEXCEPT
	Line shape parameters temperature derivatives.

LineShape::Output	ShapeParameters_dT (size_t k, Numeric T, Numeric P, size_t pos) const ARTS_NOEXCEPT
	Line shape parameters temperature derivatives.

Index	LineShapePos (const Species::Species spec) const ARTS_NOEXCEPT
	Position among broadening species or -1.

LineShape::Output	ShapeParameters_dVMR (size_t k, Numeric T, Numeric P, const QuantumIdentifier &vmr_qid) const ARTS_NOEXCEPT
	Line shape parameters vmr derivative.

Numeric	CutoffFreq (size_t k, Numeric shift=0) const noexcept
	Returns cutoff frequency or maximum value.

Numeric	CutoffFreqMinus (size_t k, Numeric shift=0) const noexcept
	Returns negative cutoff frequency or lowest value.

Index	BroadeningSpeciesPosition (Species::Species spec) const noexcept
	Position of species if available or -1 else.

String	MetaData () const
	Returns a printable statement about the lines.

void	RemoveLine (Index) noexcept
	Removes a single line.

SingleLine	PopLine (Index) noexcept
	Pops a single line.

void	ReverseLines () noexcept
	Reverses the order of the internal lines.

Numeric	SpeciesMass () const noexcept
	Mass of the molecule.

Vector	BroadeningSpeciesVMR (const ConstVectorView &, const ArrayOfArrayOfSpeciesTag &) const
	Returns the VMRs of the broadening species.

Vector	BroadeningSpeciesMass (const ConstVectorView &, const ArrayOfArrayOfSpeciesTag &, const SpeciesIsotopologueRatios &, const Numeric &bath_mass=0) const
	Returns the mass of the broadening species.

Numeric	SelfVMR (const ConstVectorView &, const ArrayOfArrayOfSpeciesTag &) const
	Returns the VMR of the species.

bifstream &	read (bifstream &is)
	Binary read for Lines.

bofstream &	write (bofstream &os) const
	Binary write for Lines.

bool	OK () const ARTS_NOEXCEPT

Numeric	DopplerConstant (Numeric T) const noexcept

QuantumIdentifier	QuantumIdentityOfLine (Index k) const noexcept

Rational	max (QuantumNumberType) const

Public Attributes
bool	selfbroadening
	Does the line broadening have self broadening.

bool	bathbroadening
	Does the line broadening have bath broadening.

CutoffType	cutoff
	cutoff type, by band or by line

MirroringType	mirroring
	Mirroring type.

PopulationType	population
	Line population distribution.

NormalizationType	normalization
	Line normalization type.

LineShape::Type	lineshapetype
	Type of line shape.

Numeric	T0
	Reference temperature for all parameters of the lines.

Numeric	cutofffreq
	cutoff frequency

Numeric	linemixinglimit
	linemixing limit

QuantumIdentifier	quantumidentity
	Catalog ID.

ArrayOfSpecies	broadeningspecies
	A list of broadening species.

Array< SingleLine >	lines
	A list of individual lines.

Static Public Attributes
static constexpr Index	version = 2

Friends
std::ostream &	operator<< (std::ostream &, const Lines &)

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

Detailed Description

Definition at line 291 of file absorptionlines.h.

Constructor & Destructor Documentation

◆ Lines() [1/2]

Absorption::Lines::Lines	(	bool	selfbroadening_ = `false`,
		bool	bathbroadening_ = `false`,
		CutoffType	cutoff_ = `CutoffType::None`,
		MirroringType	mirroring_ = `MirroringType::None`,
		PopulationType	population_ = `PopulationType::LTE`,
		NormalizationType	normalization_ = `NormalizationType::None`,
		LineShape::Type	lineshapetype_ = `LineShape::Type::DP`,
		Numeric	T0_ = `296`,
		Numeric	cutofffreq_ = `-1`,
		Numeric	linemixinglimit_ = `-1`,
		QuantumIdentifier	quantumidentity_ = `QuantumIdentifier()`,
		ArrayOfSpecies	broadeningspecies_ = `{}`,
		Array< SingleLine >	lines_ = `{}`
	)

inline

Default initialization.

Parameters

[in]	selfbroadening_	Do self broadening
[in]	bathbroadening_	Do bath broadening
[in]	cutoff_	Type of cutoff frequency
[in]	mirroring_	Type of mirroring
[in]	population_	Type of line strengths distributions
[in]	normalization_	Type of normalization
[in]	lineshapetype_	Type of line shape
[in]	T0_	Reference temperature
[in]	cutofffreq_	Cutoff frequency
[in]	linemixinglimit_	Line mixing limit
[in]	quantumidentity_	Identity of global lines
[in]	broadeningspecies_	List of broadening species
[in]	lines_	List of SingleLine(s)

Definition at line 349 of file absorptionlines.h.

◆ Lines() [2/2]

Absorption::Lines::Lines	(	bool	selfbroadening_,
		bool	bathbroadening_,
		size_t	nlines,
		CutoffType	cutoff_,
		MirroringType	mirroring_,
		PopulationType	population_,
		NormalizationType	normalization_,
		LineShape::Type	lineshapetype_,
		Numeric	T0_,
		Numeric	cutofffreq_,
		Numeric	linemixinglimit_,
		QuantumIdentifier	quantumidentity_,
		ArrayOfSpecies	broadeningspecies_,
		const Quantum::Number::LocalState &	metalocalquanta,
		const LineShape::Model &	metamodel
	)

inline

XML-tag initialization.

Parameters

[in]	selfbroadening_	Do self broadening
[in]	bathbroadening_	Do bath broadening
[in]	nlines	Number of SingleLine(s) to initiate as empty
[in]	cutoff_	Type of cutoff frequency
[in]	mirroring_	Type of mirroring
[in]	population_	Type of line strengths distributions
[in]	normalization_	Type of normalization
[in]	lineshapetype_	Type of line shape
[in]	T0_	Reference temperature
[in]	cutofffreq_	Cutoff frequency
[in]	linemixinglimit_	Line mixing limit
[in]	quantumidentity_	Identity of global lines
[in]	broadeningspecies_	List of broadening species
[in]	metalocalquanta	A local state with defined quantum numbers
[in]	metamodel	A line shape model with defined shapes

Definition at line 397 of file absorptionlines.h.

References bathbroadening, broadeningspecies, quantumidentity, selfbroadening, and Quantum::Number::GlobalState::Species().

Member Function Documentation

◆ AnyLinemixing()

bool Absorption::Lines::AnyLinemixing ( ) const

noexcept

Returns: Whether the band may require linemixing

Definition at line 2339 of file absorptionlines.cc.

References lines.

◆ AppendSingleLine() [1/2]

void Absorption::Lines::AppendSingleLine ( const SingleLine & sl )

Appends a single line to the absorption lines.

Useful for reading undefined number of lines and setting their structures

Warning: caller must guarantee that the broadening species and the quantum numbers of both levels have the correct order and the correct size. Only the sizes can be and are tested.

Parameters

[in] sl A single line

Definition at line 2229 of file absorptionlines.cc.

References AppendSingleLine().

◆ AppendSingleLine() [2/2]

void Absorption::Lines::AppendSingleLine ( SingleLine && sl )

Appends a single line to the absorption lines.

Useful for reading undefined number of lines and setting their structures

Warning: caller must guarantee that the broadening species and the quantum numbers of both levels have the correct order and the correct size. Only the sizes can be and are tested.

Parameters

[in] sl A single line

Definition at line 2212 of file absorptionlines.cc.

References ARTS_USER_ERROR_IF, lines, NumLines(), and NumLocalQuanta().

Referenced by abs_lines_per_speciesCreateFromLines(), abs_linesFlatten(), and AppendSingleLine().

◆ BroadeningSpeciesMass()

Vector Absorption::Lines::BroadeningSpeciesMass	(	const ConstVectorView &	atm_vmrs,
		const ArrayOfArrayOfSpeciesTag &	atm_spec,
		const SpeciesIsotopologueRatios &	ir,
		const Numeric &	bath_mass = `0`
	)		const

Returns the mass of the broadening species.

Parameters

[in]	atm_vmrs	Atmospheric VMRs
[in]	atm_spec	Atmospheric Species
[in]	bath_mass	Mass of Bath/Air (optional, will compute it if <=0)

Returns: Mass list of the species

Definition at line 1900 of file absorptionlines.cc.

References LineShape::mass(), and ConstVectorView::nelem().

◆ BroadeningSpeciesPosition()

Index Absorption::Lines::BroadeningSpeciesPosition ( Species::Species spec ) const

noexcept

Position of species if available or -1 else.

Definition at line 2352 of file absorptionlines.cc.

Referenced by Absorption::LineMixing::ecs_absorption().

◆ BroadeningSpeciesVMR()

Vector Absorption::Lines::BroadeningSpeciesVMR	(	const ConstVectorView &	atm_vmrs,
		const ArrayOfArrayOfSpeciesTag &	atm_spec
	)		const

Returns the VMRs of the broadening species.

Parameters

[in]	atm_vmrs	Atmospheric VMRs
[in]	atm_spec	Atmospheric Species

Returns: VMR list of the species

Definition at line 1894 of file absorptionlines.cc.

References LineShape::vmrs().

◆ CutoffFreq()

Numeric Absorption::Lines::CutoffFreq	(	size_t	k,
		Numeric	shift = `0`
	)		const

noexcept

Returns cutoff frequency or maximum value.

Parameters

[in] k Line number (less than NumLines())

Returns: Cutoff frequency or 0

Definition at line 2435 of file absorptionlines.cc.

References Absorption::cutoff.

◆ CutoffFreqMinus()

Numeric Absorption::Lines::CutoffFreqMinus	(	size_t	k,
		Numeric	shift = `0`
	)		const

noexcept

Returns negative cutoff frequency or lowest value.

Parameters

[in] k Line number (less than NumLines())

Returns: Negative cutoff frequency or the lowest value

Definition at line 2448 of file absorptionlines.cc.

References Absorption::cutoff.

◆ DoLineMixing()

bool Absorption::Lines::DoLineMixing ( Numeric P ) const

noexcept

Returns if the pressure should do line mixing.

Parameters

[in] P Atmospheric pressure

Returns: true if no limit or P less than limit

Definition at line 2327 of file absorptionlines.cc.

◆ DopplerConstant()

Numeric Absorption::Lines::DopplerConstant ( Numeric T ) const

noexcept

Definition at line 2140 of file absorptionlines.cc.

References Constant::doppler_broadening_const_squared.

Referenced by Absorption::LineMixing::ecs_absorption_impl().

◆ DoVmrDerivative()

bool Absorption::Lines::DoVmrDerivative ( const QuantumIdentifier & qid ) const

noexcept

Definition at line 2331 of file absorptionlines.cc.

References a.

Referenced by Absorption::LineMixing::ecs_absorption().

◆ F_mean() [1/2]

Numeric Absorption::Lines::F_mean ( const ConstVectorView & wgts ) const

noexcept

Mean frequency by weight of line strengt.

Parameters

[in] wgts Weight of averaging

Returns: Mean frequency

Definition at line 2400 of file absorptionlines.cc.

References a, and b.

◆ F_mean() [2/2]

Numeric Absorption::Lines::F_mean ( Numeric T = 0 ) const

noexcept

Mean frequency by weight of line strength.

Parameters

[in] T Temperature at which to compute the line strength (T <= 0 means at T0 is used)

Returns: Mean frequency

Definition at line 2412 of file absorptionlines.cc.

References boltzman_factor(), boltzman_ratio(), Constant::h, Constant::k, and single_partition_function().

Referenced by lm_hitran_2017::convtp(), Absorption::LineMixing::ecs_absorption_impl(), Absorption::LineMixing::ecs_eigenvalue_approximation(), lm_hitran_2017::hitran_lm_eigenvalue_approximation(), and Absorption::LineMixing::rosenkranz_approximation().

◆ Isotopologue()

Species::IsotopeRecord Absorption::Lines::Isotopologue ( ) const

noexcept

Isotopologue Index.

Definition at line 2312 of file absorptionlines.cc.

References Quantum::Number::GlobalState::Isotopologue(), and quantumidentity.

Referenced by abs_lines_per_speciesCreateFromLines(), lm_hitran_2017::calcw(), lm_hitran_2017::convtp(), Absorption::LineMixing::ecs_absorption(), Absorption::LineMixing::ecs_eigenvalue_approximation(), lm_hitran_2017::hitran_lm_eigenvalue_approximation(), Absorption::LineMixing::PopulationAndDipole::PopulationAndDipole(), and Absorption::LineMixing::LinearRovibErrorCorrectedSudden::relaxation_matrix_offdiagonal().

◆ LineShapeMetaData()

String Absorption::Lines::LineShapeMetaData ( ) const

noexcept

Meta data for the line shape if it exists.

Definition at line 2306 of file absorptionlines.cc.

References lines, LineShape::ModelShape2MetaData(), and NumLines().

Referenced by xml_write_to_stream().

◆ LineShapePos()

Index Absorption::Lines::LineShapePos ( const Species::Species spec ) const

Position among broadening species or -1.

Parameters

[in] A species index that might be among the broadener species

Returns: Position among broadening species or -1

Definition at line 96 of file absorptionlines.cc.

◆ MakeLineShapeModelCommon()

void Absorption::Lines::MakeLineShapeModelCommon ( )

Make a common line shape if possible.

Definition at line 2478 of file absorptionlines.cc.

References ARTS_USER_ERROR_IF, lines, LineShape::modelparameterEmpty(), LineShape::modelparameterGetEmpty(), NumBroadeners(), NumLines(), and LineShape::nVars.

◆ Match()

std::pair< bool, bool > Absorption::Lines::Match ( const Lines & l ) const

noexcept

Checks if another line list matches this structure.

Parameters

[in]	sle	Full external lines
[in]	quantumidentity	Expected global quantum id of the line

Returns: first: match; second: nullable line shape

Definition at line 2262 of file absorptionlines.cc.

References Absorption::cutoff.

Referenced by abs_linesFlatten().

◆ MatchWithExternal()

bool Absorption::Lines::MatchWithExternal	(	const SingleLineExternal &	sle,
		const QuantumIdentifier &	quantumidentity
	)		const

Checks if an external line matches this structure.

Parameters

[in]	sle	Full external lines
[in]	quantumidentity	Expected global quantum id of the line

Definition at line 2233 of file absorptionlines.cc.

References Absorption::cutoff.

◆ max()

Rational Absorption::Lines::max ( QuantumNumberType x ) const

Definition at line 2885 of file absorptionlines.cc.

References ARTS_USER_ERROR_IF, and Quantum::Number::common_value_type().

Referenced by Absorption::LineMixing::Makarov2020etal::relaxation_matrix_offdiagonal().

◆ MetaData()

String Absorption::Lines::MetaData ( ) const

Returns a printable statement about the lines.

Definition at line 1820 of file absorptionlines.cc.

References Absorption::cutoff, Absorption::cutofftype2metadatastring(), and LineShape::ModelMetaDataArray().

Referenced by xml_read_from_stream(), and xml_write_to_stream().

◆ NumBroadeners()

Index Absorption::Lines::NumBroadeners ( ) const

Number of broadening species.

Definition at line 2316 of file absorptionlines.cc.

References broadeningspecies, and Array< base >::nelem().

Referenced by Absorption::LineMixing::band_eigenvalue_adaptation(), Absorption::LineMixing::ecs_eigenvalue_adaptation_test(), Absorption::LineMixing::ecs_eigenvalue_approximation(), lm_hitran_2017::hitran_lm_eigenvalue_adaptation_test(), lm_hitran_2017::hitran_lm_eigenvalue_approximation(), MakeLineShapeModelCommon(), and Absorption::LineMixing::rosenkranz_approximation().

◆ NumLines()

Index Absorption::Lines::NumLines ( ) const

noexcept

Number of lines.

Definition at line 2314 of file absorptionlines.cc.

References lines.

◆ NumLocalQuanta()

Index Absorption::Lines::NumLocalQuanta ( ) const

noexcept

Number of broadening species.

Definition at line 2318 of file absorptionlines.cc.

References lines.

Referenced by AppendSingleLine().

◆ OK()

bool Absorption::Lines::OK ( ) const

Definition at line 2112 of file absorptionlines.cc.

◆ OnTheFlyLineMixing()

bool Absorption::Lines::OnTheFlyLineMixing ( ) const

noexcept

On-the-fly line mixing.

Definition at line 2322 of file absorptionlines.cc.

References population.

◆ PopLine()

Absorption::SingleLine Absorption::Lines::PopLine ( Index i )

noexcept

Pops a single line.

Definition at line 1880 of file absorptionlines.cc.

Referenced by abs_lines_per_speciesCreateFromLines().

◆ QuantumIdentityOfLine()

QuantumIdentifier Absorption::Lines::QuantumIdentityOfLine ( Index k ) const

noexcept

Definition at line 2472 of file absorptionlines.cc.

References a, Quantum::Number::ValueList::set(), and Quantum::Number::GlobalState::val.

◆ read()

bifstream & Absorption::Lines::read ( bifstream & is )

Binary read for Lines.

Definition at line 2462 of file absorptionlines.cc.

References lines.

Referenced by xml_read_from_stream().

◆ RemoveLine()

void Absorption::Lines::RemoveLine ( Index i )

noexcept

Removes a single line.

Definition at line 1876 of file absorptionlines.cc.

◆ ReverseLines()

void Absorption::Lines::ReverseLines ( )

noexcept

Reverses the order of the internal lines.

Definition at line 1886 of file absorptionlines.cc.

Referenced by abs_lines_per_speciesCreateFromLines().

◆ SelfVMR()

Numeric Absorption::Lines::SelfVMR	(	const ConstVectorView &	atm_vmrs,
		const ArrayOfArrayOfSpeciesTag &	atm_spec
	)		const

Returns the VMR of the species.

Parameters

[in]	atm_vmrs	Atmospheric VMRs
[in]	atm_spec	Atmospheric Species

Returns: VMR of the species

Definition at line 1910 of file absorptionlines.cc.

References ARTS_USER_ERROR_IF, Array< base >::nelem(), ConstVectorView::nelem(), and Absorption::nelem().

◆ SetAutomaticZeeman()

void Absorption::Lines::SetAutomaticZeeman ( )

noexcept

Set Zeeman effect for all lines that have the correct quantum numbers.

Definition at line 2396 of file absorptionlines.cc.

References lines, and quantumidentity.

◆ ShapeParameters() [1/2]

LineShape::Output Absorption::Lines::ShapeParameters	(	size_t	k,
		Numeric	T,
		Numeric	P,
		const Vector &	vmrs
	)		const

Line shape parameters.

Parameters

[in]	k	Line number (less than NumLines())
[in]	T	Atmospheric temperature
[in]	P	Atmospheric pressure
[in]	vmrs	Line broadener species's volume mixing ratio

Returns: Line shape parameters

Definition at line 54 of file absorptionlines.cc.

References LineShape::Output::G0.

Referenced by Absorption::LineMixing::single_species_ecs_relaxation_matrix().

◆ ShapeParameters() [2/2]

LineShape::Output Absorption::Lines::ShapeParameters	(	size_t	k,
		Numeric	T,
		Numeric	P,
		size_t	pos
	)		const

Line shape parameters.

Parameters

[in]	k	Line number (less than NumLines())
[in]	T	Atmospheric temperature
[in]	P	Atmospheric pressure
[in]	pos	Line broadening species position

Returns: Line shape parameters

Definition at line 67 of file absorptionlines.cc.

◆ ShapeParameters_dT() [1/2]

LineShape::Output Absorption::Lines::ShapeParameters_dT	(	size_t	k,
		Numeric	T,
		Numeric	P,
		const Vector &	vmrs
	)		const

Line shape parameters temperature derivatives.

Parameters

[in]	k	Line number (less than NumLines())
[in]	T	Atmospheric temperature
[in]	P	Atmospheric pressure
[in]	vmrs	Line broadener's volume mixing ratio

Returns: Line shape parameters temperature derivatives

Definition at line 76 of file absorptionlines.cc.

References LineShape::Output::no_linemixing().

◆ ShapeParameters_dT() [2/2]

LineShape::Output Absorption::Lines::ShapeParameters_dT	(	size_t	k,
		Numeric	T,
		Numeric	P,
		size_t	pos
	)		const

Line shape parameters temperature derivatives.

Parameters

[in]	k	Line number (less than NumLines())
[in]	T	Atmospheric temperature
[in]	P	Atmospheric pressure
[in]	pos	Line broadening species position

Returns: Line shape parameters temperature derivatives

Definition at line 89 of file absorptionlines.cc.

◆ ShapeParameters_dVMR()

LineShape::Output Absorption::Lines::ShapeParameters_dVMR	(	size_t	k,
		Numeric	T,
		Numeric	P,
		const QuantumIdentifier &	vmr_qid
	)		const

Line shape parameters vmr derivative.

Parameters

[in]	k	Line number (less than NumLines())
[in]	T	Atmospheric temperature
[in]	P	Atmospheric pressure
[in]	vmr_qid	Identity of species whose VMR derivative is requested

Returns: Line shape parameters vmr derivative

Definition at line 117 of file absorptionlines.cc.

◆ sort_by_einstein()

void Absorption::Lines::sort_by_einstein ( )

Sort inner line list by Einstein coefficient.

Definition at line 2300 of file absorptionlines.cc.

References a, b, and lines.

◆ sort_by_frequency()

void Absorption::Lines::sort_by_frequency ( )

Sort inner line list by frequency.

Definition at line 2293 of file absorptionlines.cc.

References a, b, and lines.

◆ Species()

Species::Species Absorption::Lines::Species ( ) const

noexcept

Species Enum.

Definition at line 2310 of file absorptionlines.cc.

References quantumidentity, and Quantum::Number::GlobalState::Species().

◆ SpeciesMass()

Numeric Absorption::Lines::SpeciesMass ( ) const

noexcept

Mass of the molecule.

Definition at line 1890 of file absorptionlines.cc.

Referenced by Absorption::LineMixing::Makarov2020etal::relaxation_matrix_offdiagonal(), and Absorption::LineMixing::LinearRovibErrorCorrectedSudden::relaxation_matrix_offdiagonal().

◆ SpeciesName()

String Absorption::Lines::SpeciesName ( ) const

noexcept

Species Name.

Definition at line 1816 of file absorptionlines.cc.

References Species::IsotopeRecord::FullName(), Quantum::Number::GlobalState::Isotopologue(), and quantumidentity.

◆ write()

bofstream & Absorption::Lines::write ( bofstream & os ) const

Binary write for Lines.

Definition at line 2467 of file absorptionlines.cc.

References lines.

Referenced by xml_write_to_stream().

◆ ZeemanCount()

Index Absorption::Lines::ZeemanCount	(	size_t	k,
		Zeeman::Polarization	type
	)		const

Returns the number of Zeeman split lines.

Parameters

[in]	k	Line number (less than NumLines())
[in]	type	Type of Zeeman polarization

Definition at line 2368 of file absorptionlines.cc.

References Absorption::get(), Zeeman::nelem(), and Zeeman::None.

Referenced by Absorption::LineMixing::ecs_absorption_impl().

◆ ZeemanSplitting()

Numeric Absorption::Lines::ZeemanSplitting	(	size_t	k,
		Zeeman::Polarization	type,
		Index	i
	)		const

Returns the splitting of a Zeeman split line.

Parameters

[in]	k	Line number (less than NumLines())
[in]	type	Type of Zeeman polarization
[in]	i	Zeeman line count

Definition at line 2386 of file absorptionlines.cc.

References Absorption::get(), and Zeeman::None.

Referenced by Absorption::LineMixing::ecs_absorption_impl().

◆ ZeemanStrength()

Numeric Absorption::Lines::ZeemanStrength	(	size_t	k,
		Zeeman::Polarization	type,
		Index	i
	)		const

Returns the strength of a Zeeman split line.

Parameters

[in]	k	Line number (less than NumLines())
[in]	type	Type of Zeeman polarization
[in]	i	Zeeman line count

Definition at line 2376 of file absorptionlines.cc.

References Absorption::get(), and Zeeman::None.

Referenced by Absorption::LineMixing::ecs_absorption_impl().

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Lines &	lines
	)

friend

Definition at line 1791 of file absorptionlines.cc.

◆ operator>>

std::istream & operator>>	(	std::istream &	is,
		Lines &	lines
	)

friend

Definition at line 1796 of file absorptionlines.cc.

Member Data Documentation

◆ bathbroadening

bool Absorption::Lines::bathbroadening

Does the line broadening have bath broadening.

Definition at line 298 of file absorptionlines.h.

Referenced by Absorption::LineMixing::ecs_absorption(), Lines(), and xml_write_to_stream().

◆ broadeningspecies

ArrayOfSpecies Absorption::Lines::broadeningspecies

A list of broadening species.

Definition at line 328 of file absorptionlines.h.

Referenced by Absorption::LineMixing::ecs_absorption(), Absorption::LineMixing::ecs_eigenvalue_approximation(), Absorption::LineMixing::ecs_relaxation_matrix(), Lines(), NumBroadeners(), Absorption::LineMixing::rosenkranz_approximation(), and xml_write_to_stream().

◆ cutoff

CutoffType Absorption::Lines::cutoff

cutoff type, by band or by line

Definition at line 301 of file absorptionlines.h.

Referenced by xml_write_to_stream().

◆ cutofffreq

Numeric Absorption::Lines::cutofffreq

cutoff frequency

Definition at line 319 of file absorptionlines.h.

Referenced by xml_write_to_stream().

◆ linemixinglimit

Numeric Absorption::Lines::linemixinglimit

linemixing limit

Definition at line 322 of file absorptionlines.h.

Referenced by xml_write_to_stream().

◆ lines

Array<SingleLine> Absorption::Lines::lines

A list of individual lines.

Definition at line 331 of file absorptionlines.h.

◆ lineshapetype

LineShape::Type Absorption::Lines::lineshapetype

Type of line shape.

Definition at line 313 of file absorptionlines.h.

Referenced by Absorption::LineMixing::ecs_absorption_impl(), and xml_write_to_stream().

◆ mirroring

MirroringType Absorption::Lines::mirroring

Mirroring type.

Definition at line 304 of file absorptionlines.h.

Referenced by xml_write_to_stream().

◆ normalization

NormalizationType Absorption::Lines::normalization

Line normalization type.

Definition at line 310 of file absorptionlines.h.

Referenced by Absorption::LineMixing::band_eigenvalue_adaptation(), Absorption::LineMixing::ecs_eigenvalue_adaptation(), and xml_write_to_stream().

◆ population

PopulationType Absorption::Lines::population

Line population distribution.

Definition at line 307 of file absorptionlines.h.

Referenced by Absorption::LineMixing::band_eigenvalue_adaptation(), lm_hitran_2017::convtp(), Absorption::LineMixing::ecs_eigenvalue_adaptation(), lm_hitran_2017::hitran_lm_eigenvalue_approximation(), OnTheFlyLineMixing(), Absorption::LineMixing::PopulationAndDipole::PopulationAndDipole(), Absorption::LineMixing::single_species_ecs_relaxation_matrix(), and xml_write_to_stream().

◆ quantumidentity

QuantumIdentifier Absorption::Lines::quantumidentity

Catalog ID.

Definition at line 325 of file absorptionlines.h.

Referenced by lm_hitran_2017::calcw(), Absorption::LineMixing::ecs_absorption(), Absorption::LineMixing::ecs_eigenvalue_adaptation(), EnergyLevelMap::get_ratio_params(), EnergyLevelMap::get_vibtemp_params(), Isotopologue(), Lines(), Absorption::LineMixing::Makarov2020etal::relaxation_matrix_offdiagonal(), Absorption::LineMixing::LinearRovibErrorCorrectedSudden::relaxation_matrix_offdiagonal(), SetAutomaticZeeman(), lm_hitran_2017::sorter_calcw(), Species(), SpeciesName(), xml_read_from_stream(), and xml_write_to_stream().

◆ selfbroadening

bool Absorption::Lines::selfbroadening

Does the line broadening have self broadening.

Definition at line 295 of file absorptionlines.h.

Referenced by Absorption::LineMixing::ecs_absorption(), Lines(), and xml_write_to_stream().

◆ T0

Numeric Absorption::Lines::T0

Reference temperature for all parameters of the lines.

Definition at line 316 of file absorptionlines.h.

Referenced by lm_hitran_2017::calcw(), lm_hitran_2017::convtp(), Absorption::LineMixing::ecs_eigenvalue_approximation(), Absorption::LineMixing::eigenvalue_adaptation_of_relmat(), lm_hitran_2017::hitran_lm_eigenvalue_approximation(), Absorption::LineMixing::PopulationAndDipole::PopulationAndDipole(), Absorption::LineMixing::Makarov2020etal::relaxation_matrix_offdiagonal(), Absorption::LineMixing::LinearRovibErrorCorrectedSudden::relaxation_matrix_offdiagonal(), Absorption::LineMixing::rosenkranz_approximation(), and xml_write_to_stream().

◆ version

constexpr Index Absorption::Lines::version = 2

staticconstexpr

Definition at line 292 of file absorptionlines.h.

Referenced by xml_read_from_stream(), and xml_write_to_stream().

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

Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Lines() [1/2]

◆ Lines() [2/2]

Member Function Documentation

◆ AnyLinemixing()

◆ AppendSingleLine() [1/2]

◆ AppendSingleLine() [2/2]

◆ BroadeningSpeciesMass()

◆ BroadeningSpeciesPosition()

◆ BroadeningSpeciesVMR()

◆ CutoffFreq()

◆ CutoffFreqMinus()

◆ DoLineMixing()

◆ DopplerConstant()

◆ DoVmrDerivative()

◆ F_mean() [1/2]

◆ F_mean() [2/2]

◆ Isotopologue()

◆ LineShapeMetaData()

◆ LineShapePos()

◆ MakeLineShapeModelCommon()

◆ Match()

◆ MatchWithExternal()

◆ max()

◆ MetaData()

◆ NumBroadeners()

◆ NumLines()

◆ NumLocalQuanta()

◆ OK()

◆ OnTheFlyLineMixing()

◆ PopLine()

◆ QuantumIdentityOfLine()

◆ read()

◆ RemoveLine()

◆ ReverseLines()

◆ SelfVMR()

◆ SetAutomaticZeeman()

◆ ShapeParameters() [1/2]

◆ ShapeParameters() [2/2]

◆ ShapeParameters_dT() [1/2]

◆ ShapeParameters_dT() [2/2]

◆ ShapeParameters_dVMR()

◆ sort_by_einstein()

◆ sort_by_frequency()

◆ Species()

◆ SpeciesMass()

◆ SpeciesName()

◆ write()

◆ ZeemanCount()

◆ ZeemanSplitting()

◆ ZeemanStrength()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ bathbroadening

◆ broadeningspecies

◆ cutoff

◆ cutofffreq

◆ linemixinglimit

◆ lines

◆ lineshapetype

◆ mirroring

◆ normalization

◆ population

◆ quantumidentity

◆ selfbroadening

◆ T0

◆ version