ARTS 2.5.4 (git: bcd8c674)
Public Member Functions | Public Attributes | Friends | List of all members
EnergyLevelMap Struct Reference

#include <energylevelmap.h>

Public Member Functions

bool OK () const 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. More...
 
Output4 get_vibtemp_params (const AbsorptionLines &band, const Numeric T) const
 Get the output required for Population::NLTE-VibrationalTemperatures. More...
 

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 89 of file energylevelmap.h.

Constructor & Destructor Documentation

◆ EnergyLevelMap() [1/5]

EnergyLevelMap::EnergyLevelMap ( )
inline

Definition at line 99 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 102 of file energylevelmap.h.

References ThrowIfNotOK().

◆ EnergyLevelMap() [3/5]

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

Definition at line 122 of file energylevelmap.cc.

References Tensor3_t, and ThrowIfNotOK().

◆ EnergyLevelMap() [4/5]

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

Definition at line 131 of file energylevelmap.cc.

References joker, ThrowIfNotOK(), value, and Vector_t.

◆ EnergyLevelMap() [5/5]

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

Definition at line 141 of file energylevelmap.cc.

References joker, Numeric_t, 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]transitionA line-by-line transition
Returns
Upper and lower level distributions

Definition at line 58 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, levels, Absorption::Lines::lines, Quantum::Number::StateMatch::low, Numeric_t, Absorption::Lines::quantumidentity, type, Quantum::Number::StateMatch::upp, 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]transitionA line-by-line transition
Returns
Upper and lower level distributions and energies

Definition at line 89 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, levels, Quantum::Number::StateMatch::low, Array< base >::nelem(), Numeric_t, Absorption::Lines::quantumidentity, type, Quantum::Number::StateMatch::upp, value, and vib_energy.

◆ InterpToGridPos()

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

Definition at line 151 of file energylevelmap.cc.

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

Referenced by get_ppath_atmvars().

◆ OK()

bool EnergyLevelMap::OK ( ) const
noexcept

Definition at line 31 of file energylevelmap.cc.

References VectorView::begin(), VectorView::end(), levels, ConstTensor4View::nbooks(), ConstTensor4View::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), None_t, ConstTensor4View::npages(), ConstTensor4View::nrows(), Numeric_t, Tensor3_t, type, value, Vector_t, and vib_energy.

Referenced by ThrowIfNotOK().

◆ operator()()

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

Definition at line 194 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, EnergyLevelMap(), joker, None_t, Numeric_t, Tensor3_t, type, and value.

◆ operator[]()

EnergyLevelMap EnergyLevelMap::operator[] ( Index  ip) const

Definition at line 170 of file energylevelmap.cc.

References ARTS_USER_ERROR_IF, joker, ConstTensor4View::ncols(), None_t, Numeric_t, type, value, and Vector_t.

◆ ThrowIfNotOK()

void EnergyLevelMap::ThrowIfNotOK ( ) const
inline

Definition at line 97 of file energylevelmap.h.

References ARTS_ASSERT, and OK().

Referenced by abs_lines_per_speciesPopulationNlteField(), 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 187 of file energylevelmap.cc.

Member Data Documentation

◆ levels

ArrayOfQuantumIdentifier EnergyLevelMap::levels

Definition at line 91 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 90 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 93 of file energylevelmap.h.

Referenced by abs_lines_per_speciesPopulationNlteField(), 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 92 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: