EnergyLevelMap Struct Reference

#include <energylevelmap.h>

Public Member Functions
bool	OK () const ARTS_NOEXCEPT
void	ThrowIfNotOK () const ARTS_NOEXCEPT
	EnergyLevelMap ()
	EnergyLevelMap (EnergyLevelMapType new_type, Index pages, Index rows, Index cols, const EnergyLevelMap &old)
	EnergyLevelMap (Tensor4 data, ArrayOfQuantumIdentifier levels, Vector energies=Vector(0))
	EnergyLevelMap (const Matrix &data, ArrayOfQuantumIdentifier levels, Vector energies=Vector(0))
	EnergyLevelMap (const Vector &data, ArrayOfQuantumIdentifier levels, Vector energies=Vector(0))
EnergyLevelMap	InterpToGridPos (Index atmosphere_dim, const ArrayOfGridPos &p, const ArrayOfGridPos &lat, const ArrayOfGridPos &lon) const
EnergyLevelMap	operator[] (Index ip) const
EnergyLevelMap	operator() (Index ip, Index ilat, Index ilon) const
Output2	get_ratio_params (const AbsorptionLines &band, const Index &line_index) const
	Get the output required for Population::NLTE.
Output4	get_vibtemp_params (const AbsorptionLines &band, const Numeric T) const
	Get the output required for Population::NLTE-VibrationalTemperatures.

Public Attributes
EnergyLevelMapType	type {EnergyLevelMapType::None_t}
ArrayOfQuantumIdentifier	levels
Vector	vib_energy
Tensor4	value

Friends
std::ostream &	operator<< (std::ostream &os, const EnergyLevelMap &elm)

Detailed Description

Definition at line 71 of file energylevelmap.h.

Constructor & Destructor Documentation

EnergyLevelMap() [1/5]

EnergyLevelMap::EnergyLevelMap ( )

inline

Definition at line 81 of file energylevelmap.h.

Referenced by operator()().

EnergyLevelMap() [2/5]

EnergyLevelMap::EnergyLevelMap ( EnergyLevelMapType  new_type, Index  pages, Index  rows, Index  cols, const EnergyLevelMap &  old  )

inline

Definition at line 84 of file energylevelmap.h.

References ThrowIfNotOK().

EnergyLevelMap() [3/5]

EnergyLevelMap::EnergyLevelMap	(	Tensor4	data,
		ArrayOfQuantumIdentifier	levels,
		Vector	energies = Vector(0)
	)

Definition at line 104 of file energylevelmap.cc.

References ThrowIfNotOK().

EnergyLevelMap() [4/5]

EnergyLevelMap::EnergyLevelMap	(	const Matrix &	data,
		ArrayOfQuantumIdentifier	levels,
		Vector	energies = Vector(0)
	)

Definition at line 113 of file energylevelmap.cc.

References ThrowIfNotOK(), and value.

EnergyLevelMap() [5/5]

EnergyLevelMap::EnergyLevelMap	(	const Vector &	data,
		ArrayOfQuantumIdentifier	levels,
		Vector	energies = Vector(0)
	)

Definition at line 123 of file energylevelmap.cc.

References ThrowIfNotOK(), and value.

Member Function Documentation

get_ratio_params()

Output2 EnergyLevelMap::get_ratio_params	(	const AbsorptionLines &	band,
		const Index &	line_index
	)		const

Get the output required for Population::NLTE.

Parameters

[in]

transition

A line-by-line transition

Returns

Upper and lower level distributions

Definition at line 40 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, levels, Absorption::Lines::lines, Absorption::Lines::quantumidentity, type, and value.

get_vibtemp_params()

Output4 EnergyLevelMap::get_vibtemp_params	(	const AbsorptionLines &	band,
		const Numeric	T
	)		const

Get the output required for Population::NLTE-VibrationalTemperatures.

Parameters

[in]

transition

A line-by-line transition

Returns

Upper and lower level distributions and energies

Definition at line 71 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, levels, Array< base >::nelem(), Absorption::Lines::quantumidentity, type, value, and vib_energy.

InterpToGridPos()

EnergyLevelMap EnergyLevelMap::InterpToGridPos	(	Index	atmosphere_dim,
		const ArrayOfGridPos &	p,
		const ArrayOfGridPos &	lat,
		const ArrayOfGridPos &	lon
	)		const

Definition at line 133 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, interp_atmfield_by_itw(), interp_atmfield_gp2itw(), levels, Array< base >::nelem(), type, and value.

Referenced by get_ppath_atmvars().

OK()

bool EnergyLevelMap::OK

(

)

const

Definition at line 13 of file energylevelmap.cc.

References levels, Array< base >::nelem(), type, value, and vib_energy.

Referenced by ThrowIfNotOK().

operator()()

EnergyLevelMap EnergyLevelMap::operator()	(	Index	ip,
		Index	ilat,
		Index	ilon
	)		const

Definition at line 176 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, EnergyLevelMap(), type, and value.

operator[]()

EnergyLevelMap EnergyLevelMap::operator[]

(

Index

ip

)

const

Definition at line 152 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, type, and value.

ThrowIfNotOK()

void EnergyLevelMap::ThrowIfNotOK ( ) const

inline

Definition at line 79 of file energylevelmap.h.

References ARTS_ASSERT, and OK().

Referenced by abs_lines_per_speciesPopulationNlteField(), AtmFieldsCalc(), AtmFieldsCalcExpand1D(), EnergyLevelMap(), and xml_read_from_stream().

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const EnergyLevelMap &  elm  )

friend

Definition at line 169 of file energylevelmap.cc.

Member Data Documentation

levels

ArrayOfQuantumIdentifier EnergyLevelMap::levels

Definition at line 73 of file energylevelmap.h.

Referenced by abs_lines_per_speciesPopulationNlteField(), AtmFieldsCalc(), AtmFieldsCalcExpand1D(), get_ratio_params(), get_vibtemp_params(), InterpToGridPos(), nlte_fieldForSingleSpeciesNonOverlappingLines(), nlte_positions_in_statistical_equilibrium_matrix(), OK(), xml_read_from_stream(), and xml_write_to_stream().

type

EnergyLevelMapType EnergyLevelMap::type {EnergyLevelMapType::None_t}

Definition at line 72 of file energylevelmap.h.

Referenced by AtmFieldsCalc(), AtmFieldsCalcExpand1D(), get_ratio_params(), get_vibtemp_params(), InterpToGridPos(), OK(), operator()(), operator[](), xml_read_from_stream(), and xml_write_to_stream().

value

Tensor4 EnergyLevelMap::value

Definition at line 75 of file energylevelmap.h.

Referenced by abs_lines_per_speciesPopulationNlteField(), AtmFieldsCalc(), AtmFieldsCalcExpand1D(), EnergyLevelMap(), get_ratio_params(), get_vibtemp_params(), InterpToGridPos(), iyIndependentBeamApproximation(), nlte_fieldForSingleSpeciesNonOverlappingLines(), nlte_fieldRescalePopulationLevels(), OK(), operator()(), operator[](), propmat_clearskyAddLines(), xml_read_from_stream(), xml_write_to_stream(), and zeeman_on_the_fly().

vib_energy

Vector EnergyLevelMap::vib_energy

Definition at line 74 of file energylevelmap.h.

Referenced by abs_lines_per_speciesPopulationNlteField(), AtmFieldsCalc(), AtmFieldsCalcExpand1D(), get_vibtemp_params(), OK(), xml_read_from_stream(), and xml_write_to_stream().

---

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

• energylevelmap.h
• energylevelmap.cc