ARTS 2.5.9 (git: 825fa5f2)
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. 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 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(), and value.

◆ EnergyLevelMap() [5/5]

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

Definition at line 141 of file energylevelmap.cc.

References joker, 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, 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]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, 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

◆ OK()

◆ 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, 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(), type, and value.

◆ ThrowIfNotOK()

void EnergyLevelMap::ThrowIfNotOK ( ) const
inline

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

◆ type

◆ value

◆ vib_energy


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