ARTS 2.5.4 (git: 31ce4f0e)
LineShape::SingleSpeciesModel Class Reference

Compute the line shape parameters for a single broadening species. More...

#include <lineshapemodel.h>

Public Member Functions

constexpr SingleSpeciesModel (ModelParameters G0=ModelParameters{}, ModelParameters D0=ModelParameters{}, ModelParameters G2=ModelParameters{}, ModelParameters D2=ModelParameters{}, ModelParameters FVC=ModelParameters{}, ModelParameters ETA=ModelParameters{}, ModelParameters Y=ModelParameters{}, ModelParameters G=ModelParameters{}, ModelParameters DV=ModelParameters{})
 Default initialization. More...
 
 ACCESS_INTERNAL (G0)
 
 ACCESS_INTERNAL (D0)
 
 ACCESS_INTERNAL (G2)
 
 ACCESS_INTERNAL (D2)
 
 ACCESS_INTERNAL (FVC)
 
 ACCESS_INTERNAL (ETA)
 
 ACCESS_INTERNAL (Y)
 
 ACCESS_INTERNAL (G)
 
 ACCESS_INTERNAL (DV)
 
constexpr std::array< ModelParameters, nVars > & Data () noexcept
 Get internal Data reference. More...
 
constexpr const std::array< ModelParameters, nVars > & Data () const noexcept
 Get const internal Data reference. More...
 
constexpr void Set (Variable var, const ModelParameters &x) noexcept
 Set variable to a different ModelParameters. More...
 
constexpr ModelParameters Get (Variable var) const noexcept
 Get variable by type. More...
 
bifstreamread (bifstream &bif)
 Binary read for SingleSpeciesModel. More...
 
bofstreamwrite (bofstream &bof) const
 Binary write for SingleSpeciesModel. More...
 
std::pair< bool, bool > MatchTypes (const SingleSpeciesModel &other) const noexcept
 

Private Attributes

std::array< ModelParameters, nVarsX
 

Friends

std::ostream & operator<< (std::ostream &os, const SingleSpeciesModel &ssm)
 
std::istream & operator>> (std::istream &is, SingleSpeciesModel &ssm)
 

Detailed Description

Compute the line shape parameters for a single broadening species.

Definition at line 342 of file lineshapemodel.h.

Constructor & Destructor Documentation

◆ SingleSpeciesModel()

constexpr LineShape::SingleSpeciesModel::SingleSpeciesModel ( ModelParameters  G0 = ModelParameters{},
ModelParameters  D0 = ModelParameters{},
ModelParameters  G2 = ModelParameters{},
ModelParameters  D2 = ModelParameters{},
ModelParameters  FVC = ModelParameters{},
ModelParameters  ETA = ModelParameters{},
ModelParameters  Y = ModelParameters{},
ModelParameters  G = ModelParameters{},
ModelParameters  DV = ModelParameters{} 
)
inlineconstexpr

Default initialization.

Definition at line 348 of file lineshapemodel.h.

Member Function Documentation

◆ ACCESS_INTERNAL() [1/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( D0  )

◆ ACCESS_INTERNAL() [2/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( D2  )

◆ ACCESS_INTERNAL() [3/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( DV  )

◆ ACCESS_INTERNAL() [4/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( ETA  )

◆ ACCESS_INTERNAL() [5/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( FVC  )

◆ ACCESS_INTERNAL() [6/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( G  )

◆ ACCESS_INTERNAL() [7/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( G0  )

◆ ACCESS_INTERNAL() [8/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( G2  )

◆ ACCESS_INTERNAL() [9/9]

LineShape::SingleSpeciesModel::ACCESS_INTERNAL ( Y  )

◆ Data() [1/2]

constexpr const std::array< ModelParameters, nVars > & LineShape::SingleSpeciesModel::Data ( ) const
inlineconstexprnoexcept

Get const internal Data reference.

Definition at line 378 of file lineshapemodel.h.

References X.

◆ Data() [2/2]

constexpr std::array< ModelParameters, nVars > & LineShape::SingleSpeciesModel::Data ( )
inlineconstexprnoexcept

Get internal Data reference.

Definition at line 375 of file lineshapemodel.h.

References X.

◆ Get()

constexpr ModelParameters LineShape::SingleSpeciesModel::Get ( Variable  var) const
inlineconstexprnoexcept

Get variable by type.

Parameters
[in]varThe variable type
Returns
ModelParameters copy

Definition at line 411 of file lineshapemodel.h.

References LineShape::D0, LineShape::D2, LineShape::ETA, LineShape::FVC, LineShape::G, LineShape::G0, LineShape::G2, MODELPARAMCASEGETTER, Raw::Average::var(), and LineShape::Y.

◆ MatchTypes()

std::pair< bool, bool > LineShape::SingleSpeciesModel::MatchTypes ( const SingleSpeciesModel other) const
noexcept

Definition at line 948 of file lineshapemodel.cc.

References LineShape::modelparameterEmpty(), and LineShape::nVars.

◆ read()

bifstream & LineShape::SingleSpeciesModel::read ( bifstream bif)

Binary read for SingleSpeciesModel.

Definition at line 932 of file lineshapemodel.cc.

References X.

◆ Set()

constexpr void LineShape::SingleSpeciesModel::Set ( Variable  var,
const ModelParameters x 
)
inlineconstexprnoexcept

Set variable to a different ModelParameters.

Parameters
[in]varThe variable
[in]xThe new ModelParameters for var

Definition at line 385 of file lineshapemodel.h.

References LineShape::D0, LineShape::D2, LineShape::ETA, LineShape::FVC, LineShape::G, LineShape::G0, LineShape::G2, MODELPARAMCASESETTER, Raw::Average::var(), and LineShape::Y.

◆ write()

bofstream & LineShape::SingleSpeciesModel::write ( bofstream bof) const

Binary write for SingleSpeciesModel.

Definition at line 941 of file lineshapemodel.cc.

References X.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const SingleSpeciesModel ssm 
)
friend

Definition at line 957 of file lineshapemodel.cc.

◆ operator>>

std::istream & operator>> ( std::istream &  is,
SingleSpeciesModel ssm 
)
friend

Definition at line 964 of file lineshapemodel.cc.

Member Data Documentation

◆ X

std::array<ModelParameters, nVars> LineShape::SingleSpeciesModel::X
private

Definition at line 344 of file lineshapemodel.h.

Referenced by Data(), read(), and write().


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