ARTS 2.5.4 (git: 31ce4f0e)
LineShape::ModelParameters Struct Reference

Coefficients and temperature model for SingleSpeciesModel. More...

#include <lineshapemodel.h>

Public Member Functions

constexpr ModelParameters (TemperatureModel intype=TemperatureModel::None, Numeric inX0=std::numeric_limits< Numeric >::quiet_NaN(), Numeric inX1=std::numeric_limits< Numeric >::quiet_NaN(), Numeric inX2=std::numeric_limits< Numeric >::quiet_NaN(), Numeric inX3=std::numeric_limits< Numeric >::quiet_NaN()) noexcept
 
template<typename VectorType >
constexpr ModelParameters (TemperatureModel intype, VectorType &&v) ARTS_NOEXCEPT
 
constexpr Numeric special_linemixing_aer (Numeric T) const noexcept
 Line mixing as done by AER data in ARTS. More...
 
constexpr Numeric special_linemixing_aer_dT (Numeric T) const noexcept
 The temperature derivative of special_linemixing_aer. More...
 
Numeric at (Numeric T, Numeric T0) const noexcept
 
Numeric dX0 (Numeric T, Numeric T0) const noexcept
 
Numeric dX1 (Numeric T, Numeric T0) const noexcept
 
Numeric dX2 (Numeric T, Numeric T0) const noexcept
 
Numeric dX3 (Numeric T, Numeric T0) const noexcept
 
Numeric dT (Numeric T, Numeric T0) const noexcept
 
Numeric dT0 (Numeric T, Numeric T0) const noexcept
 

Static Public Member Functions

static constexpr Numeric special_linemixing_aer_dX0 (Numeric T) noexcept
 The derivative of special_linemixing_aer wrt X0. More...
 
static constexpr Numeric special_linemixing_aer_dX1 (Numeric T) noexcept
 The derivative of special_linemixing_aer wrt X1. More...
 
static constexpr Numeric special_linemixing_aer_dX2 (Numeric T) noexcept
 The derivative of special_linemixing_aer wrt X2. More...
 
static constexpr Numeric special_linemixing_aer_dX3 (Numeric T) noexcept
 The derivative of special_linemixing_aer wrt X3. More...
 

Public Attributes

TemperatureModel type
 
Numeric X0
 
Numeric X1
 
Numeric X2
 
Numeric X3
 

Static Public Attributes

static constexpr Index N = 4
 

Friends

std::ostream & operator<< (std::ostream &os, const ModelParameters &mp)
 
std::istream & operator>> (std::istream &is, ModelParameters &mp)
 

Detailed Description

Coefficients and temperature model for SingleSpeciesModel.

NOTE: Developer should always add new coefficients at the end

Definition at line 107 of file lineshapemodel.h.

Constructor & Destructor Documentation

◆ ModelParameters() [1/2]

constexpr LineShape::ModelParameters::ModelParameters ( TemperatureModel  intype = TemperatureModel::None,
Numeric  inX0 = std::numeric_limits<Numeric>::quiet_NaN(),
Numeric  inX1 = std::numeric_limits<Numeric>::quiet_NaN(),
Numeric  inX2 = std::numeric_limits<Numeric>::quiet_NaN(),
Numeric  inX3 = std::numeric_limits<Numeric>::quiet_NaN() 
)
inlineconstexprnoexcept

Definition at line 116 of file lineshapemodel.h.

◆ ModelParameters() [2/2]

template<typename VectorType >
constexpr LineShape::ModelParameters::ModelParameters ( TemperatureModel  intype,
VectorType &&  v 
)
inlineconstexpr

Definition at line 124 of file lineshapemodel.h.

References ARTS_ASSERT, N, and v.

Member Function Documentation

◆ at()

Numeric LineShape::ModelParameters::at ( Numeric  T,
Numeric  T0 
) const
noexcept

Definition at line 718 of file lineshapemodel.cc.

◆ dT()

Numeric LineShape::ModelParameters::dT ( Numeric  T,
Numeric  T0 
) const
noexcept

Definition at line 868 of file lineshapemodel.cc.

◆ dT0()

Numeric LineShape::ModelParameters::dT0 ( Numeric  T,
Numeric  T0 
) const
noexcept

Definition at line 900 of file lineshapemodel.cc.

◆ dX0()

Numeric LineShape::ModelParameters::dX0 ( Numeric  T,
Numeric  T0 
) const
noexcept

Definition at line 748 of file lineshapemodel.cc.

◆ dX1()

Numeric LineShape::ModelParameters::dX1 ( Numeric  T,
Numeric  T0 
) const
noexcept

Definition at line 778 of file lineshapemodel.cc.

◆ dX2()

Numeric LineShape::ModelParameters::dX2 ( Numeric  T,
Numeric  T0 
) const
noexcept

Definition at line 808 of file lineshapemodel.cc.

◆ dX3()

Numeric LineShape::ModelParameters::dX3 ( Numeric  T,
Numeric  T0 
) const
noexcept

Definition at line 838 of file lineshapemodel.cc.

◆ special_linemixing_aer()

constexpr Numeric LineShape::ModelParameters::special_linemixing_aer ( Numeric  T) const
inlineconstexprnoexcept

Line mixing as done by AER data in ARTS.

Uses piece-wise linear interpolation and extrapolates at the edges

var must be G or Y

Parameters
[in]TThe temperature
[in]varThe variable
Returns
The broadening parameter at temperature

Definition at line 147 of file lineshapemodel.h.

◆ special_linemixing_aer_dT()

constexpr Numeric LineShape::ModelParameters::special_linemixing_aer_dT ( Numeric  T) const
inlineconstexprnoexcept

The temperature derivative of special_linemixing_aer.

Parameters
[in]TThe temperature
[in]varThe variable
Returns
The temperature derivative of the broadening parameter at temperature

Definition at line 162 of file lineshapemodel.h.

◆ special_linemixing_aer_dX0()

static constexpr Numeric LineShape::ModelParameters::special_linemixing_aer_dX0 ( Numeric  T)
inlinestaticconstexprnoexcept

The derivative of special_linemixing_aer wrt X0.

Parameters
[in]TThe temperature
Returns
The temperature derivative of the broadening parameter at temperature

Definition at line 176 of file lineshapemodel.h.

◆ special_linemixing_aer_dX1()

static constexpr Numeric LineShape::ModelParameters::special_linemixing_aer_dX1 ( Numeric  T)
inlinestaticconstexprnoexcept

The derivative of special_linemixing_aer wrt X1.

Parameters
[in]TThe temperature
Returns
The temperature derivative of the broadening parameter at temperature

Definition at line 188 of file lineshapemodel.h.

◆ special_linemixing_aer_dX2()

static constexpr Numeric LineShape::ModelParameters::special_linemixing_aer_dX2 ( Numeric  T)
inlinestaticconstexprnoexcept

The derivative of special_linemixing_aer wrt X2.

Parameters
[in]TThe temperature
Returns
The temperature derivative of the broadening parameter at temperature

Definition at line 202 of file lineshapemodel.h.

◆ special_linemixing_aer_dX3()

static constexpr Numeric LineShape::ModelParameters::special_linemixing_aer_dX3 ( Numeric  T)
inlinestaticconstexprnoexcept

The derivative of special_linemixing_aer wrt X3.

Parameters
[in]TThe temperature
Returns
The temperature derivative of the broadening parameter at temperature

Definition at line 216 of file lineshapemodel.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const ModelParameters mp 
)
friend

Definition at line 707 of file lineshapemodel.cc.

◆ operator>>

std::istream & operator>> ( std::istream &  is,
ModelParameters mp 
)
friend

Definition at line 713 of file lineshapemodel.cc.

Member Data Documentation

◆ N

constexpr Index LineShape::ModelParameters::N = 4
staticconstexpr

◆ type

TemperatureModel LineShape::ModelParameters::type

◆ X0

◆ X1

Numeric LineShape::ModelParameters::X1

◆ X2

Numeric LineShape::ModelParameters::X2

◆ X3

Numeric LineShape::ModelParameters::X3

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