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.

constexpr Numeric	special_linemixing_aer_dT (Numeric T) const noexcept
	The temperature derivative of special_linemixing_aer.

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.

static constexpr Numeric	special_linemixing_aer_dX1 (Numeric T) noexcept
	The derivative of special_linemixing_aer wrt X1.

static constexpr Numeric	special_linemixing_aer_dX2 (Numeric T) noexcept
	The derivative of special_linemixing_aer wrt X2.

static constexpr Numeric	special_linemixing_aer_dX3 (Numeric T) noexcept
	The derivative of special_linemixing_aer wrt X3.

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 153 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 162 of file lineshapemodel.h.

◆ ModelParameters() [2/2]

template<typename VectorType >

constexpr LineShape::ModelParameters::ModelParameters	(	TemperatureModel	intype,
		VectorType &&	v
	)

inlineconstexpr

Definition at line 170 of file lineshapemodel.h.

References ARTS_ASSERT, and v.

Member Function Documentation

◆ at()

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

noexcept

Definition at line 700 of file lineshapemodel.cc.

Referenced by Absorption::LineMixing::SpeciesErrorCorrectedSuddenData::Omega(), and Absorption::LineMixing::SpeciesErrorCorrectedSuddenData::Q().

◆ dT()

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

noexcept

Definition at line 850 of file lineshapemodel.cc.

◆ dT0()

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

noexcept

Definition at line 882 of file lineshapemodel.cc.

◆ dX0()

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

noexcept

Definition at line 730 of file lineshapemodel.cc.

◆ dX1()

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

noexcept

Definition at line 760 of file lineshapemodel.cc.

◆ dX2()

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

noexcept

Definition at line 790 of file lineshapemodel.cc.

◆ dX3()

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

noexcept

Definition at line 820 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]	T	The temperature
[in]	var	The variable

Returns: The broadening parameter at temperature

Definition at line 193 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]	T	The temperature
[in]	var	The variable

Returns: The temperature derivative of the broadening parameter at temperature

Definition at line 208 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] T The temperature

Returns: The temperature derivative of the broadening parameter at temperature

Definition at line 222 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] T The temperature

Returns: The temperature derivative of the broadening parameter at temperature

Definition at line 234 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] T The temperature

Returns: The temperature derivative of the broadening parameter at temperature

Definition at line 248 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] T The temperature

Returns: The temperature derivative of the broadening parameter at temperature

Definition at line 262 of file lineshapemodel.h.

Friends And Related Function Documentation

◆ operator<<

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

friend

Definition at line 689 of file lineshapemodel.cc.

◆ operator>>

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

friend

Definition at line 695 of file lineshapemodel.cc.

Member Data Documentation

◆ N

constexpr Index LineShape::ModelParameters::N = 4

staticconstexpr

Definition at line 154 of file lineshapemodel.h.

Referenced by abs_linesLineShapeModelParametersMatchingLines(), Absorption::LineMixing::band_eigenvalue_adaptation(), LineShape::SingleSpeciesModel::dX(), and ecs_dataAddMeanAir().

◆ type

TemperatureModel LineShape::ModelParameters::type

Definition at line 156 of file lineshapemodel.h.

Referenced by abs_linesLineShapeModelParametersMatchingLines(), ecs_dataAddMeanAir(), and LineShape::modelparameters2metadata().

◆ X0

Numeric LineShape::ModelParameters::X0

Definition at line 157 of file lineshapemodel.h.

Referenced by abs_linesLineShapeModelParametersMatchingLines(), ecs_dataAddMeanAir(), LineShape::modelparameters2metadata(), lm_hitran_2017::read(), and LineShape::SingleModelParameter().

◆ X1

Numeric LineShape::ModelParameters::X1

Definition at line 158 of file lineshapemodel.h.

Referenced by abs_linesLineShapeModelParametersMatchingLines(), ecs_dataAddMeanAir(), LineShape::modelparameters2metadata(), and LineShape::SingleModelParameter().

◆ X2

Numeric LineShape::ModelParameters::X2

Definition at line 159 of file lineshapemodel.h.

Referenced by abs_linesLineShapeModelParametersMatchingLines(), ecs_dataAddMeanAir(), LineShape::modelparameters2metadata(), and LineShape::SingleModelParameter().

◆ X3

Numeric LineShape::ModelParameters::X3

Definition at line 160 of file lineshapemodel.h.

Referenced by abs_linesLineShapeModelParametersMatchingLines(), ecs_dataAddMeanAir(), LineShape::modelparameters2metadata(), and LineShape::SingleModelParameter().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ModelParameters() [1/2]

◆ ModelParameters() [2/2]

Member Function Documentation

◆ at()

◆ dT()

◆ dT0()

◆ dX0()

◆ dX1()

◆ dX2()

◆ dX3()

◆ special_linemixing_aer()

◆ special_linemixing_aer_dT()

◆ special_linemixing_aer_dX0()

◆ special_linemixing_aer_dX1()

◆ special_linemixing_aer_dX2()

◆ special_linemixing_aer_dX3()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ N

◆ type

◆ X0

◆ X1

◆ X2

◆ X3