ARTS 2.5.4 (git: 31ce4f0e)
m_abs_lookup.cc File Reference

Methods related to absorption, lookup table, etc. More...

#include <algorithm>
#include <cmath>
#include <limits>
#include <map>
#include "absorption.h"
#include "agenda_class.h"
#include "arts.h"
#include "arts_omp.h"
#include "auto_md.h"
#include "check_input.h"
#include "cloudbox.h"
#include "debug.h"
#include "gas_abs_lookup.h"
#include "global_data.h"
#include "gridded_fields.h"
#include "interpolation_lagrange.h"
#include "math_funcs.h"
#include "matpackI.h"
#include "matpackV.h"
#include "messages.h"
#include "physics_funcs.h"
#include "propagationmatrix.h"
#include "rng.h"

Go to the source code of this file.

Functions

void abs_lookupInit (GasAbsLookup &x, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lookupInit. More...
 
void abs_lookupCalc (Workspace &ws, GasAbsLookup &abs_lookup, Index &abs_lookup_is_adapted, const ArrayOfArrayOfSpeciesTag &abs_species, const ArrayOfArrayOfSpeciesTag &abs_nls, const Vector &f_grid, const Vector &abs_p, const Matrix &abs_vmrs, const Vector &abs_t, const Vector &abs_t_pert, const Vector &abs_nls_pert, const Agenda &propmat_clearsky_agenda, const Numeric &lowest_vmr, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lookupCalc. More...
 
void find_nonlinear_continua (ArrayOfIndex &cont, const ArrayOfArrayOfSpeciesTag &abs_species, const Verbosity &verbosity)
 Find continuum species in abs_species. More...
 
void choose_abs_nls (ArrayOfArrayOfSpeciesTag &abs_nls, const ArrayOfArrayOfSpeciesTag &abs_species, const Verbosity &verbosity)
 Choose species for abs_nls. More...
 
void choose_abs_t_pert (Vector &abs_t_pert, ConstVectorView abs_t, ConstVectorView tmin, ConstVectorView tmax, const Numeric &step, const Index &p_interp_order, const Index &t_interp_order, const Verbosity &verbosity)
 Chose the temperature perturbations abs_t_pert. More...
 
void choose_abs_nls_pert (Vector &abs_nls_pert, ConstVectorView refprof, ConstVectorView minprof, ConstVectorView maxprof, const Numeric &step, const Index &p_interp_order, const Index &nls_interp_order, const Verbosity &verbosity)
 Chose the H2O perturbations abs_nls_pert. More...
 
void abs_lookupSetup (Vector &abs_p, Vector &abs_t, Vector &abs_t_pert, Matrix &abs_vmrs, ArrayOfArrayOfSpeciesTag &abs_nls, Vector &abs_nls_pert, const Index &atmosphere_dim, const Vector &p_grid, const Tensor3 &t_field, const Tensor4 &vmr_field, const Index &atmfields_checked, const ArrayOfArrayOfSpeciesTag &abs_species, const Index &abs_p_interp_order, const Index &abs_t_interp_order, const Index &abs_nls_interp_order, const Numeric &p_step10, const Numeric &t_step, const Numeric &h2o_step, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lookupSetup. More...
 
void abs_lookupSetupBatch (Vector &abs_p, Vector &abs_t, Vector &abs_t_pert, Matrix &abs_vmrs, ArrayOfArrayOfSpeciesTag &abs_nls, Vector &abs_nls_pert, const ArrayOfArrayOfSpeciesTag &abs_species, const ArrayOfGriddedField4 &batch_fields, const Index &abs_p_interp_order, const Index &abs_t_interp_order, const Index &abs_nls_interp_order, const Index &atmosphere_dim, const Numeric &p_step10, const Numeric &t_step, const Numeric &h2o_step, const Vector &extremes, const Index &robust, const Index &check_gridnames, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lookupSetupBatch. More...
 
void abs_lookupSetupWide (Vector &abs_p, Vector &abs_t, Vector &abs_t_pert, Matrix &abs_vmrs, ArrayOfArrayOfSpeciesTag &abs_nls, Vector &abs_nls_pert, const ArrayOfArrayOfSpeciesTag &abs_species, const Index &abs_p_interp_order, const Index &abs_t_interp_order, const Index &abs_nls_interp_order, const Numeric &p_min, const Numeric &p_max, const Numeric &p_step10, const Numeric &t_min, const Numeric &t_max, const Numeric &h2o_min, const Numeric &h2o_max, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lookupSetupWide. More...
 
void abs_speciesAdd (ArrayOfArrayOfSpeciesTag &abs_species, Index &propmat_clearsky_agenda_checked, const ArrayOfString &names, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_speciesAdd. More...
 
void abs_speciesAdd2 (Workspace &ws, ArrayOfArrayOfSpeciesTag &abs_species, ArrayOfRetrievalQuantity &jq, Agenda &jacobian_agenda, Index &propmat_clearsky_agenda_checked, const Index &atmosphere_dim, const Vector &p_grid, const Vector &lat_grid, const Vector &lon_grid, const Vector &rq_p_grid, const Vector &rq_lat_grid, const Vector &rq_lon_grid, const String &species, const String &mode, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_speciesAdd2. More...
 
void abs_speciesInit (ArrayOfArrayOfSpeciesTag &abs_species, const Verbosity &)
 WORKSPACE METHOD: abs_speciesInit. More...
 
void abs_speciesSet (ArrayOfArrayOfSpeciesTag &abs_species, Index &propmat_clearsky_agenda_checked, const ArrayOfString &names, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_speciesSet. More...
 
void abs_lookupAdapt (GasAbsLookup &abs_lookup, Index &abs_lookup_is_adapted, const ArrayOfArrayOfSpeciesTag &abs_species, const Vector &f_grid, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lookupAdapt. More...
 
void propmat_clearskyAddFromLookup (PropagationMatrix &propmat_clearsky, ArrayOfPropagationMatrix &dpropmat_clearsky_dx, const GasAbsLookup &abs_lookup, const Index &abs_lookup_is_adapted, const Index &abs_p_interp_order, const Index &abs_t_interp_order, const Index &abs_nls_interp_order, const Index &abs_f_interp_order, const Vector &f_grid, const Numeric &a_pressure, const Numeric &a_temperature, const Vector &a_vmr_list, const ArrayOfRetrievalQuantity &jacobian_quantities, const ArrayOfArrayOfSpeciesTag &abs_species, const ArrayOfSpeciesTag &select_abs_species, const Numeric &extpolfac, const Index &no_negatives, const Verbosity &verbosity)
 WORKSPACE METHOD: propmat_clearskyAddFromLookup. More...
 
void propmat_clearsky_fieldCalc (Workspace &ws, Tensor7 &propmat_clearsky_field, const Index &atmfields_checked, const Vector &f_grid, const Index &stokes_dim, const Vector &p_grid, const Vector &lat_grid, const Vector &lon_grid, const Tensor3 &t_field, const Tensor4 &vmr_field, const EnergyLevelMap &nlte_field, const Tensor3 &mag_u_field, const Tensor3 &mag_v_field, const Tensor3 &mag_w_field, const ArrayOfArrayOfSpeciesTag &abs_species, const Agenda &abs_agenda, const Vector &doppler, const Vector &los, const Verbosity &verbosity)
 WORKSPACE METHOD: propmat_clearsky_fieldCalc. More...
 
void f_gridFromGasAbsLookup (Vector &f_grid, const GasAbsLookup &abs_lookup, const Verbosity &)
 WORKSPACE METHOD: f_gridFromGasAbsLookup. More...
 
void p_gridFromGasAbsLookup (Vector &p_grid, const GasAbsLookup &abs_lookup, const Verbosity &)
 WORKSPACE METHOD: p_gridFromGasAbsLookup. More...
 

Detailed Description

Methods related to absorption, lookup table, etc.

Author
Stefan Buehler sbueh.nosp@m.ler@.nosp@m.ltu.s.nosp@m.e
Date
Wed Nov 20 18:04:20 2002

Definition in file m_abs_lookup.cc.

Function Documentation

◆ abs_lookupAdapt()

void abs_lookupAdapt ( GasAbsLookup abs_lookup,
Index abs_lookup_is_adapted,
const ArrayOfArrayOfSpeciesTag abs_species,
const Vector f_grid,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lookupAdapt.

Adapts a gas absorption lookup table to the current calculation.

The lookup table can contain more species and more frequencies than are needed for the current calculation. This method cuts down the table in memory, so that it contains just what is needed. Also, the species in the table are brought in the same order as the species in the current calculation.

Of course, the method also performs quite a lot of checks on the table. If something is not ok, a runtime error is thrown.

The method sets a flag abs_lookup_is_adapted to indicate that the table has been checked and that it is ok. Never set this by hand, always use this method to set it!

Author
Stefan Buehler
Parameters
[in,out]abs_lookupWS Input/Output
[out]abs_lookup_is_adaptedWS Output
[in]abs_speciesWS Input
[in]f_gridWS Input

Definition at line 1995 of file m_abs_lookup.cc.

Referenced by abs_lookupAdapt_g().

◆ abs_lookupCalc()

void abs_lookupCalc ( Workspace ws,
GasAbsLookup abs_lookup,
Index abs_lookup_is_adapted,
const ArrayOfArrayOfSpeciesTag abs_species,
const ArrayOfArrayOfSpeciesTag abs_nls,
const Vector f_grid,
const Vector abs_p,
const Matrix abs_vmrs,
const Vector abs_t,
const Vector abs_t_pert,
const Vector abs_nls_pert,
const Agenda propmat_clearsky_agenda,
const Numeric lowest_vmr,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lookupCalc.

Creates a gas absorption lookup table.

The lookup table stores absorption cross-sections as a function of pressure. Additionally, absorption can be stored as a function of temperature for temperature perturbations from a reference profile.

Additionally, absorption can be stored as a function of water vapor VMR perturbations from a reference profile. The variable abs_nls specifies, for which species water vapor perturbations should be generated.

Note, that the absorbing gas can be any gas, but the perturbing gas is always H2O.

Author
Stefan Buehler
Parameters
[in,out]wsWorkspace
[out]abs_lookupWS Output
[out]abs_lookup_is_adaptedWS Output
[in]abs_speciesWS Input
[in]abs_nlsWS Input
[in]f_gridWS Input
[in]abs_pWS Input
[in]abs_vmrsWS Input
[in]abs_tWS Input
[in]abs_t_pertWS Input
[in]abs_nls_pertWS Input
[in]propmat_clearsky_agendaWS Input
[in]lowest_vmrGeneric Input (Default: "1e-9")

Definition at line 65 of file m_abs_lookup.cc.

Referenced by abs_lookupCalc_g().

◆ abs_lookupInit()

void abs_lookupInit ( GasAbsLookup abs_lookup,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lookupInit.

Creates an empty gas absorption lookup table.

This is mainly there to help developers. For example, you can write the empty table to an XML file, to see the file format.

Author
Stefan Buehler
Parameters
[out]abs_lookupWS Output

Definition at line 55 of file m_abs_lookup.cc.

Referenced by abs_lookupInit_g().

◆ abs_lookupSetup()

void abs_lookupSetup ( Vector abs_p,
Vector abs_t,
Vector abs_t_pert,
Matrix abs_vmrs,
ArrayOfArrayOfSpeciesTag abs_nls,
Vector abs_nls_pert,
const Index atmosphere_dim,
const Vector p_grid,
const Tensor3 t_field,
const Tensor4 vmr_field,
const Index atmfields_checked,
const ArrayOfArrayOfSpeciesTag abs_species,
const Index abs_p_interp_order,
const Index abs_t_interp_order,
const Index abs_nls_interp_order,
const Numeric p_step,
const Numeric t_step,
const Numeric h2o_step,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lookupSetup.

Set up input parameters for abs_lookupCalc.

More information can be found in the documentation for method abs_lookupSetupBatch*

Max and min values of H2O and temperature are adjusted to allow for numerical perturbations in Jacobian calculation.

The input variables abs_nls_interp_order and abs_t_interp_order are used to make sure that there are enough points in abs_nls_pert and abs_t_pert for the chosen interpolation order.

Note: For homogeneous 1D cases, it can be advantageous to calculate abs_lookup* from the 1D atmosphere, and to expand the atmosphere to 3D only after that. This particularly if nonlinear species (i.e., H2O) are involved. See also: <br> abs_lookupSetupBatch

Author
Stefan Buehler
Parameters
[out]abs_pWS Output
[out]abs_tWS Output
[out]abs_t_pertWS Output
[out]abs_vmrsWS Output
[out]abs_nlsWS Output
[out]abs_nls_pertWS Output
[in]atmosphere_dimWS Input
[in]p_gridWS Input
[in]t_fieldWS Input
[in]vmr_fieldWS Input
[in]atmfields_checkedWS Input
[in]abs_speciesWS Input
[in]abs_p_interp_orderWS Input
[in]abs_t_interp_orderWS Input
[in]abs_nls_interp_orderWS Input
[in]p_stepGeneric Input (Default: "0.05")
[in]t_stepGeneric Input (Default: "100")
[in]h2o_stepGeneric Input (Default: "100")

Definition at line 798 of file m_abs_lookup.cc.

Referenced by abs_lookupSetup_g().

◆ abs_lookupSetupBatch()

void abs_lookupSetupBatch ( Vector abs_p,
Vector abs_t,
Vector abs_t_pert,
Matrix abs_vmrs,
ArrayOfArrayOfSpeciesTag abs_nls,
Vector abs_nls_pert,
const ArrayOfArrayOfSpeciesTag abs_species,
const ArrayOfGriddedField4 batch_atm_fields_compact,
const Index abs_p_interp_order,
const Index abs_t_interp_order,
const Index abs_nls_interp_order,
const Index atmosphere_dim,
const Numeric p_step,
const Numeric t_step,
const Numeric h2o_step,
const Vector extremes,
const Index robust,
const Index check_gridnames,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lookupSetupBatch.

Set up input parameters for abs_lookupCalc for batch calculations.

This method performs a similar task as abs_lookupSetup, with the difference that the lookup table setup is not for a single atmospheric state, but for a whole batch of them, stored in batch_atm_fields_compact*.

The method checks abs_species to decide which species require nonlinear treatment in the lookup table.

The method also checks which range of pressures, temperatures, and VMRs occurs, and sets abs_p, abs_t, abs_t_pert, and abs_vmrs accordingly.

If nonlinear species are present, abs_nls and abs_nls_pert are also generated.

Max and min values of H2O and temperature are adjusted to allow for numerical perturbations in Jacobian calculation.

The input variables abs_nls_interp_order and abs_t_interp_order are used to make sure that there are enough points in abs_nls_pert and abs_t_pert for the chosen interpolation order.

The method checks each given field using atmfields_checkedCalc. If a field does not pass the check, a run-time error is thrown. To prevent this, the parameter robust can be set to one: Invalid atmospheres are skipped, but the run continues. This matches the robust behaviour of ybatchCalc.

See also: <br> abs_lookupSetup

Author
Stefan Buehler
Parameters
[out]abs_pWS Output
[out]abs_tWS Output
[out]abs_t_pertWS Output
[out]abs_vmrsWS Output
[out]abs_nlsWS Output
[out]abs_nls_pertWS Output
[in]abs_speciesWS Input
[in]batch_atm_fields_compactWS Input
[in]abs_p_interp_orderWS Input
[in]abs_t_interp_orderWS Input
[in]abs_nls_interp_orderWS Input
[in]atmosphere_dimWS Input
[in]p_stepGeneric Input (Default: "0.05")
[in]t_stepGeneric Input (Default: "20")
[in]h2o_stepGeneric Input (Default: "100")
[in]extremesGeneric Input (Default: "[]")
[in]robustGeneric Input (Default: "0")
[in]check_gridnamesGeneric Input (Default: "0")

Definition at line 1065 of file m_abs_lookup.cc.

Referenced by abs_lookupSetupBatch_g().

◆ abs_lookupSetupWide()

void abs_lookupSetupWide ( Vector abs_p,
Vector abs_t,
Vector abs_t_pert,
Matrix abs_vmrs,
ArrayOfArrayOfSpeciesTag abs_nls,
Vector abs_nls_pert,
const ArrayOfArrayOfSpeciesTag abs_species,
const Index abs_p_interp_order,
const Index abs_t_interp_order,
const Index abs_nls_interp_order,
const Numeric p_min,
const Numeric p_max,
const Numeric p_step,
const Numeric t_min,
const Numeric t_max,
const Numeric h2o_min,
const Numeric h2o_max,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lookupSetupWide.

Set up input parameters for abs_lookupCalc for a wide range of atmospheric conditions.

This method can be used to set up parameters for a lookup table that really covers all reasonable atmospheric conditions.

Reference profiles of T and H2O will be constant, so that the different dimensions in the lookup table are actually "orthogonal", unlike the traditional case where we have pressure dependent reference profiles. This makes the table numerically somewhat more robust then the traditional ones, and it makes it straightforward to calculate the accuracy for the different interpolations with abs_lookupTestAccuracy.

You can give min an max values for the atmospheric conditions. The default values are chosen such that they cover the value range over the complete Chevallier91L data set, and a bit more. The statistics of the Chevallier91L data are:

min(p) / max(p) [Pa]: 1 / 104960 min(T) / max(T) [K]: 158.21 / 320.39 min(H2O) / max(H2O) [VMR]: -5.52e-07 / 0.049

Author
Stefan Buehler
Parameters
[out]abs_pWS Output
[out]abs_tWS Output
[out]abs_t_pertWS Output
[out]abs_vmrsWS Output
[out]abs_nlsWS Output
[out]abs_nls_pertWS Output
[in]abs_speciesWS Input
[in]abs_p_interp_orderWS Input
[in]abs_t_interp_orderWS Input
[in]abs_nls_interp_orderWS Input
[in]p_minGeneric Input (Default: "0.5")
[in]p_maxGeneric Input (Default: "110000")
[in]p_stepGeneric Input (Default: "0.05")
[in]t_minGeneric Input (Default: "100")
[in]t_maxGeneric Input (Default: "400")
[in]h2o_minGeneric Input (Default: "0")
[in]h2o_maxGeneric Input (Default: "0.05")

Definition at line 1709 of file m_abs_lookup.cc.

Referenced by abs_lookupSetupWide_g().

◆ abs_speciesAdd()

void abs_speciesAdd ( ArrayOfArrayOfSpeciesTag abs_species,
Index propmat_clearsky_agenda_checked,
const ArrayOfString species,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_speciesAdd.

Adds species tag groups to the list of absorption species.

This WSM is similar to abs_speciesSet, the only difference is that this method appends species to an existing list of absorption species instead of creating the whole list.

See abs_speciesSet for details on how tags are defined and examples of how to input them in the control file.

Author
Stefan Buehler
Parameters
[in,out]abs_speciesWS Input/Output
[out]propmat_clearsky_agenda_checkedWS Output
[in]speciesGeneric Input

Definition at line 1862 of file m_abs_lookup.cc.

Referenced by abs_speciesAdd_g(), and ScatElementsToabs_speciesAdd().

◆ abs_speciesAdd2()

void abs_speciesAdd2 ( Workspace ws,
ArrayOfArrayOfSpeciesTag abs_species,
ArrayOfRetrievalQuantity jacobian_quantities,
Agenda jacobian_agenda,
Index propmat_clearsky_agenda_checked,
const Index atmosphere_dim,
const Vector p_grid,
const Vector lat_grid,
const Vector lon_grid,
const Vector gin1,
const Vector gin2,
const Vector gin3,
const String species,
const String unit,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_speciesAdd2.

Adds a species tag group to the list of absorption species and jacobian quantities.

The method is basically a combined call of abs_speciesAdd and jacobianAddAbsSpecies*. In this way it is not needed to specify a tag group in two different places.

Arguments exactly as for jacobianAddAbsSpecies. Note that this method only handles a single tag group, in contrast to abs_speciesAdd*.

Author
Patrick Eriksson
Parameters
[in,out]wsWorkspace
[in,out]abs_speciesWS Input/Output
[out]jacobian_quantitiesWS Output
[out]jacobian_agendaWS Output
[out]propmat_clearsky_agenda_checkedWS Output
[in]atmosphere_dimWS Input
[in]p_gridWS Input
[in]lat_gridWS Input
[in]lon_gridWS Input
[in]gin1Generic Input
[in]gin2Generic Input
[in]gin3Generic Input
[in]speciesGeneric Input
[in]unitGeneric Input (Default: "vmr")

Definition at line 1899 of file m_abs_lookup.cc.

Referenced by abs_speciesAdd2_g().

◆ abs_speciesInit()

void abs_speciesInit ( ArrayOfArrayOfSpeciesTag abs_species,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_speciesInit.

Sets abs_species to be empty.

Author
Stefan Buehler
Parameters
[out]abs_speciesWS Output

Definition at line 1954 of file m_abs_lookup.cc.

Referenced by abs_speciesInit_g().

◆ abs_speciesSet()

void abs_speciesSet ( ArrayOfArrayOfSpeciesTag abs_species,
Index propmat_clearsky_agenda_checked,
const ArrayOfString species,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_speciesSet.

Set up a list of absorption species tag groups.

Workspace variables like abs_species contain several tag groups. Each tag group contains one or more tags. This method converts descriptions of tag groups given in the keyword to the ARTS internal representation (an ArrayOfArrayOfSpeciesTag). A tag group selects spectral features which belong to the same species.

A tag is defined in terms of the name of the species, isotopologue, and a range of frequencies. Species are named after the standard chemical names, e.g., "O3". Isotopologues are given by the last digit of the atomic weight, i.g., "O3-668" for the asymmetric ozone molecule including an oxygen 18 atom. Groups of transitions are specified by giving a lower and upper limit of a frequency range, e.g., "O3-666-500e9-501e9".

To turn on Zeeman calculation for a species, "-Z" may be appended to its name: "O2-Z" or "O2-Z-66"

To turn on line mixing calculation for a species, "-LM" may be appended to its name (or after the Zeeman tag): "O2-LM" or "O2-Z-LM-66"

The symbol "*" acts as a wild card. Furthermore, frequency range or frequency range and isotopologue may be omitted.

Finally, instead of the isotopologue the special letter "nl" may be given, e.g., "H2O-nl". This means that no absorption at all is associated with this tag. (It is not quite clear if this feature is useful for anything right now.)

Example:

<br> species = [ "O3-666-500e9-501e9, O3-686", <br> "O3", <br> "H2O-PWR98" ]

<br> The first tag group selects all O3-666 lines between 500 and <br> 501 GHz plus all O3-686 lines.

<br> The second tag group selects all remaining O3 transitions.

<br> The third tag group selects H2O, with one of the complete <br> absorption models (Rosenkranz 98). No spectrocopic line catalogue <br> data will be used for that third tag group.

<br> Note that order of tag groups in the species list matters. In our <br> example, changing the order of the first two tag group will give <br> different results: as "O3" already selects all O3 transitions, <br> no lines will remain to be selected by the <br> "O3-666-500e9-501e9, O3-686" tag.

For CIA species the tag consists of the two involved species and a dataset index. CIA species can be defined for multiple regions The dataset index determines which region to use from the corresponding CIARecord in abs_cia_data.

Example

species = [ "N2-CIA-N2-0, N2-CIA-N2-1" ]

For Hitran cross section species the tag consists of the species and the tagtype XFIT, e.g. CFC11-XFIT. The data for the species must be available in the xsec_fit_data variable. propmat_clearsky_agenda_checked* is set to be false.

Author
Stefan Buehler
Parameters
[out]abs_speciesWS Output
[out]propmat_clearsky_agenda_checkedWS Output
[in]speciesGeneric Input

Definition at line 1959 of file m_abs_lookup.cc.

Referenced by abs_lines_per_speciesChangeBaseParameterForSpecies(), abs_lines_per_speciesCutoffSpecies(), abs_lines_per_speciesLinemixingLimitSpecies(), abs_lines_per_speciesLineShapeTypeSpecies(), abs_lines_per_speciesMirroringSpecies(), abs_lines_per_speciesNormalizationSpecies(), abs_lines_per_speciesPopulationSpecies(), abs_lines_per_speciesT0Species(), abs_linesWriteSpeciesSplitCatalog(), abs_speciesDefineAll(), and abs_speciesSet_g().

◆ choose_abs_nls()

void choose_abs_nls ( ArrayOfArrayOfSpeciesTag abs_nls,
const ArrayOfArrayOfSpeciesTag abs_species,
const Verbosity verbosity 
)

Choose species for abs_nls.

Make an intelligent choice for abs_nls, based on abs_species.

Author
Stefan Buehler
Parameters
[out]abs_nlsThe list of nonlinear species.
[in]abs_speciesAbsorption species.

Definition at line 565 of file m_abs_lookup.cc.

◆ choose_abs_nls_pert()

void choose_abs_nls_pert ( Vector abs_nls_pert,
ConstVectorView  refprof,
ConstVectorView  minprof,
ConstVectorView  maxprof,
const Numeric step,
const Index p_interp_order,
const Index nls_interp_order,
const Verbosity verbosity 
)

Chose the H2O perturbations abs_nls_pert.

This simple function creates a vector of fractional H2O VMR perturbations, relative to the reference H2O profile, that covers the minimum and maximum profile.

Author
Stefan Buehler
Parameters
[out]abs_nls_pertH2O VMR perturbations
[in]refprofReference profile
[in]minprofMinimum profile
[in]maxprofMaximum profile
[in]stepFractional perturbation step

Definition at line 689 of file m_abs_lookup.cc.

◆ choose_abs_t_pert()

void choose_abs_t_pert ( Vector abs_t_pert,
ConstVectorView  abs_t,
ConstVectorView  tmin,
ConstVectorView  tmax,
const Numeric step,
const Index p_interp_order,
const Index t_interp_order,
const Verbosity verbosity 
)

Chose the temperature perturbations abs_t_pert.

This simple function creates a vector of temperature perturbations, relative to the reference temperature profile, that covers the minimum and maximum temperature profile.

Author
Stefan Buehler
Parameters
[out]abs_t_pertTemperature perturbations
[in]abs_tReference temperature profile
[in]tminMinimum temperature profile
[in]tmaxMaximum temperature profile
[in]t_stepTemperature perturbation step

Definition at line 616 of file m_abs_lookup.cc.

◆ f_gridFromGasAbsLookup()

void f_gridFromGasAbsLookup ( Vector f_grid,
const GasAbsLookup abs_lookup,
const Verbosity verbosity 
)

WORKSPACE METHOD: f_gridFromGasAbsLookup.

Sets f_grid to the frequency grid of abs_lookup.

Must be called between importing/creating raw absorption table and call of abs_lookupAdapt.

Author
Stefan Buehler
Parameters
[out]f_gridWS Output
[in]abs_lookupWS Input

Definition at line 2355 of file m_abs_lookup.cc.

Referenced by f_gridFromGasAbsLookup_g().

◆ find_nonlinear_continua()

void find_nonlinear_continua ( ArrayOfIndex cont,
const ArrayOfArrayOfSpeciesTag abs_species,
const Verbosity verbosity 
)

Find continuum species in abs_species.

Returns an index array with indexes of those species in abs_species that have continuum tags that require h2o_abs, and hence require nonlinear treatment in the absorption lookup table.

H2O itself is ignored here since that is treated separately.

We are a bit conservative here, it is possible that some of the continua do not really require H2O. Check yourself, if you want, and improve the guessing here.

Return values
contindices of those species with continua.
Parameters
abs_specieslist of absorption species.
Author
Stefan Buehler
Date
2007-11-16

Definition at line 476 of file m_abs_lookup.cc.

◆ p_gridFromGasAbsLookup()

void p_gridFromGasAbsLookup ( Vector p_grid,
const GasAbsLookup abs_lookup,
const Verbosity verbosity 
)

WORKSPACE METHOD: p_gridFromGasAbsLookup.

Sets p_grid to the pressure grid of abs_lookup.

Author
Patrick Eriksson
Parameters
[out]p_gridWS Output
[in]abs_lookupWS Input

Definition at line 2364 of file m_abs_lookup.cc.

Referenced by p_gridFromGasAbsLookup_g().

◆ propmat_clearsky_fieldCalc()

void propmat_clearsky_fieldCalc ( Workspace ws,
Tensor7 propmat_clearsky_field,
const Index atmfields_checked,
const Vector f_grid,
const Index stokes_dim,
const Vector p_grid,
const Vector lat_grid,
const Vector lon_grid,
const Tensor3 t_field,
const Tensor4 vmr_field,
const EnergyLevelMap nlte_field,
const Tensor3 mag_u_field,
const Tensor3 mag_v_field,
const Tensor3 mag_w_field,
const ArrayOfArrayOfSpeciesTag abs_species,
const Agenda propmat_clearsky_agenda,
const Vector doppler,
const Vector los,
const Verbosity verbosity 
)

WORKSPACE METHOD: propmat_clearsky_fieldCalc.

Calculate (vector) gas absorption coefficients for all points in the atmosphere.

This is useful in two different contexts:

  1. For testing and plotting gas absorption. (For RT calculations, gas absorption is calculated or extracted locally, therefore there is no need to calculate a global field. But this method is handy for easy plotting of absorption vs. pressure, for example.)
  2. Inside the scattering region, monochromatic absorption is pre-calculated for the entire atmospheric field.

The calculation itself is performed by the propmat_clearsky_agenda*.

Author
Stefan Buehler, Richard Larsson
Parameters
[in,out]wsWorkspace
[out]propmat_clearsky_fieldWS Output
[in]atmfields_checkedWS Input
[in]f_gridWS Input
[in]stokes_dimWS Input
[in]p_gridWS Input
[in]lat_gridWS Input
[in]lon_gridWS Input
[in]t_fieldWS Input
[in]vmr_fieldWS Input
[in]nlte_fieldWS Input
[in]mag_u_fieldWS Input
[in]mag_v_fieldWS Input
[in]mag_w_fieldWS Input
[in]abs_speciesWS Input
[in]propmat_clearsky_agendaWS Input
[in]dopplerGeneric Input (Default: "[]")
[in]losGeneric Input (Default: "[]")

Definition at line 2138 of file m_abs_lookup.cc.

Referenced by propmat_clearsky_fieldCalc_g().

◆ propmat_clearskyAddFromLookup()

void propmat_clearskyAddFromLookup ( PropagationMatrix propmat_clearsky,
ArrayOfPropagationMatrix dpropmat_clearsky_dx,
const GasAbsLookup abs_lookup,
const Index abs_lookup_is_adapted,
const Index abs_p_interp_order,
const Index abs_t_interp_order,
const Index abs_nls_interp_order,
const Index abs_f_interp_order,
const Vector f_grid,
const Numeric rtp_pressure,
const Numeric rtp_temperature,
const Vector rtp_vmr,
const ArrayOfRetrievalQuantity jacobian_quantities,
const ArrayOfArrayOfSpeciesTag abs_species,
const ArrayOfSpeciesTag select_abs_species,
const Numeric extpolfac,
const Index no_negatives,
const Verbosity verbosity 
)

WORKSPACE METHOD: propmat_clearskyAddFromLookup.

Extract gas absorption coefficients from lookup table.

This extracts the absorption coefficient for all species from the lookup table, and adds them to the propagation matrix. Extraction is for one specific atmospheric condition, i.e., a set of pressure, temperature, and VMR values.

Some special species are ignored, for example Zeeman species and free electrons, since their absorption properties are not simple scalars and cannot be handled by the lookup table.

The interpolation order in T and H2O is given by abs_t_interp_order and abs_nls_interp_order, respectively.

Extraction is done for the frequencies in f_grid. Frequency interpolation is controlled by abs_f_interp_order. If this is zero, then f_grid must either be the same as the internal frequency grid of the lookup table (for efficiency reasons, only the first and last element of f_grid are checked), or must have only a single element. If abs_f_interp_order is above zero, then frequency is interpolated along with the other interpolation dimensions. This is useful for calculations with Doppler shift.

For Doppler calculations, you should generate the table with a somewhat larger frequency grid than the calculation itself has, since the Doppler shift will push the frequency grid out of the table range on one side.

Some extrapolation is allowed. For pressure and frequency interpolation the standard extrapolation factor of 0.5 is applied. The factor is the default for temperature and VMR interpolation, but the extrapolation limit can here be adjusted by the extpolfac argument.

Author
Stefan Buehler, Richard Larsson
Parameters
[in,out]propmat_clearskyWS Input/Output
[in,out]dpropmat_clearsky_dxWS Input/Output
[in]abs_lookupWS Input
[in]abs_lookup_is_adaptedWS Input
[in]abs_p_interp_orderWS Input
[in]abs_t_interp_orderWS Input
[in]abs_nls_interp_orderWS Input
[in]abs_f_interp_orderWS Input
[in]f_gridWS Input
[in]rtp_pressureWS Input
[in]rtp_temperatureWS Input
[in]rtp_vmrWS Input
[in]jacobian_quantitiesWS Input
[in]abs_speciesWS Input
[in]select_abs_speciesWS Input
[in]extpolfacGeneric Input (Default: "0.5")
[in]no_negativesGeneric Input (Default: "1")

Definition at line 2005 of file m_abs_lookup.cc.

Referenced by propmat_clearskyAddFromLookup_g().