ARTS  2.3.1285(git:92a29ea9-dirty)
Public Types | Public Member Functions | Private Attributes | List of all members
PressureBroadeningData Class Reference

This class should contain the data and metadata associated with pressure broadening. More...

#include <pressurebroadeningdata.h>

Public Types

enum  PB_Type : Index {
  PB_NONE, PB_AIR_BROADENING, PB_AIR_AND_WATER_BROADENING, PB_PLANETARY_BROADENING,
  PB_SD_AIR_VOLUME, PB_HTP_AIR_VOLUME, PB_VOIGT_TEST_WATER, PB_SD_TEST_WATER,
  PB_PURELY_FOR_TESTING
}
 
enum  TestParams : Index {
  TestParams::sg0 =0, TestParams::sn0, TestParams::sd0, TestParams::sm,
  TestParams::sA, TestParams::sg2, TestParams::sn2, TestParams::sd2,
  TestParams::ag0, TestParams::an0, TestParams::ad0, TestParams::am,
  TestParams::aA, TestParams::ag2, TestParams::an2, TestParams::ad2,
  TestParams::COUNT
}
 

Public Member Functions

 PressureBroadeningData ()
 
const PB_Type & Type () const
 
const ArrayOfVector & Data () const
 
const ArrayOfVector & DataError () const
 
void SetAirBroadeningFromCatalog (const Numeric &sgam, const Numeric &nself, const Numeric &agam, const Numeric &nair, const Numeric &air_pressure_DF, const Numeric &dsgam, const Numeric &dnself, const Numeric &dagam, const Numeric &dnair, const Numeric &dair_pressure_DF)
 The HITRAN air broadening scheme was used exclusively for a long time by ARTS. More...
 
void SetAirAndWaterBroadeningFromCatalog (const Numeric &sgam, const Numeric &sn, const Numeric &sdelta, const Numeric &agam, const Numeric &an, const Numeric &adelta, const Numeric &wgam, const Numeric &wn, const Numeric &wdelta)
 The HITRAN air broadening scheme was used exclusively for a long time by ARTS. More...
 
void SetPlanetaryBroadeningFromCatalog (const Numeric &sgam, const Numeric &nself, const Vector &foreign_gamma, const Vector &n_foreign, const Vector &foreign_pressure_DF)
 The ESA planetary study introduced species-dependent pressure broadenings. More...
 
void SetSDAirFromCatalog (const Numeric &gamma0, const Numeric &gamma0_exp, const Numeric &gamma2, const Numeric &gamma2_exp, const Numeric &delta0, const Numeric &delta0_exp, const Numeric &delta2, const Numeric &delta2_exp)
 TESTING. More...
 
void SetHTPAirFromCatalog (const Numeric &gamma0, const Numeric &gamma0_exp, const Numeric &gamma2, const Numeric &gamma2_exp, const Numeric &delta0, const Numeric &delta0_exp, const Numeric &delta2, const Numeric &delta2_exp, const Numeric &fvc, const Numeric &fvc_exp, const Numeric &eta, const Numeric &eta_exp)
 TESTING *. More...
 
void SetTestFromCatalog (const Numeric &gamma0_air, const Numeric &gamma0_air_exp, const Numeric &gamma0_water, const Numeric &gamma0_water_exp, const Numeric &gamma2_air, const Numeric &gamma2_water, const Numeric &delta0_air, const Numeric &delta0_water)
 TESTING. More...
 
void GetTestBroadening (Numeric &gamma0, Numeric &gamma2, Numeric &delta0, ConstVectorView vmrs, const Numeric &theta, const Numeric &pressure, const Index h2o_index) const
 
void SetInternalDerivatives (ComplexVector &derivatives, const ArrayOfRetrievalQuantity &ppd, const QuantumIdentifier &QI, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 Sets a vector of derivatives that fits with the QuantumIdentifier and partial derivative. More...
 
ConstVectorView PlanetaryGammaForeign () const
 
ConstVectorView PlanetaryNForeign () const
 
ConstVectorView PlanetaryDeltaForeign () const
 
Numeric PlanetaryGammaForeign (Index ii) const
 
Numeric PlanetaryNForeign (Index ii) const
 
Numeric PlanetaryDeltaForeign (Index ii) const
 
Numeric AirBroadeningAgam () const
 
Numeric AirBroadeningNair () const
 
Numeric AirBroadeningPsf () const
 
Numeric Sgam () const
 
Numeric Nself () const
 
Numeric AirBroadeningDAgam () const
 
Numeric AirBroadeningDNair () const
 
Numeric AirBroadeningDPsf () const
 
Numeric dSgam () const
 
Numeric dNself () const
 
void ChangeSelf (const Numeric &change, const Index this_species, const Index h2o_species, const ArrayOfIndex &broad_spec_locations)
 Method for changing self-broadening if available Error if not. More...
 
void ChangeSelfExponent (const Numeric &change, const Index this_species, const Index h2o_species, const ArrayOfIndex &broad_spec_locations)
 Method for changing self-broadening exponent if available Error if not. More...
 
void SetSelf (const Numeric &new_value, const Index this_species, const Index h2o_species, const ArrayOfIndex &broad_spec_locations)
 Method for setting self-broadening if available Error if not. More...
 
void SetSelfExponent (const Numeric &new_value, const Index this_species, const Index h2o_species, const ArrayOfIndex &broad_spec_locations)
 Method for setting self-broadening exponent if available Error if not. More...
 
void ChangeSelfRelative (const Numeric &change, const Index this_species, const Index h2o_species, const ArrayOfIndex &broad_spec_locations)
 Method for changing self-broadening by relative amount if available Error if not. More...
 
void ChangeSelfExponentRelative (const Numeric &change, const Index this_species, const Index h2o_species, const ArrayOfIndex &broad_spec_locations)
 Method for changing self-broadening exponent by relative amount if available Error if not. More...
 
void ChangeForeign (const Numeric &change, const ArrayOfIndex &broad_spec_locations)
 Method for changing foreing-broadening(s) if available Error if not available and no change to water broadening. More...
 
void ChangeForeignExponent (const Numeric &change, const ArrayOfIndex &broad_spec_locations)
 Method for changing foreing-broadening exponent(s) if available Error if not available and no change to water broadening. More...
 
void SetForeign (const Numeric &new_value, const ArrayOfIndex &broad_spec_locations)
 Method for setting foreing-broadening(s) if available Error if not available and no change to water broadening. More...
 
void SetForeignExponent (const Numeric &new_value, const ArrayOfIndex &broad_spec_locations)
 Method for setting foreing-broadening exponent(s) if available Error if not available and no change to water broadening. More...
 
void ChangeForeignRelative (const Numeric &change, const ArrayOfIndex &broad_spec_locations)
 Method for changing foreing-broadening(s) by relative amount if available Error if not available and no change to water broadening. More...
 
void ChangeForeignExponentRelative (const Numeric &change, const ArrayOfIndex &broad_spec_locations)
 Method for changing foreing-broadening exponent(s) by relative amount if available Error if not available and no change to water broadening. More...
 
void ChangeForeignShiftRelative (const Numeric &change, const ArrayOfIndex &broad_spec_locations)
 Method for changing foreing-broadening shift(s) by relative amount if available Error if not available and no change to water broadening. More...
 
void ChangeForeignShift (const Numeric &change, const ArrayOfIndex &broad_spec_locations)
 Method for changing foreing-broadening shift(s) if available Error if not available and no change to water broadening. More...
 
void GetAirBroadening (Numeric &gamma, Numeric &deltaf, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure) const
 Air broadening calculations. More...
 
void GetAirBroadening_dT (Numeric &dgamma_dT, Numeric &ddeltaf_dT, const Numeric &T, const Numeric &T0, const Numeric &pressure, const Numeric &self_pressure) const
 
void GetAirBroadening_dSelfGamma (Numeric &gamma_dSelf, const Numeric &theta, const Numeric &self_pressure) const
 
void GetAirBroadening_dForeignGamma (Numeric &gamma_dForeign, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure) const
 
void GetAirBroadening_dForeignPsf (Numeric &psf_dForeign, const Numeric &theta, const Numeric &pressure) const
 
void GetAirBroadening_dSelfExponent (Numeric &gamma_dSelfExponent, Numeric &psf_dSelfExponent, const Numeric &theta, const Numeric &self_pressure) const
 
void GetAirBroadening_dForeignExponent (Numeric &gamma_dForeignExponent, Numeric &psf_dForeignExponent, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure) const
 
void GetPressureBroadeningParams_dSelfVMR (Numeric &gamma_dvmr, Numeric &split_dvmr, const Numeric &theta, const Numeric &pressure) const
 
void GetAirAndWaterBroadening (Numeric &gamma, Numeric &deltaf, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 Air and water broadening calculations *. More...
 
void GetAirAndWaterBroadening_dT (Numeric &dgamma_dT, Numeric &ddeltaf_dT, const Numeric &T, const Numeric &T0, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetAirAndWaterBroadening_dSelfGamma (Numeric &dgamma_dSelf, const Numeric &theta, const Numeric &self_pressure) const
 
void GetAirAndWaterBroadening_dForeignGamma (Numeric &dgamma_dForeign, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetAirAndWaterBroadening_dWaterGamma (Numeric &gamma_dWater, const Numeric &theta, const Numeric &pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetAirAndWaterBroadening_dSelfPsf (Numeric &dpsf_dSelf, const Numeric &theta, const Numeric &self_pressure) const
 
void GetAirAndWaterBroadening_dForeignPsf (Numeric &dpsf_dForeign, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetAirAndWaterBroadening_dWaterPsf (Numeric &psf_dWater, const Numeric &theta, const Numeric &pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetAirAndWaterBroadening_dSelfExponent (Numeric &dgamma_dSelfExponent, Numeric &dpsf_dSelfExponent, const Numeric &theta, const Numeric &self_pressure) const
 
void GetAirAndWaterBroadening_dForeignExponent (Numeric &dgamma_dForeignExponent, Numeric &dpsf_dForeignExponent, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetAirAndWaterBroadening_dWaterExponent (Numeric &gamma_dWaterExponent, Numeric &psf_dWaterExponent, const Numeric &theta, const Numeric &pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetPlanetaryBroadening (Numeric &gamma, Numeric &deltaf, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const ArrayOfIndex &broad_spec_locations, ConstVectorView vmrs) const
 Planetary broadening calculations. More...
 
void GetPlanetaryBroadening_dT (Numeric &dgamma_dT, Numeric &ddeltaf_dT, const Numeric &T, const Numeric &T0, const Numeric &pressure, const Numeric &self_pressure, const ArrayOfIndex &broad_spec_locations, ConstVectorView vmrs) const
 
void GetPressureBroadeningParams (Numeric &gamma_0, Numeric &gamma_2, Numeric &eta, Numeric &df_0, Numeric &df_2, Numeric &f_VC, const Numeric &T, const Numeric &T0, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, const ArrayOfIndex &broad_spec_locations, ConstVectorView vmrs) const
 All broadening calculations are easiset to perform via these calls. More...
 
void GetPressureBroadeningParams_dT (Numeric &dgamma_0_dT, Numeric &dgamma_2_dT, Numeric &deta_dT, Numeric &ddf_0_dT, Numeric &ddf_2_dT, Numeric &df_VC_dT, const Numeric &T, const Numeric &T0, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, const ArrayOfIndex &broad_spec_locations, ConstVectorView vmrs) const
 
void GetPressureBroadeningParams_dSelfGamma (Numeric &gamma_dSelf, const Numeric &theta, const Numeric &self_pressure) const
 
void GetPressureBroadeningParams_dForeignGamma (Numeric &gamma_dForeign, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetPressureBroadeningParams_dWaterGamma (Numeric &gamma_dWater, const Numeric &theta, const Numeric &pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetPressureBroadeningParams_dSelfPsf (Numeric &psf_dSelf, const Numeric &theta, const Numeric &self_pressure) const
 
void GetPressureBroadeningParams_dForeignPsf (Numeric &psf_dForeign, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetPressureBroadeningParams_dWaterPsf (Numeric &psf_dWater, const Numeric &theta, const Numeric &pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetPressureBroadeningParams_dSelfExponent (Numeric &gamma_dSelfExponent, Numeric &psf_dSelfExponent, const Numeric &theta, const Numeric &self_pressure) const
 
void GetPressureBroadeningParams_dForeignExponent (Numeric &gamma_dForeignExponent, Numeric &psf_dForeignExponent, const Numeric &theta, const Numeric &pressure, const Numeric &self_pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetPressureBroadeningParams_dWaterExponent (Numeric &gamma_dWaterExponent, Numeric &psf_dWaterExponent, const Numeric &theta, const Numeric &pressure, const Index this_species, const Index h2o_species, ConstVectorView vmrs) const
 
void GetSDAirBroadening (Numeric &gamma0, Numeric &gamma2, Numeric &delta0, Numeric &delta2, const Numeric &theta, const Numeric &pressure) const
 Speed-dependent broadening calculations. More...
 
void GetSDAirBroadening_dT (Numeric &dgamma0, Numeric &dgamma2, Numeric &ddelta0, Numeric &ddelta2, const Numeric &T, const Numeric &T0, const Numeric &pressure) const
 
void GetHTPAirBroadening (Numeric &gamma0, Numeric &gamma2, Numeric &delta0, Numeric &delta2, Numeric &fvc, Numeric &eta, const Numeric &theta, const Numeric &pressure) const
 Speed-dependent broadening calculations. More...
 
void GetHTPAirBroadening_dT (Numeric &dgamma0, Numeric &dgamma2, Numeric &ddelta0, Numeric &ddelta2, Numeric &dfvc, Numeric &deta, const Numeric &T, const Numeric &T0, const Numeric &pressure) const
 
void StorageTag2SetType (const String &input)
 
void SetTypeFromIndex (const Index &type)
 
Index ExpectedVectorLengthFromType () const
 
void SetDataFromVectorWithKnownType (ConstVectorView input)
 
void GetVectorFromData (Vector &output) const
 
String Type2StorageTag () const
 

Private Attributes

PB_Type mtype
 
ArrayOfVector mdata
 
ArrayOfVector mdataerror
 

Detailed Description

This class should contain the data and metadata associated with pressure broadening.

The stored quantities are:

Parameters
mdatacontaining the structured data
mdataerrorcontaining the structured errors of the mdata input
mtypecontaining a tag for the type of data/the structure of the data

Definition at line 45 of file pressurebroadeningdata.h.

Member Enumeration Documentation

◆ PB_Type

enum PressureBroadeningData::PB_Type : Index
Enumerator
PB_NONE 
PB_AIR_BROADENING 
PB_AIR_AND_WATER_BROADENING 
PB_PLANETARY_BROADENING 
PB_SD_AIR_VOLUME 
PB_HTP_AIR_VOLUME 
PB_VOIGT_TEST_WATER 
PB_SD_TEST_WATER 
PB_PURELY_FOR_TESTING 

Definition at line 49 of file pressurebroadeningdata.h.

◆ TestParams

enum PressureBroadeningData::TestParams : Index
strong
Enumerator
sg0 
sn0 
sd0 
sm 
sA 
sg2 
sn2 
sd2 
ag0 
an0 
ad0 
am 
aA 
ag2 
an2 
ad2 
COUNT 

Definition at line 61 of file pressurebroadeningdata.h.

Constructor & Destructor Documentation

◆ PressureBroadeningData()

PressureBroadeningData::PressureBroadeningData ( )
inline

Definition at line 65 of file pressurebroadeningdata.h.

Member Function Documentation

◆ AirBroadeningAgam()

Numeric PressureBroadeningData::AirBroadeningAgam ( ) const
inline

Definition at line 232 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_AIR_BROADENING.

◆ AirBroadeningDAgam()

Numeric PressureBroadeningData::AirBroadeningDAgam ( ) const
inline

Definition at line 247 of file pressurebroadeningdata.h.

References mdataerror, mtype, and PB_AIR_BROADENING.

◆ AirBroadeningDNair()

Numeric PressureBroadeningData::AirBroadeningDNair ( ) const
inline

Definition at line 250 of file pressurebroadeningdata.h.

References mdataerror, mtype, and PB_AIR_BROADENING.

◆ AirBroadeningDPsf()

Numeric PressureBroadeningData::AirBroadeningDPsf ( ) const
inline

Definition at line 253 of file pressurebroadeningdata.h.

References mdataerror, mtype, and PB_AIR_BROADENING.

◆ AirBroadeningNair()

Numeric PressureBroadeningData::AirBroadeningNair ( ) const
inline

Definition at line 235 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_AIR_BROADENING.

◆ AirBroadeningPsf()

Numeric PressureBroadeningData::AirBroadeningPsf ( ) const
inline

Definition at line 238 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_AIR_BROADENING.

◆ ChangeForeign()

void PressureBroadeningData::ChangeForeign ( const Numeric &  change,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing foreing-broadening(s) if available Error if not available and no change to water broadening.

The quantities are:

Parameters
changeself broadening gamma
broad_spec_locationsArray of index of broadening species locations

Definition at line 1665 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeForeignExponent()

void PressureBroadeningData::ChangeForeignExponent ( const Numeric &  change,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing foreing-broadening exponent(s) if available Error if not available and no change to water broadening.

The quantities are:

Parameters
changeself broadening gamma
broad_spec_locationsArray of index of broadening species locations

Definition at line 1688 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeForeignExponentRelative()

void PressureBroadeningData::ChangeForeignExponentRelative ( const Numeric &  change,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing foreing-broadening exponent(s) by relative amount if available Error if not available and no change to water broadening.

The quantities are:

Parameters
changeself broadening gamma
broad_spec_locationsArray of index of broadening species locations

Definition at line 1780 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeForeignRelative()

void PressureBroadeningData::ChangeForeignRelative ( const Numeric &  change,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing foreing-broadening(s) by relative amount if available Error if not available and no change to water broadening.

The quantities are:

Parameters
changeself broadening gamma
broad_spec_locationsArray of index of broadening species locations

Definition at line 1757 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeForeignShift()

void PressureBroadeningData::ChangeForeignShift ( const Numeric &  change,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing foreing-broadening shift(s) if available Error if not available and no change to water broadening.

The quantities are:

Parameters
changeself broadening gamma
broad_spec_locationsArray of index of broadening species locations

Definition at line 1827 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeForeignShiftRelative()

void PressureBroadeningData::ChangeForeignShiftRelative ( const Numeric &  change,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing foreing-broadening shift(s) by relative amount if available Error if not available and no change to water broadening.

The quantities are:

Parameters
changeself broadening gamma
broad_spec_locationsArray of index of broadening species locations

Definition at line 1804 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeSelf()

void PressureBroadeningData::ChangeSelf ( const Numeric &  change,
const Index  this_species,
const Index  h2o_species,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing self-broadening if available Error if not.

The quantities are:

Parameters
changeself broadening gamma
this_speciesIndex for position this species
h2o_speciesIndex for position of h2o species
broad_spec_locationsArray of index of broadening species locations

Definition at line 1497 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeSelfExponent()

void PressureBroadeningData::ChangeSelfExponent ( const Numeric &  change,
const Index  this_species,
const Index  h2o_species,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing self-broadening exponent if available Error if not.

The quantities are:

Parameters
changeself broadening gamma
this_speciesIndex for position this species
h2o_speciesIndex for position of h2o species
broad_spec_locationsArray of index of broadening species locations

Definition at line 1525 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeSelfExponentRelative()

void PressureBroadeningData::ChangeSelfExponentRelative ( const Numeric &  change,
const Index  this_species,
const Index  h2o_species,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing self-broadening exponent by relative amount if available Error if not.

The quantities are:

Parameters
changeself broadening gamma
this_speciesIndex for position this species
h2o_speciesIndex for position of h2o species
broad_spec_locationsArray of index of broadening species locations

Definition at line 1637 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ ChangeSelfRelative()

void PressureBroadeningData::ChangeSelfRelative ( const Numeric &  change,
const Index  this_species,
const Index  h2o_species,
const ArrayOfIndex &  broad_spec_locations 
)

Method for changing self-broadening by relative amount if available Error if not.

The quantities are:

Parameters
changeself broadening gamma
this_speciesIndex for position this species
h2o_speciesIndex for position of h2o species
broad_spec_locationsArray of index of broadening species locations

Definition at line 1609 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ Data()

const ArrayOfVector& PressureBroadeningData::Data ( ) const
inline

Definition at line 69 of file pressurebroadeningdata.h.

References mdata.

◆ DataError()

const ArrayOfVector& PressureBroadeningData::DataError ( ) const
inline

Definition at line 70 of file pressurebroadeningdata.h.

References GetTestBroadening(), mdataerror, SetAirAndWaterBroadeningFromCatalog(), SetAirBroadeningFromCatalog(), SetHTPAirFromCatalog(), SetInternalDerivatives(), SetPlanetaryBroadeningFromCatalog(), SetSDAirFromCatalog(), SetTestFromCatalog(), and LineShape::vmrs().

◆ dNself()

Numeric PressureBroadeningData::dNself ( ) const
inline

Definition at line 259 of file pressurebroadeningdata.h.

References ChangeForeign(), ChangeForeignExponent(), ChangeForeignExponentRelative(), ChangeForeignRelative(), ChangeForeignShift(), ChangeForeignShiftRelative(), ChangeSelf(), ChangeSelfExponent(), ChangeSelfExponentRelative(), ChangeSelfRelative(), GetAirBroadening(), GetAirBroadening_dT(), mdataerror, mtype, PB_AIR_BROADENING, SetForeign(), SetForeignExponent(), SetSelf(), and SetSelfExponent().

◆ dSgam()

Numeric PressureBroadeningData::dSgam ( ) const
inline

Definition at line 256 of file pressurebroadeningdata.h.

References mdataerror, mtype, and PB_AIR_BROADENING.

◆ ExpectedVectorLengthFromType()

Index PressureBroadeningData::ExpectedVectorLengthFromType ( ) const

Definition at line 1855 of file pressurebroadeningdata.cc.

References COUNT, mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_HTP_AIR_VOLUME, PB_NONE, PB_PLANETARY_BROADENING, PB_PURELY_FOR_TESTING, PB_SD_AIR_VOLUME, PB_SD_TEST_WATER, and PB_VOIGT_TEST_WATER.

Referenced by GetVectorFromData(), SetDataFromVectorWithKnownType(), and SetTypeFromIndex().

◆ GetAirAndWaterBroadening()

void PressureBroadeningData::GetAirAndWaterBroadening ( Numeric &  gamma,
Numeric &  deltaf,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Air and water broadening calculations *.

The quantities are:

Parameters
gammathe pressure broadening in Hz
deltafthe pressure shift in Hz
thetathe scaled temperature (T0/T)
pressureAll gasses, in Pa
self_pressurepressure of the molecule of the line
verbosityoutput command used for warnings.

Definition at line 707 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams().

◆ GetAirAndWaterBroadening_dForeignExponent()

void PressureBroadeningData::GetAirAndWaterBroadening_dForeignExponent ( Numeric &  dgamma_dForeignExponent,
Numeric &  dpsf_dForeignExponent,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 895 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dForeignExponent().

◆ GetAirAndWaterBroadening_dForeignGamma()

void PressureBroadeningData::GetAirAndWaterBroadening_dForeignGamma ( Numeric &  dgamma_dForeign,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 806 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dForeignGamma().

◆ GetAirAndWaterBroadening_dForeignPsf()

void PressureBroadeningData::GetAirAndWaterBroadening_dForeignPsf ( Numeric &  dpsf_dForeign,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 849 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dForeignPsf().

◆ GetAirAndWaterBroadening_dSelfExponent()

void PressureBroadeningData::GetAirAndWaterBroadening_dSelfExponent ( Numeric &  dgamma_dSelfExponent,
Numeric &  dpsf_dSelfExponent,
const Numeric &  theta,
const Numeric &  self_pressure 
) const

Definition at line 884 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dSelfExponent().

◆ GetAirAndWaterBroadening_dSelfGamma()

void PressureBroadeningData::GetAirAndWaterBroadening_dSelfGamma ( Numeric &  dgamma_dSelf,
const Numeric &  theta,
const Numeric &  self_pressure 
) const

Definition at line 798 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dSelfGamma().

◆ GetAirAndWaterBroadening_dSelfPsf()

void PressureBroadeningData::GetAirAndWaterBroadening_dSelfPsf ( Numeric &  dpsf_dSelf,
const Numeric &  theta,
const Numeric &  self_pressure 
) const

Definition at line 841 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dSelfPsf().

◆ GetAirAndWaterBroadening_dT()

void PressureBroadeningData::GetAirAndWaterBroadening_dT ( Numeric &  dgamma_dT,
Numeric &  ddeltaf_dT,
const Numeric &  T,
const Numeric &  T0,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 751 of file pressurebroadeningdata.cc.

◆ GetAirAndWaterBroadening_dWaterExponent()

void PressureBroadeningData::GetAirAndWaterBroadening_dWaterExponent ( Numeric &  gamma_dWaterExponent,
Numeric &  psf_dWaterExponent,
const Numeric &  theta,
const Numeric &  pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 918 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dWaterExponent().

◆ GetAirAndWaterBroadening_dWaterGamma()

void PressureBroadeningData::GetAirAndWaterBroadening_dWaterGamma ( Numeric &  gamma_dWater,
const Numeric &  theta,
const Numeric &  pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 821 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dWaterGamma().

◆ GetAirAndWaterBroadening_dWaterPsf()

void PressureBroadeningData::GetAirAndWaterBroadening_dWaterPsf ( Numeric &  psf_dWater,
const Numeric &  theta,
const Numeric &  pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 864 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dWaterPsf().

◆ GetAirBroadening()

void PressureBroadeningData::GetAirBroadening ( Numeric &  gamma,
Numeric &  deltaf,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure 
) const

Air broadening calculations.

The quantities are:

Parameters
gammathe pressure broadening in Hz
deltafthe pressure shift in Hz
thetathe scaled temperature (T0/T)
pressureAll gasses, in Pa
self_pressurepressure of the molecule the line belongs to

Definition at line 619 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by dNself(), and GetPressureBroadeningParams().

◆ GetAirBroadening_dForeignExponent()

void PressureBroadeningData::GetAirBroadening_dForeignExponent ( Numeric &  gamma_dForeignExponent,
Numeric &  psf_dForeignExponent,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure 
) const

Definition at line 690 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dForeignExponent().

◆ GetAirBroadening_dForeignGamma()

void PressureBroadeningData::GetAirBroadening_dForeignGamma ( Numeric &  gamma_dForeign,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure 
) const

Definition at line 662 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dForeignGamma().

◆ GetAirBroadening_dForeignPsf()

void PressureBroadeningData::GetAirBroadening_dForeignPsf ( Numeric &  psf_dForeign,
const Numeric &  theta,
const Numeric &  pressure 
) const

Definition at line 671 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dForeignPsf().

◆ GetAirBroadening_dSelfExponent()

void PressureBroadeningData::GetAirBroadening_dSelfExponent ( Numeric &  gamma_dSelfExponent,
Numeric &  psf_dSelfExponent,
const Numeric &  theta,
const Numeric &  self_pressure 
) const

Definition at line 679 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dSelfExponent().

◆ GetAirBroadening_dSelfGamma()

void PressureBroadeningData::GetAirBroadening_dSelfGamma ( Numeric &  gamma_dSelf,
const Numeric &  theta,
const Numeric &  self_pressure 
) const

Definition at line 654 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams_dSelfGamma().

◆ GetAirBroadening_dT()

void PressureBroadeningData::GetAirBroadening_dT ( Numeric &  dgamma_dT,
Numeric &  ddeltaf_dT,
const Numeric &  T,
const Numeric &  T0,
const Numeric &  pressure,
const Numeric &  self_pressure 
) const

Definition at line 634 of file pressurebroadeningdata.cc.

Referenced by dNself().

◆ GetHTPAirBroadening()

void PressureBroadeningData::GetHTPAirBroadening ( Numeric &  gamma0,
Numeric &  gamma2,
Numeric &  delta0,
Numeric &  delta2,
Numeric &  fvc,
Numeric &  eta,
const Numeric &  theta,
const Numeric &  pressure 
) const

Speed-dependent broadening calculations.

THIS IS EXPERIMENTAL AND MUST BE FIXED TO HAVE, e.g., SELF-PRESSURE BEFORE IT IS READY FOR NORMAL USE.

The quantities are:

Parameters
gamma0the pressure broadening
gamma2the speed dependent term of the pressure broadening
delta0the pressure shift
delta2the speed dependent term of the pressure shift
fvc
eta
thetathe scaled temperature (T0/T)
pressureAll gasses, in Pa

Definition at line 1212 of file pressurebroadeningdata.cc.

References mdata, and pow().

◆ GetHTPAirBroadening_dT()

void PressureBroadeningData::GetHTPAirBroadening_dT ( Numeric &  dgamma0,
Numeric &  dgamma2,
Numeric &  ddelta0,
Numeric &  ddelta2,
Numeric &  dfvc,
Numeric &  deta,
const Numeric &  T,
const Numeric &  T0,
const Numeric &  pressure 
) const

Definition at line 1236 of file pressurebroadeningdata.cc.

◆ GetPlanetaryBroadening()

void PressureBroadeningData::GetPlanetaryBroadening ( Numeric &  gamma,
Numeric &  deltaf,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const ArrayOfIndex &  broad_spec_locations,
ConstVectorView  vmrs 
) const

Planetary broadening calculations.

The quantities are:

Parameters
gammathe pressure broadening in Hz
deltafthe pressure shift in Hz
thetathe scaled temperature (T0/T)
pressureAll gasses, in Pa
self_pressurepressure of the molecule the line belongs to
this_specieslocation of this species in broad_spec_locations and vmrs
broad_spec_locationslocation of species that broadens the line in vmrs
vmrsvolume mixing ratio of all species
verbosityoutput command used for warnings.

Definition at line 949 of file pressurebroadeningdata.cc.

Referenced by GetPressureBroadeningParams().

◆ GetPlanetaryBroadening_dT()

void PressureBroadeningData::GetPlanetaryBroadening_dT ( Numeric &  dgamma_dT,
Numeric &  ddeltaf_dT,
const Numeric &  T,
const Numeric &  T0,
const Numeric &  pressure,
const Numeric &  self_pressure,
const ArrayOfIndex &  broad_spec_locations,
ConstVectorView  vmrs 
) const

Definition at line 1055 of file pressurebroadeningdata.cc.

◆ GetPressureBroadeningParams()

void PressureBroadeningData::GetPressureBroadeningParams ( Numeric &  gamma_0,
Numeric &  gamma_2,
Numeric &  eta,
Numeric &  df_0,
Numeric &  df_2,
Numeric &  f_VC,
const Numeric &  T,
const Numeric &  T0,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
const ArrayOfIndex &  broad_spec_locations,
ConstVectorView  vmrs 
) const

All broadening calculations are easiset to perform via these calls.

If specific derivative is not available, then there will be an error

The quantities are:

Parameters
gammathe pressure broadening in Hz
deltafthe pressure shift in Hz
thetathe scaled temperature (T0/T)
pressureAll gasses, in Pa
self_pressurepressure of the molecule the line belongs to
this_specieslocation of this species in broad_spec_locations and vmrs
broad_spec_locationslocation of species that broadens the line in vmrs
vmrsvolume mixing ratio of all species
verbosityoutput command used for warnings.

Definition at line 77 of file pressurebroadeningdata.cc.

References aA, ad0, ad2, ag0, ag2, am, an0, an2, GetAirAndWaterBroadening(), GetAirBroadening(), GetPlanetaryBroadening(), GetSDAirBroadening(), GetTestBroadening(), mdata, mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_HTP_AIR_VOLUME, PB_NONE, PB_PLANETARY_BROADENING, PB_PURELY_FOR_TESTING, PB_SD_AIR_VOLUME, PB_SD_TEST_WATER, PB_VOIGT_TEST_WATER, sA, sd0, sd2, sg0, sg2, sm, sn0, sn2, speed_dependent_test_params(), and voigt_test_params().

◆ GetPressureBroadeningParams_dForeignExponent()

void PressureBroadeningData::GetPressureBroadeningParams_dForeignExponent ( Numeric &  gamma_dForeignExponent,
Numeric &  psf_dForeignExponent,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 522 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dForeignExponent(), GetAirBroadening_dForeignExponent(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetPressureBroadeningParams_dForeignGamma()

void PressureBroadeningData::GetPressureBroadeningParams_dForeignGamma ( Numeric &  gamma_dForeign,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 349 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dForeignGamma(), GetAirBroadening_dForeignGamma(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetPressureBroadeningParams_dForeignPsf()

void PressureBroadeningData::GetPressureBroadeningParams_dForeignPsf ( Numeric &  psf_dForeign,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 435 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dForeignPsf(), GetAirBroadening_dForeignPsf(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetPressureBroadeningParams_dSelfExponent()

void PressureBroadeningData::GetPressureBroadeningParams_dSelfExponent ( Numeric &  gamma_dSelfExponent,
Numeric &  psf_dSelfExponent,
const Numeric &  theta,
const Numeric &  self_pressure 
) const

Definition at line 495 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dSelfExponent(), GetAirBroadening_dSelfExponent(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetPressureBroadeningParams_dSelfGamma()

void PressureBroadeningData::GetPressureBroadeningParams_dSelfGamma ( Numeric &  gamma_dSelf,
const Numeric &  theta,
const Numeric &  self_pressure 
) const

Definition at line 324 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dSelfGamma(), GetAirBroadening_dSelfGamma(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetPressureBroadeningParams_dSelfPsf()

void PressureBroadeningData::GetPressureBroadeningParams_dSelfPsf ( Numeric &  psf_dSelf,
const Numeric &  theta,
const Numeric &  self_pressure 
) const

Definition at line 409 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dSelfPsf(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetPressureBroadeningParams_dSelfVMR()

void PressureBroadeningData::GetPressureBroadeningParams_dSelfVMR ( Numeric &  gamma_dvmr,
Numeric &  split_dvmr,
const Numeric &  theta,
const Numeric &  pressure 
) const

Definition at line 587 of file pressurebroadeningdata.cc.

References mdata, mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, PB_PLANETARY_BROADENING, and pow().

◆ GetPressureBroadeningParams_dT()

void PressureBroadeningData::GetPressureBroadeningParams_dT ( Numeric &  dgamma_0_dT,
Numeric &  dgamma_2_dT,
Numeric &  deta_dT,
Numeric &  ddf_0_dT,
Numeric &  ddf_2_dT,
Numeric &  df_VC_dT,
const Numeric &  T,
const Numeric &  T0,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
const ArrayOfIndex &  broad_spec_locations,
ConstVectorView  vmrs 
) const

Definition at line 142 of file pressurebroadeningdata.cc.

◆ GetPressureBroadeningParams_dWaterExponent()

void PressureBroadeningData::GetPressureBroadeningParams_dWaterExponent ( Numeric &  gamma_dWaterExponent,
Numeric &  psf_dWaterExponent,
const Numeric &  theta,
const Numeric &  pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 555 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dWaterExponent(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetPressureBroadeningParams_dWaterGamma()

void PressureBroadeningData::GetPressureBroadeningParams_dWaterGamma ( Numeric &  gamma_dWater,
const Numeric &  theta,
const Numeric &  pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 379 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dWaterGamma(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetPressureBroadeningParams_dWaterPsf()

void PressureBroadeningData::GetPressureBroadeningParams_dWaterPsf ( Numeric &  psf_dWater,
const Numeric &  theta,
const Numeric &  pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Definition at line 465 of file pressurebroadeningdata.cc.

References GetAirAndWaterBroadening_dWaterPsf(), mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

◆ GetSDAirBroadening()

void PressureBroadeningData::GetSDAirBroadening ( Numeric &  gamma0,
Numeric &  gamma2,
Numeric &  delta0,
Numeric &  delta2,
const Numeric &  theta,
const Numeric &  pressure 
) const

Speed-dependent broadening calculations.

THIS IS EXPERIMENTAL AND MUST BE FIXED TO HAVE, e.g., SELF-PRESSURE BEFORE IT IS READY FOR NORMAL USE.

The quantities are:

Parameters
gamma0the pressure broadening
gamma2the speed dependent term of the pressure broadening
delta0the pressure shift
delta2the speed dependent term of the pressure shift
thetathe scaled temperature (T0/T)
pressureAll gasses, in Pa

Definition at line 1169 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by GetPressureBroadeningParams().

◆ GetSDAirBroadening_dT()

void PressureBroadeningData::GetSDAirBroadening_dT ( Numeric &  dgamma0,
Numeric &  dgamma2,
Numeric &  ddelta0,
Numeric &  ddelta2,
const Numeric &  T,
const Numeric &  T0,
const Numeric &  pressure 
) const

Definition at line 1186 of file pressurebroadeningdata.cc.

◆ GetTestBroadening()

void PressureBroadeningData::GetTestBroadening ( Numeric &  gamma0,
Numeric &  gamma2,
Numeric &  delta0,
ConstVectorView  vmrs,
const Numeric &  theta,
const Numeric &  pressure,
const Index  h2o_index 
) const

Definition at line 1266 of file pressurebroadeningdata.cc.

References mdata, and pow().

Referenced by DataError(), and GetPressureBroadeningParams().

◆ GetVectorFromData()

void PressureBroadeningData::GetVectorFromData ( Vector &  output) const

Definition at line 1938 of file pressurebroadeningdata.cc.

References ExpectedVectorLengthFromType(), i, mdata, mdataerror, mtype, n, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_HTP_AIR_VOLUME, PB_NONE, PB_PLANETARY_BROADENING, PB_PURELY_FOR_TESTING, PB_SD_AIR_VOLUME, PB_SD_TEST_WATER, PB_VOIGT_TEST_WATER, and Vector::resize().

Referenced by SetTypeFromIndex().

◆ Nself()

Numeric PressureBroadeningData::Nself ( ) const
inline

Definition at line 244 of file pressurebroadeningdata.h.

References mdata, Array< base >::nelem(), and Absorption::nelem().

◆ PlanetaryDeltaForeign() [1/2]

ConstVectorView PressureBroadeningData::PlanetaryDeltaForeign ( ) const
inline

Definition at line 220 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_PLANETARY_BROADENING.

◆ PlanetaryDeltaForeign() [2/2]

Numeric PressureBroadeningData::PlanetaryDeltaForeign ( Index  ii) const
inline

Definition at line 229 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_PLANETARY_BROADENING.

◆ PlanetaryGammaForeign() [1/2]

ConstVectorView PressureBroadeningData::PlanetaryGammaForeign ( ) const
inline

Definition at line 214 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_PLANETARY_BROADENING.

◆ PlanetaryGammaForeign() [2/2]

Numeric PressureBroadeningData::PlanetaryGammaForeign ( Index  ii) const
inline

Definition at line 223 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_PLANETARY_BROADENING.

◆ PlanetaryNForeign() [1/2]

ConstVectorView PressureBroadeningData::PlanetaryNForeign ( ) const
inline

Definition at line 217 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_PLANETARY_BROADENING.

◆ PlanetaryNForeign() [2/2]

Numeric PressureBroadeningData::PlanetaryNForeign ( Index  ii) const
inline

Definition at line 226 of file pressurebroadeningdata.h.

References mdata, mtype, and PB_PLANETARY_BROADENING.

◆ SetAirAndWaterBroadeningFromCatalog()

void PressureBroadeningData::SetAirAndWaterBroadeningFromCatalog ( const Numeric &  sgam,
const Numeric &  sn,
const Numeric &  sdelta,
const Numeric &  agam,
const Numeric &  an,
const Numeric &  adelta,
const Numeric &  wgam,
const Numeric &  wn,
const Numeric &  wdelta 
)

The HITRAN air broadening scheme was used exclusively for a long time by ARTS.

This function follows that scheme and ARTSCAT-3, but also adds water broadening. Since it is new, we skip mdataerror usage for now.

The quantities are:

Parameters
sgamself broadening gamma
snself broadening n
sdeltaself shift
agamair broadening gamma
anair broadening n
adeltaair shift
wgamwater broadening gamma
wnwater broadening n
wdeltawater shift

Definition at line 1333 of file pressurebroadeningdata.cc.

References mdata, mdataerror, mtype, and PB_AIR_AND_WATER_BROADENING.

Referenced by DataError(), and SetDataFromVectorWithKnownType().

◆ SetAirBroadeningFromCatalog()

void PressureBroadeningData::SetAirBroadeningFromCatalog ( const Numeric &  sgam,
const Numeric &  nself,
const Numeric &  agam,
const Numeric &  nair,
const Numeric &  air_pressure_DF,
const Numeric &  dsgam,
const Numeric &  dnself,
const Numeric &  dagam,
const Numeric &  dnair,
const Numeric &  dair_pressure_DF 
)

The HITRAN air broadening scheme was used exclusively for a long time by ARTS.

This function follows that scheme and ARTSCAT-3

The quantities are:

Parameters
sgamself broadening gamma
nselfself broadening n
agamair broadening gamma
nairair broadening n
air_pressure_DFair broadening pressure-based frequency shift
d*variable associated errors. A tag of -1 is used when the errors are unknown.

Definition at line 1299 of file pressurebroadeningdata.cc.

References mdata, mdataerror, mtype, and PB_AIR_BROADENING.

Referenced by DataError(), and SetDataFromVectorWithKnownType().

◆ SetDataFromVectorWithKnownType()

void PressureBroadeningData::SetDataFromVectorWithKnownType ( ConstVectorView  input)

Definition at line 1878 of file pressurebroadeningdata.cc.

References ExpectedVectorLengthFromType(), mdata, mdataerror, mtype, ConstVectorView::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_HTP_AIR_VOLUME, PB_NONE, PB_PLANETARY_BROADENING, PB_PURELY_FOR_TESTING, PB_SD_AIR_VOLUME, PB_SD_TEST_WATER, PB_VOIGT_TEST_WATER, SetAirAndWaterBroadeningFromCatalog(), SetAirBroadeningFromCatalog(), SetHTPAirFromCatalog(), SetPlanetaryBroadeningFromCatalog(), and SetSDAirFromCatalog().

Referenced by SetTypeFromIndex().

◆ SetForeign()

void PressureBroadeningData::SetForeign ( const Numeric &  new_value,
const ArrayOfIndex &  broad_spec_locations 
)

Method for setting foreing-broadening(s) if available Error if not available and no change to water broadening.

The quantities are:

Parameters
changeself broadening gamma
broad_spec_locationsArray of index of broadening species locations

Definition at line 1711 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ SetForeignExponent()

void PressureBroadeningData::SetForeignExponent ( const Numeric &  new_value,
const ArrayOfIndex &  broad_spec_locations 
)

Method for setting foreing-broadening exponent(s) if available Error if not available and no change to water broadening.

The quantities are:

Parameters
changeself broadening gamma
broad_spec_locationsArray of index of broadening species locations

Definition at line 1734 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ SetHTPAirFromCatalog()

void PressureBroadeningData::SetHTPAirFromCatalog ( const Numeric &  gamma0,
const Numeric &  gamma0_exp,
const Numeric &  gamma2,
const Numeric &  gamma2_exp,
const Numeric &  delta0,
const Numeric &  delta0_exp,
const Numeric &  delta2,
const Numeric &  delta2_exp,
const Numeric &  fvc,
const Numeric &  fvc_exp,
const Numeric &  eta,
const Numeric &  eta_exp 
)

TESTING *.

The quantities are: TESTING

Definition at line 1421 of file pressurebroadeningdata.cc.

References mdata, mdataerror, mtype, and PB_HTP_AIR_VOLUME.

Referenced by DataError(), and SetDataFromVectorWithKnownType().

◆ SetInternalDerivatives()

void PressureBroadeningData::SetInternalDerivatives ( ComplexVector &  derivatives,
const ArrayOfRetrievalQuantity &  ppd,
const QuantumIdentifier &  QI,
const Numeric &  theta,
const Numeric &  pressure,
const Numeric &  self_pressure,
const Index  this_species,
const Index  h2o_species,
ConstVectorView  vmrs 
) const

Sets a vector of derivatives that fits with the QuantumIdentifier and partial derivative.

Definition at line 184 of file pressurebroadeningdata.cc.

Referenced by DataError().

◆ SetPlanetaryBroadeningFromCatalog()

void PressureBroadeningData::SetPlanetaryBroadeningFromCatalog ( const Numeric &  sgam,
const Numeric &  nself,
const Vector &  foreign_gamma,
const Vector &  n_foreign,
const Vector &  foreign_pressure_DF 
)

The ESA planetary study introduced species-dependent pressure broadenings.

This function can read ARTSCAT-4 line data

The quantities are:

Parameters
sgamself broadening gamma
nselfself broadening n
foreign_gammaforeign broadening gamma
n_foreignforeign broadening n
foreign_pressure_DFforeign broadening pressure-based frequency shift

Definition at line 1365 of file pressurebroadeningdata.cc.

References mdata, mdataerror, mtype, ConstVectorView::nelem(), and PB_PLANETARY_BROADENING.

Referenced by DataError(), and SetDataFromVectorWithKnownType().

◆ SetSDAirFromCatalog()

void PressureBroadeningData::SetSDAirFromCatalog ( const Numeric &  gamma0,
const Numeric &  gamma0_exp,
const Numeric &  gamma2,
const Numeric &  gamma2_exp,
const Numeric &  delta0,
const Numeric &  delta0_exp,
const Numeric &  delta2,
const Numeric &  delta2_exp 
)

TESTING.

The quantities are: TESTING

Definition at line 1390 of file pressurebroadeningdata.cc.

References mdata, mdataerror, mtype, and PB_SD_AIR_VOLUME.

Referenced by DataError(), and SetDataFromVectorWithKnownType().

◆ SetSelf()

void PressureBroadeningData::SetSelf ( const Numeric &  new_value,
const Index  this_species,
const Index  h2o_species,
const ArrayOfIndex &  broad_spec_locations 
)

Method for setting self-broadening if available Error if not.

The quantities are:

Parameters
changeself broadening gamma
this_speciesIndex for position this species
h2o_speciesIndex for position of h2o species
broad_spec_locationsArray of index of broadening species locations

Definition at line 1553 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ SetSelfExponent()

void PressureBroadeningData::SetSelfExponent ( const Numeric &  new_value,
const Index  this_species,
const Index  h2o_species,
const ArrayOfIndex &  broad_spec_locations 
)

Method for setting self-broadening exponent if available Error if not.

The quantities are:

Parameters
changeself broadening gamma
this_speciesIndex for position this species
h2o_speciesIndex for position of h2o species
broad_spec_locationsArray of index of broadening species locations

Definition at line 1581 of file pressurebroadeningdata.cc.

References mdata, mtype, Array< base >::nelem(), PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_NONE, and PB_PLANETARY_BROADENING.

Referenced by dNself().

◆ SetTestFromCatalog()

void PressureBroadeningData::SetTestFromCatalog ( const Numeric &  gamma0_air,
const Numeric &  gamma0_air_exp,
const Numeric &  gamma0_water,
const Numeric &  gamma0_water_exp,
const Numeric &  gamma2_air,
const Numeric &  gamma2_water,
const Numeric &  delta0_air,
const Numeric &  delta0_water 
)

TESTING.

The quantities are: TESTING

Definition at line 1462 of file pressurebroadeningdata.cc.

References mdata, mdataerror, mtype, and PB_PURELY_FOR_TESTING.

Referenced by DataError().

◆ SetTypeFromIndex()

void PressureBroadeningData::SetTypeFromIndex ( const Index &  type)
inline

Definition at line 757 of file pressurebroadeningdata.h.

References ExpectedVectorLengthFromType(), GetVectorFromData(), mtype, SetDataFromVectorWithKnownType(), and Type2StorageTag().

◆ Sgam()

Numeric PressureBroadeningData::Sgam ( ) const
inline

Definition at line 241 of file pressurebroadeningdata.h.

References mdata, Array< base >::nelem(), and Absorption::nelem().

◆ StorageTag2SetType()

void PressureBroadeningData::StorageTag2SetType ( const String &  input)

Definition at line 1914 of file pressurebroadeningdata.cc.

References mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_HTP_AIR_VOLUME, PB_NONE, PB_PLANETARY_BROADENING, PB_PURELY_FOR_TESTING, PB_SD_AIR_VOLUME, PB_SD_TEST_WATER, and PB_VOIGT_TEST_WATER.

◆ Type()

const PB_Type& PressureBroadeningData::Type ( ) const
inline

Definition at line 68 of file pressurebroadeningdata.h.

References mtype.

◆ Type2StorageTag()

String PressureBroadeningData::Type2StorageTag ( ) const

Definition at line 1997 of file pressurebroadeningdata.cc.

References mtype, PB_AIR_AND_WATER_BROADENING, PB_AIR_BROADENING, PB_HTP_AIR_VOLUME, PB_NONE, PB_PLANETARY_BROADENING, PB_PURELY_FOR_TESTING, PB_SD_AIR_VOLUME, PB_SD_TEST_WATER, and PB_VOIGT_TEST_WATER.

Referenced by SetTypeFromIndex().

Member Data Documentation

◆ mdata

ArrayOfVector PressureBroadeningData::mdata
private

Definition at line 775 of file pressurebroadeningdata.h.

Referenced by AirBroadeningAgam(), AirBroadeningNair(), AirBroadeningPsf(), ChangeForeign(), ChangeForeignExponent(), ChangeForeignExponentRelative(), ChangeForeignRelative(), ChangeForeignShift(), ChangeForeignShiftRelative(), ChangeSelf(), ChangeSelfExponent(), ChangeSelfExponentRelative(), ChangeSelfRelative(), Data(), GetAirAndWaterBroadening(), GetAirAndWaterBroadening_dForeignExponent(), GetAirAndWaterBroadening_dForeignGamma(), GetAirAndWaterBroadening_dForeignPsf(), GetAirAndWaterBroadening_dSelfExponent(), GetAirAndWaterBroadening_dSelfGamma(), GetAirAndWaterBroadening_dSelfPsf(), GetAirAndWaterBroadening_dWaterExponent(), GetAirAndWaterBroadening_dWaterGamma(), GetAirAndWaterBroadening_dWaterPsf(), GetAirBroadening(), GetAirBroadening_dForeignExponent(), GetAirBroadening_dForeignGamma(), GetAirBroadening_dForeignPsf(), GetAirBroadening_dSelfExponent(), GetAirBroadening_dSelfGamma(), GetHTPAirBroadening(), GetPressureBroadeningParams(), GetPressureBroadeningParams_dSelfVMR(), GetSDAirBroadening(), GetTestBroadening(), GetVectorFromData(), Nself(), PlanetaryDeltaForeign(), PlanetaryGammaForeign(), PlanetaryNForeign(), SetAirAndWaterBroadeningFromCatalog(), SetAirBroadeningFromCatalog(), SetDataFromVectorWithKnownType(), SetForeign(), SetForeignExponent(), SetHTPAirFromCatalog(), SetPlanetaryBroadeningFromCatalog(), SetSDAirFromCatalog(), SetSelf(), SetSelfExponent(), SetTestFromCatalog(), and Sgam().

◆ mdataerror

ArrayOfVector PressureBroadeningData::mdataerror
private

Definition at line 776 of file pressurebroadeningdata.h.

Referenced by AirBroadeningDAgam(), AirBroadeningDNair(), AirBroadeningDPsf(), DataError(), dNself(), dSgam(), GetVectorFromData(), SetAirAndWaterBroadeningFromCatalog(), SetAirBroadeningFromCatalog(), SetDataFromVectorWithKnownType(), SetHTPAirFromCatalog(), SetPlanetaryBroadeningFromCatalog(), SetSDAirFromCatalog(), and SetTestFromCatalog().

◆ mtype

PB_Type PressureBroadeningData::mtype
private

Definition at line 774 of file pressurebroadeningdata.h.

Referenced by AirBroadeningAgam(), AirBroadeningDAgam(), AirBroadeningDNair(), AirBroadeningDPsf(), AirBroadeningNair(), AirBroadeningPsf(), ChangeForeign(), ChangeForeignExponent(), ChangeForeignExponentRelative(), ChangeForeignRelative(), ChangeForeignShift(), ChangeForeignShiftRelative(), ChangeSelf(), ChangeSelfExponent(), ChangeSelfExponentRelative(), ChangeSelfRelative(), dNself(), dSgam(), ExpectedVectorLengthFromType(), GetPressureBroadeningParams(), GetPressureBroadeningParams_dForeignExponent(), GetPressureBroadeningParams_dForeignGamma(), GetPressureBroadeningParams_dForeignPsf(), GetPressureBroadeningParams_dSelfExponent(), GetPressureBroadeningParams_dSelfGamma(), GetPressureBroadeningParams_dSelfPsf(), GetPressureBroadeningParams_dSelfVMR(), GetPressureBroadeningParams_dWaterExponent(), GetPressureBroadeningParams_dWaterGamma(), GetPressureBroadeningParams_dWaterPsf(), GetVectorFromData(), PlanetaryDeltaForeign(), PlanetaryGammaForeign(), PlanetaryNForeign(), SetAirAndWaterBroadeningFromCatalog(), SetAirBroadeningFromCatalog(), SetDataFromVectorWithKnownType(), SetForeign(), SetForeignExponent(), SetHTPAirFromCatalog(), SetPlanetaryBroadeningFromCatalog(), SetSDAirFromCatalog(), SetSelf(), SetSelfExponent(), SetTestFromCatalog(), SetTypeFromIndex(), StorageTag2SetType(), Type(), and Type2StorageTag().

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