Computations and data for a single absorption line. More...

#include <absorptionlines.h>

Public Member Functions
	SingleLine (Numeric F0_=0, Numeric I0_=0, Numeric E0_=0, Numeric glow_=0, Numeric gupp_=0, Numeric A_=0, Zeeman::Model zeeman_=Zeeman::Model(), LineShape::Model lineshape_=LineShape::Model(), Quantum::Number::LocalState localquanta_={})
	Default initialization.

	SingleLine (Quantum::Number::LocalState metaquanta, LineShape::Model metamodel)
	Initialization for constant sizes.

Index	LineShapeElems () const noexcept
	Number of lineshape elements.

Index	LocalQuantumElems () const ARTS_NOEXCEPT
	Number of lower quantum numbers.

void	SetAutomaticZeeman (QuantumIdentifier qid)
	Set Zeeman effect by automatic detection.

void	SetLineMixing2SecondOrderData (const Vector &d)
	Set the line mixing model to 2nd order.

void	SetLineMixing2AER (const Vector &d)
	Set the line mixing model to AER kind.

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

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

Public Attributes
Numeric	F0 {}
	Central frequency.

Numeric	I0 {}
	Reference intensity.

Numeric	E0 {}
	Lower state energy level.

Numeric	glow {}
	Lower level statistical weight.

Numeric	gupp {}
	Upper level statistical weight.

Numeric	A {}
	Einstein spontaneous emission coefficient.

Zeeman::Model	zeeman {}
	Zeeman model.

LineShape::Model	lineshape {}
	Line shape model.

Quantum::Number::LocalState	localquanta {}
	Local quantum numbers.

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

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

Detailed Description

Computations and data for a single absorption line.

Definition at line 161 of file absorptionlines.h.

Constructor & Destructor Documentation

◆ SingleLine() [1/2]

Absorption::SingleLine::SingleLine	(	Numeric	F0_ = `0`,
		Numeric	I0_ = `0`,
		Numeric	E0_ = `0`,
		Numeric	glow_ = `0`,
		Numeric	gupp_ = `0`,
		Numeric	A_ = `0`,
		Zeeman::Model	zeeman_ = `Zeeman::Model()`,
		LineShape::Model	lineshape_ = `LineShape::Model()`,
		Quantum::Number::LocalState	localquanta_ = `{}`
	)

inline

Default initialization.

Parameters

[in]	F0_	Central frequency
[in]	I0_	Reference line strength at external T0
[in]	E0_	Lower energy level
[in]	glow_	Lower level statistical weight
[in]	gupp_	Upper level statistical weight
[in]	A_	Einstein spontaneous emission coefficient
[in]	zeeman_	Zeeman model
[in]	lineshape_	Line shape model
[in]	localquanta_	Local quantum numbers

Definition at line 201 of file absorptionlines.h.

◆ SingleLine() [2/2]

Absorption::SingleLine::SingleLine	(	Quantum::Number::LocalState	metaquanta,
		LineShape::Model	metamodel
	)

inline

Initialization for constant sizes.

Parameters

metaquanta	A quantum number state with the right sizes and access points
metamodel	A line shape model with the right sizes and access points

Definition at line 225 of file absorptionlines.h.

Member Function Documentation

◆ LineShapeElems()

Index Absorption::SingleLine::LineShapeElems ( ) const

inlinenoexcept

Number of lineshape elements.

Definition at line 233 of file absorptionlines.h.

◆ LocalQuantumElems()

Index Absorption::SingleLine::LocalQuantumElems ( ) const

inline

Number of lower quantum numbers.

Definition at line 236 of file absorptionlines.h.

◆ read()

bifstream & Absorption::SingleLine::read ( bifstream & bif )

Binary read for AbsorptionLines.

Standard parameters

Line shape model

Lower level quantum numbers

Definition at line 2186 of file absorptionlines.cc.

References A, E0, F0, glow, gupp, I0, lineshape, localquanta, LineShape::Model::read(), Quantum::Number::LocalState::val, and zeeman.

◆ SetAutomaticZeeman()

void Absorption::SingleLine::SetAutomaticZeeman ( QuantumIdentifier qid )

Set Zeeman effect by automatic detection.

Will fail if the available and provided quantum numbers are bad

Parameters

[in] qid Copy of the global identifier to fill by local numbers

Definition at line 2162 of file absorptionlines.cc.

References localquanta, Quantum::Number::ValueList::set(), Quantum::Number::LocalState::val, Quantum::Number::GlobalState::val, and zeeman.

◆ SetLineMixing2AER()

void Absorption::SingleLine::SetLineMixing2AER ( const Vector & d )

Set the line mixing model to AER kind.

Parameters

[in] d Data in AER format

Definition at line 2175 of file absorptionlines.cc.

References d, LineShape::Model::Data(), and lineshape.

◆ SetLineMixing2SecondOrderData()

void Absorption::SingleLine::SetLineMixing2SecondOrderData ( const Vector & d )

Set the line mixing model to 2nd order.

Parameters

[in] d Data in 2nd order format

Definition at line 2168 of file absorptionlines.cc.

References d, lineshape, LineShape::LegacyLineMixingData::LM_2NDORDER, LineShape::Model::SetLineMixingModel(), and LineShape::LegacyLineMixingData::vector2modellm().

◆ write()

bofstream & Absorption::SingleLine::write ( bofstream & bof ) const

Binary write for AbsorptionLines.

Standard parameters

Line shape model

Lower level quantum numbers

Definition at line 2199 of file absorptionlines.cc.

References A, E0, F0, glow, gupp, I0, lineshape, localquanta, Quantum::Number::LocalState::val, LineShape::Model::write(), and zeeman.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const SingleLine &	line
	)

friend

Definition at line 1801 of file absorptionlines.cc.

◆ operator>>

std::istream & operator>>	(	std::istream &	is,
		Absorption::SingleLine &	line
	)

friend

Definition at line 1809 of file absorptionlines.cc.

Member Data Documentation

◆ A

Numeric Absorption::SingleLine::A {}

Einstein spontaneous emission coefficient.

Definition at line 178 of file absorptionlines.h.

Referenced by read(), Absorption::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat5Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), and write().

◆ E0

Numeric Absorption::SingleLine::E0 {}

Lower state energy level.

Definition at line 169 of file absorptionlines.h.

Referenced by read(), Absorption::ReadFromArtscat3Stream(), Absorption::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat5Stream(), Absorption::ReadFromHitran2001Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), Absorption::ReadFromJplStream(), Absorption::ReadFromLBLRTMStream(), and write().

◆ F0

Numeric Absorption::SingleLine::F0 {}

Central frequency.

Definition at line 163 of file absorptionlines.h.

Referenced by line_model(), read(), ReadArrayOfARTSCAT(), ReadARTSCAT(), Absorption::ReadFromArtscat3Stream(), Absorption::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat5Stream(), Absorption::ReadFromHitran2001Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), Absorption::ReadFromJplStream(), Absorption::ReadFromLBLRTMStream(), ReadHITRAN(), and write().

◆ glow

Numeric Absorption::SingleLine::glow {}

Lower level statistical weight.

Definition at line 172 of file absorptionlines.h.

Referenced by read(), Absorption::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat5Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), and write().

◆ gupp

Numeric Absorption::SingleLine::gupp {}

Upper level statistical weight.

Definition at line 175 of file absorptionlines.h.

Referenced by read(), Absorption::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat5Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), and write().

◆ I0

Numeric Absorption::SingleLine::I0 {}

Reference intensity.

Definition at line 166 of file absorptionlines.h.

Referenced by line_model(), read(), Absorption::ReadFromArtscat3Stream(), Absorption::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat5Stream(), Absorption::ReadFromHitran2001Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), Absorption::ReadFromJplStream(), Absorption::ReadFromLBLRTMStream(), and write().

◆ lineshape

LineShape::Model Absorption::SingleLine::lineshape {}

Line shape model.

Definition at line 184 of file absorptionlines.h.

Referenced by read(), Absorption::ReadFromArtscat3Stream(), Absorption::ReadFromArtscat4Stream(), Absorption::ReadFromArtscat5Stream(), Absorption::ReadFromHitran2001Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), Absorption::ReadFromJplStream(), Absorption::ReadFromLBLRTMStream(), SetLineMixing2AER(), SetLineMixing2SecondOrderData(), and write().

◆ localquanta

Quantum::Number::LocalState Absorption::SingleLine::localquanta {}

Local quantum numbers.

Definition at line 187 of file absorptionlines.h.

Referenced by read(), ReadArrayOfARTSCAT(), ReadARTSCAT(), ReadHITRAN(), SetAutomaticZeeman(), and write().

◆ zeeman

Zeeman::Model Absorption::SingleLine::zeeman {}

Zeeman model.

Definition at line 181 of file absorptionlines.h.

Referenced by read(), ReadArrayOfARTSCAT(), ReadARTSCAT(), Absorption::ReadFromArtscat5Stream(), ReadHITRAN(), SetAutomaticZeeman(), and write().

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

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SingleLine() [1/2]

◆ SingleLine() [2/2]

Member Function Documentation

◆ LineShapeElems()

◆ LocalQuantumElems()

◆ read()

◆ SetAutomaticZeeman()

◆ SetLineMixing2AER()

◆ SetLineMixing2SecondOrderData()

◆ write()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ A

◆ E0

◆ F0

◆ glow

◆ gupp

◆ I0

◆ lineshape

◆ localquanta

◆ zeeman