ARTS  2.3.1277(git:c4d0469d)
LineshapeRecord Class Reference

Lineshape related information. More...

#include <absorption.h>

Public Member Functions

 LineshapeRecord ()
 Default constructor. More...
 
 LineshapeRecord (const String &name, const String &description, lsf_type function, const bool phase, const bool partials)
 Initializing constructor, used to build the lookup table. More...
 
 LineshapeRecord (const String &name, const String &description, lsf_type function, lsf_type_dT function_dT, lsf_type_dF function_dF, lsf_type_dF0 function_dF0, lsf_type_dgamma function_dgamma, lsf_type_dH function_dH, lsf_type_dDF function_dDF, const bool phase, const bool partials)
 Initializing constructor, used to build the lookup table. More...
 
const StringName () const
 Return the name of this lineshape. More...
 
const StringDescription () const
 Return the description text. More...
 
lsf_type Function () const
 Return pointer to lineshape function. More...
 
lsf_type_dT dInput_dT () const
 
lsf_type_dF dInput_dF () const
 
lsf_type_dF dInput_dF0 () const
 
lsf_type_dgamma dInput_dgamma () const
 
lsf_type_dH dInput_dH () const
 
lsf_type_dDF dInput_dDF () const
 
bool Phase () const
 Returns true if lineshape function calculates phase information. More...
 
bool Partials () const
 

Private Attributes

String mname
 Name of the function (e.g., Lorentz). More...
 
String mdescription
 Short description. More...
 
bool mphase
 Does this lineshape calculate phase information? More...
 
bool mpartials
 Does this lineshape calculate partial derivatives? More...
 
lsf_type mfunction
 Pointer to lineshape function. More...
 
lsf_type_dT mfunction_dT
 Pointer to lineshape function derivative. More...
 
lsf_type_dF mfunction_dF
 Pointer to lineshape function derivative. More...
 
lsf_type_dF0 mfunction_dF0
 Pointer to lineshape function derivative. More...
 
lsf_type_dgamma mfunction_dgamma
 Pointer to lineshape function derivative. More...
 
lsf_type_dH mfunction_dH
 Pointer to lineshape function derivative. More...
 
lsf_type_dDF mfunction_dDF
 Pointer to lineshape function derivative. More...
 

Detailed Description

Lineshape related information.

There is one LineshapeRecord for each available lineshape function.

Author
Stefan Buehler
Date
2000-08-21

Definition at line 101 of file absorption.h.

Constructor & Destructor Documentation

LineshapeRecord::LineshapeRecord ( )
inline

Default constructor.

Definition at line 104 of file absorption.h.

LineshapeRecord::LineshapeRecord ( const String name,
const String description,
lsf_type  function,
const bool  phase,
const bool  partials 
)
inline

Initializing constructor, used to build the lookup table.

No partials.

Definition at line 118 of file absorption.h.

References mpartials.

LineshapeRecord::LineshapeRecord ( const String name,
const String description,
lsf_type  function,
lsf_type_dT  function_dT,
lsf_type_dF  function_dF,
lsf_type_dF0  function_dF0,
lsf_type_dgamma  function_dgamma,
lsf_type_dH  function_dH,
lsf_type_dDF  function_dDF,
const bool  phase,
const bool  partials 
)
inline

Initializing constructor, used to build the lookup table.

With partials.

Definition at line 135 of file absorption.h.

Member Function Documentation

const String& LineshapeRecord::Description ( ) const
inline

Return the description text.

Definition at line 162 of file absorption.h.

References mdescription.

lsf_type_dDF LineshapeRecord::dInput_dDF ( ) const
inline

Definition at line 170 of file absorption.h.

References mfunction_dDF.

lsf_type_dF LineshapeRecord::dInput_dF ( ) const
inline

Definition at line 166 of file absorption.h.

References mfunction_dF.

lsf_type_dF LineshapeRecord::dInput_dF0 ( ) const
inline

Definition at line 167 of file absorption.h.

References mfunction_dF0.

lsf_type_dgamma LineshapeRecord::dInput_dgamma ( ) const
inline

Definition at line 168 of file absorption.h.

References mfunction_dgamma.

lsf_type_dH LineshapeRecord::dInput_dH ( ) const
inline

Definition at line 169 of file absorption.h.

References mfunction_dH.

lsf_type_dT LineshapeRecord::dInput_dT ( ) const
inline

Definition at line 165 of file absorption.h.

References mfunction_dT.

lsf_type LineshapeRecord::Function ( ) const
inline

Return pointer to lineshape function.

Definition at line 164 of file absorption.h.

References mfunction.

const String& LineshapeRecord::Name ( ) const
inline

Return the name of this lineshape.

Definition at line 160 of file absorption.h.

References mname.

bool LineshapeRecord::Partials ( ) const
inline

Definition at line 173 of file absorption.h.

References mpartials.

bool LineshapeRecord::Phase ( ) const
inline

Returns true if lineshape function calculates phase information.

Definition at line 172 of file absorption.h.

References mphase.

Member Data Documentation

String LineshapeRecord::mdescription
private

Short description.

Definition at line 177 of file absorption.h.

Referenced by Description().

lsf_type LineshapeRecord::mfunction
private

Pointer to lineshape function.

Definition at line 180 of file absorption.h.

Referenced by Function().

lsf_type_dDF LineshapeRecord::mfunction_dDF
private

Pointer to lineshape function derivative.

Definition at line 187 of file absorption.h.

Referenced by dInput_dDF().

lsf_type_dF LineshapeRecord::mfunction_dF
private

Pointer to lineshape function derivative.

Definition at line 182 of file absorption.h.

Referenced by dInput_dF().

lsf_type_dF0 LineshapeRecord::mfunction_dF0
private

Pointer to lineshape function derivative.

Definition at line 183 of file absorption.h.

Referenced by dInput_dF0().

lsf_type_dgamma LineshapeRecord::mfunction_dgamma
private

Pointer to lineshape function derivative.

Definition at line 185 of file absorption.h.

Referenced by dInput_dgamma().

lsf_type_dH LineshapeRecord::mfunction_dH
private

Pointer to lineshape function derivative.

Definition at line 186 of file absorption.h.

Referenced by dInput_dH().

lsf_type_dT LineshapeRecord::mfunction_dT
private

Pointer to lineshape function derivative.

Definition at line 181 of file absorption.h.

Referenced by dInput_dT().

String LineshapeRecord::mname
private

Name of the function (e.g., Lorentz).

Definition at line 176 of file absorption.h.

Referenced by Name().

bool LineshapeRecord::mpartials
private

Does this lineshape calculate partial derivatives?

Definition at line 179 of file absorption.h.

Referenced by LineshapeRecord(), and Partials().

bool LineshapeRecord::mphase
private

Does this lineshape calculate phase information?

Definition at line 178 of file absorption.h.

Referenced by Phase().


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