IsotopeRecord Class Reference

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

#include <absorption.h>

Collaboration diagram for IsotopeRecord:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 IsotopeRecord ()
 Default constructor.
 IsotopeRecord (const IsotopeRecord &x)
 Copy constructor.
 IsotopeRecord (const String &name, const Numeric &abundance, const Numeric &mass, const Index &mytrantag, const Index &hitrantag, const MakeArray< Index > &jpltags)
 Constructor that sets the values.
const StringName () const
 Isotope name.
const NumericAbundance () const
 Normal abundance ( = isotopic ratio).
const NumericMass () const
 Mass of the isotope.
const IndexMytranTag () const
 MYTRAN2 tag numbers for all isotopes.
const IndexHitranTag () const
 HITRAN-96 tag numbers for all isotopes.
const ArrayOfIndexJplTags () const
 JPL tag numbers for all isotopes.
void SetPartitionFctCoeff (const ArrayOfNumeric &qcoeff)
Numeric CalculatePartitionFctRatio (Numeric reference_temperature, Numeric actual_temperature) const
 Calculate partition function ratio.

Private Member Functions

Numeric CalculatePartitionFctAtTemp (Numeric temperature) const

Private Attributes

String mname
Numeric mabundance
Numeric mmass
Index mmytrantag
Index mhitrantag
ArrayOfIndex mjpltags
ArrayOfNumeric mqcoeff


Detailed Description

Contains the lookup data for one isotope.

Author:
Stefan Buehler

Definition at line 180 of file absorption.h.


Constructor & Destructor Documentation

IsotopeRecord::IsotopeRecord (  )  [inline]

Default constructor.

Needed by make_array.

Definition at line 184 of file absorption.h.

IsotopeRecord::IsotopeRecord ( const IsotopeRecord x  )  [inline]

Copy constructor.

We need this, since operator= does not work correctly for Arrays. (Target Array has to be resized first.)

Definition at line 195 of file absorption.h.

IsotopeRecord::IsotopeRecord ( const String name,
const Numeric abundance,
const Numeric mass,
const Index mytrantag,
const Index hitrantag,
const MakeArray< Index > &  jpltags 
) [inline]

Constructor that sets the values.

Definition at line 206 of file absorption.h.

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


Member Function Documentation

const String& IsotopeRecord::Name (  )  const [inline]

Isotope name.

Definition at line 235 of file absorption.h.

References mname.

Referenced by xml_write_to_stream().

const Numeric& IsotopeRecord::Abundance (  )  const [inline]

Normal abundance ( = isotopic ratio).

(Absolute number.)

Definition at line 237 of file absorption.h.

References mabundance.

Referenced by xml_write_to_stream(), and xsec_species().

const Numeric& IsotopeRecord::Mass (  )  const [inline]

Mass of the isotope.

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

Definition at line 240 of file absorption.h.

References mmass.

Referenced by xml_write_to_stream(), and xsec_species().

const Index& IsotopeRecord::MytranTag (  )  const [inline]

MYTRAN2 tag numbers for all isotopes.

-1 means not included.

Definition at line 242 of file absorption.h.

References mmytrantag.

Referenced by xml_write_to_stream().

const Index& IsotopeRecord::HitranTag (  )  const [inline]

HITRAN-96 tag numbers for all isotopes.

-1 means not included.

Definition at line 244 of file absorption.h.

References mhitrantag.

Referenced by xml_write_to_stream().

const ArrayOfIndex& IsotopeRecord::JplTags (  )  const [inline]

JPL tag numbers for all isotopes.

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

Definition at line 248 of file absorption.h.

References mjpltags.

Referenced by xml_write_to_stream().

void IsotopeRecord::SetPartitionFctCoeff ( const ArrayOfNumeric qcoeff  )  [inline]

Definition at line 250 of file absorption.h.

References mqcoeff.

Numeric IsotopeRecord::CalculatePartitionFctRatio ( Numeric  reference_temperature,
Numeric  actual_temperature 
) const [inline]

Calculate partition function ratio.

This computes the partition function ratio Q(Tref)/Q(T).

Unfortunately, we have to recalculate also Q(Tref) for each spectral line, because the reference temperatures can be different!

Parameters:
reference_temperature The reference temperature.
actual_temperature The actual temperature.
Returns:
The ratio.

Definition at line 268 of file absorption.h.

References CalculatePartitionFctAtTemp(), and mname.

Referenced by xsec_species().

Numeric IsotopeRecord::CalculatePartitionFctAtTemp ( Numeric  temperature  )  const [private]

Definition at line 51 of file absorption.cc.

References mqcoeff.

Referenced by CalculatePartitionFctRatio().


Member Data Documentation

Definition at line 293 of file absorption.h.

Referenced by CalculatePartitionFctRatio(), and Name().

Definition at line 294 of file absorption.h.

Referenced by Abundance().

Definition at line 295 of file absorption.h.

Referenced by Mass().

Definition at line 296 of file absorption.h.

Referenced by IsotopeRecord(), and MytranTag().

Definition at line 297 of file absorption.h.

Referenced by HitranTag(), and IsotopeRecord().

Definition at line 298 of file absorption.h.

Referenced by IsotopeRecord(), and JplTags().

Definition at line 299 of file absorption.h.

Referenced by CalculatePartitionFctAtTemp(), and SetPartitionFctCoeff().


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

Generated on Mon Mar 23 14:07:00 2009 for ARTS by  doxygen 1.5.6