ARTS  2.4.0(git:4fb77825)
Public Types | Public Member Functions | Private Attributes | List of all members
IsotopologueRecord Class Reference

Contains the lookup data for one isotopologue. More...

#include <absorption.h>

Public Types

enum  { PF_FROMCOEFF, PF_FROMTEMP, PF_NOTHING }
 

Public Member Functions

 IsotopologueRecord ()=default
 Default constructor. More...
 
 IsotopologueRecord (const IsotopologueRecord &)=default
 
 IsotopologueRecord (IsotopologueRecord &&)=default
 
IsotopologueRecord & operator= (const IsotopologueRecord &)=default
 
IsotopologueRecord & operator= (IsotopologueRecord &&)=default
 
 IsotopologueRecord (const String &name, const Numeric &abundance, const Numeric &mass, const Index &mytrantag, const Index &hitrantag, const ArrayOfIndex &jpltags)
 Constructor that sets the values. More...
 
const String & Name () const
 Isotopologue name. More...
 
const Numeric & Abundance () const
 Normal abundance ( = isotopologue ratio). More...
 
const Numeric & Mass () const
 Mass of the isotopologue. More...
 
const Index & MytranTag () const
 MYTRAN2 tag numbers for all isotopologues. More...
 
const Index & HitranTag () const
 HITRAN-96 tag numbers for all isotopologues. More...
 
const ArrayOfIndex & JplTags () const
 JPL tag numbers for all isotopologues. More...
 
bool isContinuum () const
 Check if isotopologue is actually a continuum. More...
 
const Vector & GetCoeff () const
 Return the partition function coefficients. More...
 
const Vector & GetCoeffGrid () const
 Return the partition function coefficients. More...
 
Index GetCoeffType () const
 Return the partition function coefficient types. More...
 
void SetPartitionFctCoeff (const ArrayOfNumeric &qcoeff, const ArrayOfNumeric &temp_range, const Index &qcoefftype)
 

Private Attributes

String mname
 
Numeric mabundance
 
Numeric mmass
 
Index mmytrantag
 
Index mhitrantag
 
ArrayOfIndex mjpltags
 
Vector mqcoeff
 
Index mqcoefftype
 
Vector mqcoeffgrid
 

Detailed Description

Contains the lookup data for one isotopologue.

Author
Stefan Buehler

Definition at line 45 of file absorption.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
PF_FROMCOEFF 
PF_FROMTEMP 
PF_NOTHING 

Definition at line 123 of file absorption.h.

Constructor & Destructor Documentation

◆ IsotopologueRecord() [1/4]

IsotopologueRecord::IsotopologueRecord ( )
default

Default constructor.

Needed by make_array.

◆ IsotopologueRecord() [2/4]

IsotopologueRecord::IsotopologueRecord ( const IsotopologueRecord &  )
default

◆ IsotopologueRecord() [3/4]

IsotopologueRecord::IsotopologueRecord ( IsotopologueRecord &&  )
default

◆ IsotopologueRecord() [4/4]

IsotopologueRecord::IsotopologueRecord ( const String &  name,
const Numeric &  abundance,
const Numeric &  mass,
const Index &  mytrantag,
const Index &  hitrantag,
const ArrayOfIndex &  jpltags 
)
inline

Constructor that sets the values.

Definition at line 55 of file absorption.h.

References mhitrantag, mjpltags, mmytrantag, and Array< base >::nelem().

Member Function Documentation

◆ Abundance()

const Numeric& IsotopologueRecord::Abundance ( ) const
inline

Normal abundance ( = isotopologue ratio).

(Absolute number.)

Definition at line 87 of file absorption.h.

References mabundance.

Referenced by xml_write_to_stream().

◆ GetCoeff()

const Vector& IsotopologueRecord::GetCoeff ( ) const
inline

Return the partition function coefficients.

Definition at line 107 of file absorption.h.

References mqcoeff.

◆ GetCoeffGrid()

const Vector& IsotopologueRecord::GetCoeffGrid ( ) const
inline

Return the partition function coefficients.

Definition at line 110 of file absorption.h.

References mqcoeffgrid.

◆ GetCoeffType()

Index IsotopologueRecord::GetCoeffType ( ) const
inline

Return the partition function coefficient types.

Definition at line 113 of file absorption.h.

References mqcoefftype.

◆ HitranTag()

const Index& IsotopologueRecord::HitranTag ( ) const
inline

HITRAN-96 tag numbers for all isotopologues.

-1 means not included.

Definition at line 94 of file absorption.h.

References mhitrantag.

Referenced by xml_write_to_stream().

◆ isContinuum()

bool IsotopologueRecord::isContinuum ( ) const
inline

Check if isotopologue is actually a continuum.

Returns
True if this is a continuum.

Definition at line 104 of file absorption.h.

References mname.

◆ JplTags()

const ArrayOfIndex& IsotopologueRecord::JplTags ( ) const
inline

JPL tag numbers for all isotopologues.

Empty array means not included. There can be more than one JPL tag for an isotopologue species, because in JPL different vibrational states have different tags.

Definition at line 98 of file absorption.h.

References mjpltags.

Referenced by xml_write_to_stream().

◆ Mass()

const Numeric& IsotopologueRecord::Mass ( ) const
inline

Mass of the isotopologue.

(In unified atomic mass units u) If I understand this correctly this is the same as g/mol.

Definition at line 90 of file absorption.h.

References mmass.

Referenced by xml_write_to_stream().

◆ MytranTag()

const Index& IsotopologueRecord::MytranTag ( ) const
inline

MYTRAN2 tag numbers for all isotopologues.

-1 means not included.

Definition at line 92 of file absorption.h.

References mmytrantag.

Referenced by xml_write_to_stream().

◆ Name()

const String& IsotopologueRecord::Name ( ) const
inline

Isotopologue name.

Definition at line 85 of file absorption.h.

References mname.

Referenced by xml_write_to_stream().

◆ operator=() [1/2]

IsotopologueRecord& IsotopologueRecord::operator= ( const IsotopologueRecord &  )
default

◆ operator=() [2/2]

IsotopologueRecord& IsotopologueRecord::operator= ( IsotopologueRecord &&  )
default

◆ SetPartitionFctCoeff()

void IsotopologueRecord::SetPartitionFctCoeff ( const ArrayOfNumeric &  qcoeff,
const ArrayOfNumeric &  temp_range,
const Index &  qcoefftype 
)
inline

Definition at line 115 of file absorption.h.

References mqcoeff, mqcoeffgrid, and mqcoefftype.

Member Data Documentation

◆ mabundance

Numeric IsotopologueRecord::mabundance
private

Definition at line 131 of file absorption.h.

Referenced by Abundance().

◆ mhitrantag

Index IsotopologueRecord::mhitrantag
private

Definition at line 134 of file absorption.h.

Referenced by HitranTag(), and IsotopologueRecord().

◆ mjpltags

ArrayOfIndex IsotopologueRecord::mjpltags
private

Definition at line 135 of file absorption.h.

Referenced by IsotopologueRecord(), and JplTags().

◆ mmass

Numeric IsotopologueRecord::mmass
private

Definition at line 132 of file absorption.h.

Referenced by Mass().

◆ mmytrantag

Index IsotopologueRecord::mmytrantag
private

Definition at line 133 of file absorption.h.

Referenced by IsotopologueRecord(), and MytranTag().

◆ mname

String IsotopologueRecord::mname
private

Definition at line 130 of file absorption.h.

Referenced by isContinuum(), and Name().

◆ mqcoeff

Vector IsotopologueRecord::mqcoeff
private

Definition at line 136 of file absorption.h.

Referenced by GetCoeff(), and SetPartitionFctCoeff().

◆ mqcoeffgrid

Vector IsotopologueRecord::mqcoeffgrid
private

Definition at line 138 of file absorption.h.

Referenced by GetCoeffGrid(), and SetPartitionFctCoeff().

◆ mqcoefftype

Index IsotopologueRecord::mqcoefftype
private

Definition at line 137 of file absorption.h.

Referenced by GetCoeffType(), and SetPartitionFctCoeff().

The documentation for this class was generated from the following file: