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

#include <algorithm>
#include <map>
#include <limits>
#include "auto_md.h"
#include "arts.h"
#include "messages.h"
#include "gas_abs_lookup.h"
#include "agenda_class.h"
#include "check_input.h"
#include "matpackV.h"
#include "physics_funcs.h"
#include "math_funcs.h"
#include "make_vector.h"
#include "arts_omp.h"
#include "interpolation_poly.h"
#include "rng.h"
#include "absorption.h"
#include "global_data.h"

Include dependency graph for m_abs_lookup.cc:

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 &abs_xsec_agenda, 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 Numeric &p_step10, const Numeric &t_step, const Numeric &h2o_step, const Vector &extremes, 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, Index &abs_xsec_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, Index &abs_xsec_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 &method, const String &mode, const Numeric &dx, 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 &abs_xsec_agenda_checked, 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 (Tensor4 &propmat_clearsky, 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 Numeric &extpolfac, 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 Tensor3 &mag_u_field, const Tensor3 &mag_v_field, const Tensor3 &mag_w_field, 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...

Numeric	calc_lookup_error (Workspace &ws, const GasAbsLookup &al, const Index &abs_p_interp_order, const Index &abs_t_interp_order, const Index &abs_nls_interp_order, const bool ignore_errors, const Agenda &abs_xsec_agenda, const Numeric &local_p, const Numeric &local_t, const Vector &local_vmrs, const Verbosity &verbosity)
	Compare lookup and LBL calculation. More...

void	abs_lookupTestAccuracy (Workspace &ws, 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 Agenda &abs_xsec_agenda, const Verbosity &verbosity)
	WORKSPACE METHOD: abs_lookupTestAccuracy. More...

void	abs_lookupTestAccMC (Workspace &ws, 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 &mc_seed, const Agenda &abs_xsec_agenda, const Verbosity &verbosity)
	WORKSPACE METHOD: abs_lookupTestAccMC. More...

Variables
const Index	GFIELD4_FIELD_NAMES

const Index	GFIELD4_P_GRID

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

[out]	abs_lookup	WS Output
[out]	abs_lookup_is_adapted	WS Output
[in]	abs_species	WS Input
[in]	f_grid	WS Input

Definition at line 2008 of file m_abs_lookup.cc.

References GasAbsLookup::Adapt().

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 &	abs_xsec_agenda,
		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.

In contrast to other absorption functions, this method does not use the input variable abs_h2o. This is because abs_h2o has to be set interally to allow perturbations. If there are more than one H2O species, the first is assumed to be the main one.

Author: Stefan Buehler

Parameters

[in,out]	ws	Workspace
[out]	abs_lookup	WS Output
[out]	abs_lookup_is_adapted	WS Output
[in]	abs_species	WS Input
[in]	abs_nls	WS Input
[in]	f_grid	WS Input
[in]	abs_p	WS Input
[in]	abs_vmrs	WS Input
[in]	abs_t	WS Input
[in]	abs_t_pert	WS Input
[in]	abs_nls_pert	WS Input
[in]	abs_xsec_agenda	WS Input

Definition at line 63 of file m_abs_lookup.cc.

References abs_xsec_agendaExecute(), chk_size(), CREATE_OUT2, CREATE_OUT3, GasAbsLookup::f_grid, GasAbsLookup::fgp_default, find_first_species_tg(), get_tag_group_name(), gridpos_poly(), is_unique(), is_zeeman(), joker, GasAbsLookup::log_p_grid, Array< base >::nelem(), ConstVectorView::nelem(), GasAbsLookup::nls_pert, GasAbsLookup::nonlinear_species, GasAbsLookup::p_grid, Tensor4::resize(), Vector::resize(), spec(), GasAbsLookup::species, species_index_from_species_name(), GasAbsLookup::t_pert, GasAbsLookup::t_ref, transform(), SpeciesTag::TYPE_FREE_ELECTRONS, SpeciesTag::TYPE_PARTICLES, GasAbsLookup::vmrs_ref, and GasAbsLookup::xsec.

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_lookup WS Output

Definition at line 51 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: abs_lookupSetupBatch

Author: Stefan Buehler

Parameters

[out]	abs_p	WS Output
[out]	abs_t	WS Output
[out]	abs_t_pert	WS Output
[out]	abs_vmrs	WS Output
[out]	abs_nls	WS Output
[out]	abs_nls_pert	WS Output
[in]	atmosphere_dim	WS Input
[in]	p_grid	WS Input
[in]	t_field	WS Input
[in]	vmr_field	WS Input
[in]	atmfields_checked	WS Input
[in]	abs_species	WS Input
[in]	abs_p_interp_order	WS Input
[in]	abs_t_interp_order	WS Input
[in]	abs_nls_interp_order	WS Input
[in]	p_step	Generic Input (Default: "0.05")
[in]	t_step	Generic Input (Default: "100")
[in]	h2o_step	Generic Input (Default: "100")

Definition at line 848 of file m_abs_lookup.cc.

References choose_abs_nls(), choose_abs_nls_pert(), choose_abs_t_pert(), find_first_species_tg(), gridpos(), interp(), interpweights(), joker, max, mean(), min, Array< base >::nelem(), ConstVectorView::nelem(), Vector::resize(), Matrix::resize(), species_index_from_species_name(), and transform().

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 Numeric &	p_step,
		const Numeric &	t_step,
		const Numeric &	h2o_step,
		const Vector &	extremes,
		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 depend on abs_h2o*, and hence 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.

◆ 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 all Chevallier data set cases, and a bit more. The statistics of the Chevallier 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_p	WS Output
[out]	abs_t	WS Output
[out]	abs_t_pert	WS Output
[out]	abs_vmrs	WS Output
[out]	abs_nls	WS Output
[out]	abs_nls_pert	WS Output
[in]	abs_species	WS Input
[in]	abs_p_interp_order	WS Input
[in]	abs_t_interp_order	WS Input
[in]	abs_nls_interp_order	WS Input
[in]	p_min	Generic Input (Default: "0.5")
[in]	p_max	Generic Input (Default: "110000")
[in]	p_step	Generic Input (Default: "0.05")
[in]	t_min	Generic Input (Default: "100")
[in]	t_max	Generic Input (Default: "400")
[in]	h2o_min	Generic Input (Default: "0")
[in]	h2o_max	Generic Input (Default: "0.05")

Definition at line 1695 of file m_abs_lookup.cc.

References choose_abs_nls(), choose_abs_nls_pert(), choose_abs_t_pert(), CREATE_OUT1, CREATE_OUT2, find_first_species_tg(), joker, Array< base >::nelem(), Vector::resize(), Matrix::resize(), species_index_from_species_name(), and transform().

Referenced by abs_lookupSetupWide_g().

◆ abs_lookupTestAccMC()

void abs_lookupTestAccMC	(	Workspace &	ws,
		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 &	mc_seed,
		const Agenda &	abs_xsec_agenda,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: abs_lookupTestAccMC.

Test accuracy of absorption lookup table with Monte Carlo Algorithm.

Explicitly compare absorption from the lookup table with line-by-line calculations for random conditions.

The quantities returned are the mean value and standard deviation of the absolute value of the relative error in percent. The relative error itself is computed for a large number of cases (pressure, temperature, and H2O VMR combinations). In the frequency dimension the maximum value is taken for each case.

Produces no workspace output, only output to the output streams.

Author: Stefan Buehler

Parameters

[in,out]	ws	Workspace
[in]	abs_lookup	WS Input
[in]	abs_lookup_is_adapted	WS Input
[in]	abs_p_interp_order	WS Input
[in]	abs_t_interp_order	WS Input
[in]	abs_nls_interp_order	WS Input
[in]	mc_seed	WS Input
[in]	abs_xsec_agenda	WS Input

Definition at line 2800 of file m_abs_lookup.cc.

References abs, calc_lookup_error(), CREATE_OUT2, CREATE_OUT3, Rng::draw(), find_first_species_tg(), gridpos_poly(), interp(), interpweights(), joker, GasAbsLookup::log_p_grid, mean(), N, Array< base >::nelem(), ConstVectorView::nelem(), GasAbsLookup::nls_pert, GasAbsLookup::nonlinear_species, Vector::resize(), Rng::seed(), GasAbsLookup::species, species_index_from_species_name(), GasAbsLookup::t_pert, GasAbsLookup::t_ref, and GasAbsLookup::vmrs_ref.

Referenced by abs_lookupTestAccMC_g().

◆ abs_lookupTestAccuracy()

void abs_lookupTestAccuracy	(	Workspace &	ws,
		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 Agenda &	abs_xsec_agenda,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: abs_lookupTestAccuracy.

Test accuracy of absorption lookup table.

Explicitly compare absorption from the lookup table with line-by-line calculations for strategically selected conditions (in-between the lookup table grid points).

For error units see abs_lookupTestAccMC

Produces no workspace output, only output to the output streams.

Author: Stefan Buehler

Parameters

[in,out]	ws	Workspace
[in]	abs_lookup	WS Input
[in]	abs_lookup_is_adapted	WS Input
[in]	abs_p_interp_order	WS Input
[in]	abs_t_interp_order	WS Input
[in]	abs_nls_interp_order	WS Input
[in]	abs_xsec_agenda	WS Input

Definition at line 2462 of file m_abs_lookup.cc.

References calc_lookup_error(), CREATE_OUT2, find_first_species_tg(), joker, GasAbsLookup::log_p_grid, Array< base >::nelem(), ConstVectorView::nelem(), GasAbsLookup::nls_pert, GasAbsLookup::nonlinear_species, GasAbsLookup::p_grid, GasAbsLookup::species, species_index_from_species_name(), GasAbsLookup::t_pert, GasAbsLookup::t_ref, and GasAbsLookup::vmrs_ref.

Referenced by abs_lookupTestAccuracy_g().

◆ abs_speciesAdd()

void abs_speciesAdd	(	ArrayOfArrayOfSpeciesTag &	abs_species,
		Index &	propmat_clearsky_agenda_checked,
		Index &	abs_xsec_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

[out]	abs_species	WS Output
[out]	propmat_clearsky_agenda_checked	WS Output
[out]	abs_xsec_agenda_checked	WS Output
[in]	species	Generic Input

Definition at line 1859 of file m_abs_lookup.cc.

References array_species_tag_from_string(), check_abs_species(), CREATE_OUT3, Array< base >::nelem(), and temp.

Referenced by abs_speciesAdd_g(), and ParticleType2abs_speciesAdd().

◆ abs_speciesAdd2()

void abs_speciesAdd2	(	Workspace &	ws,
		ArrayOfArrayOfSpeciesTag &	abs_species,
		ArrayOfRetrievalQuantity &	jacobian_quantities,
		Agenda &	jacobian_agenda,
		Index &	propmat_clearsky_agenda_checked,
		Index &	abs_xsec_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 &	method,
		const String &	unit,
		const Numeric &	dx,
		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]	ws	Workspace
[out]	abs_species	WS Output
[out]	jacobian_quantities	WS Output
[out]	jacobian_agenda	WS Output
[out]	propmat_clearsky_agenda_checked	WS Output
[out]	abs_xsec_agenda_checked	WS Output
[in]	atmosphere_dim	WS Input
[in]	p_grid	WS Input
[in]	lat_grid	WS Input
[in]	lon_grid	WS Input
[in]	gin1	Generic Input
[in]	gin2	Generic Input
[in]	gin3	Generic Input
[in]	species	Generic Input
[in]	method	Generic Input
[in]	unit	Generic Input
[in]	dx	Generic Input

Definition at line 1904 of file m_abs_lookup.cc.

References array_species_tag_from_string(), check_abs_species(), CREATE_OUT3, jacobianAddAbsSpecies(), and Array< base >::nelem().

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_species WS Output

Definition at line 1958 of file m_abs_lookup.cc.

Referenced by abs_speciesInit_g().

◆ abs_speciesSet()

void abs_speciesSet	(	ArrayOfArrayOfSpeciesTag &	abs_species,
		Index &	abs_xsec_agenda_checked,
		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 for a Species, "-LM_METHOD" may be appended to its name. Currently only one METHOD is supported: 2NDORDER. Line mixing data has to be provided if this is turned on. See line_mixing_dataInit and line_mixing_dataRead .Example: "O2-66-LM_2NDORDER".

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:

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

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

The second tag group selects all remaining O3 transitions.

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

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

Author: Stefan Buehler

Parameters

[out]	abs_species	WS Output
[out]	abs_xsec_agenda_checked	WS Output
[out]	propmat_clearsky_agenda_checked	WS Output
[in]	species	Generic Input

Definition at line 1966 of file m_abs_lookup.cc.

References array_species_tag_from_string(), check_abs_species(), CREATE_OUT3, and Array< base >::nelem().

Referenced by abs_speciesSet_g().

◆ calc_lookup_error()

Numeric calc_lookup_error	(	Workspace &	ws,
		const GasAbsLookup &	al,
		const Index &	abs_p_interp_order,
		const Index &	abs_t_interp_order,
		const Index &	abs_nls_interp_order,
		const bool	ignore_errors,
		const Agenda &	abs_xsec_agenda,
		const Numeric &	local_p,
		const Numeric &	local_t,
		const Vector &	local_vmrs,
		const Verbosity &	verbosity
	)

Compare lookup and LBL calculation.

This is a helper function used by abs_lookupTestAccuracy. It takes local p, T, and VMR conditions, performs lookup table extraction and line by line absorption calculation, and compares the difference.

Parameters

al	Lookup table
abs_p_interp_order	Pressure interpolation order.
abs_t_interp_order	Temperature interpolation order.
abs_nls_interp_order	H2O interpolation order.
ignore_errors	If true, we ignore runtime errors in lookup table extraction. This is handy, because in some cases it is not easy to make sure that all local conditions are inside the valid range for the lookup table.
local_p
local_t
local_vmrs

Returns: The maximum of the absolute value of the relative difference between lookup and LBL, in percent. Or -1 if the case should be ignored according to the "ignore_errors" flag.

Definition at line 2344 of file m_abs_lookup.cc.

References GasAbsLookup::Extract(), GasAbsLookup::f_grid, joker, max, ConstMatrixView::ncols(), ConstVectorView::nelem(), propmat_clearskyAddOnTheFly(), propmat_clearskyInit(), and GasAbsLookup::species.

Referenced by abs_lookupTestAccMC(), and abs_lookupTestAccuracy().

◆ 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_nls	The list of nonlinear species.
[in]	abs_species	Absorption species.

Definition at line 594 of file m_abs_lookup.cc.

References CREATE_OUT2, find_next_species_tg(), find_nonlinear_continua(), Array< base >::nelem(), and species_index_from_species_name().

Referenced by abs_lookupSetup(), abs_lookupSetupBatch(), and abs_lookupSetupWide().

◆ 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_pert	H2O VMR perturbations
[in]	refprof	Reference profile
[in]	minprof	Minimum profile
[in]	maxprof	Maximum profile
[in]	step	Fractional perturbation step

Definition at line 732 of file m_abs_lookup.cc.

References CREATE_OUT2, CREATE_OUT3, gridpos_poly(), GridPosPoly::idx, Array< base >::nelem(), ConstVectorView::nelem(), and VectorInsertGridPoints().

Referenced by abs_lookupSetup(), abs_lookupSetupBatch(), and abs_lookupSetupWide().

◆ 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_pert	Temperature perturbations
[in]	abs_t	Reference temperature profile
[in]	tmin	Minimum temperature profile
[in]	tmax	Maximum temperature profile
[in]	t_step	Temperature perturbation step

Definition at line 652 of file m_abs_lookup.cc.

References CREATE_OUT2, CREATE_OUT3, gridpos_poly(), GridPosPoly::idx, Array< base >::nelem(), and ConstVectorView::nelem().

Referenced by abs_lookupSetup(), abs_lookupSetupBatch(), and abs_lookupSetupWide().

◆ 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_grid	WS Output
[in]	abs_lookup	WS Input

Definition at line 2299 of file m_abs_lookup.cc.

References GasAbsLookup::GetFgrid(), ConstVectorView::nelem(), and Vector::resize().

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

cont	indices of those species with continua.

Parameters

abs_species list of absorption species.

Author: Stefan Buehler

Date: 2007-11-16

Definition at line 511 of file m_abs_lookup.cc.

References CREATE_OUT3, Array< base >::nelem(), species_index_from_species_name(), SpeciesTag::TYPE_CIA, and SpeciesTag::TYPE_PREDEF.

Referenced by choose_abs_nls().

◆ 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_grid	WS Output
[in]	abs_lookup	WS Input

Definition at line 2311 of file m_abs_lookup.cc.

References GasAbsLookup::GetPgrid(), ConstVectorView::nelem(), and Vector::resize().

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 Tensor3 &	mag_u_field,
		const Tensor3 &	mag_v_field,
		const Tensor3 &	mag_w_field,
		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:

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.)
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]	ws	Workspace
[out]	propmat_clearsky_field	WS Output
[in]	atmfields_checked	WS Input
[in]	f_grid	WS Input
[in]	stokes_dim	WS Input
[in]	p_grid	WS Input
[in]	lat_grid	WS Input
[in]	lon_grid	WS Input
[in]	t_field	WS Input
[in]	vmr_field	WS Input
[in]	mag_u_field	WS Input
[in]	mag_v_field	WS Input
[in]	mag_w_field	WS Input
[in]	propmat_clearsky_agenda	WS Input
[in]	doppler	Generic Input (Default: "[]")
[in]	los	Generic Input (Default: "[]")

Definition at line 2086 of file m_abs_lookup.cc.

References abs, chk_if_in_range(), CREATE_OUT2, CREATE_OUT3, joker, max, ConstTensor4View::nbooks(), ConstTensor4View::ncols(), ConstVectorView::nelem(), ConstTensor3View::npages(), ConstTensor4View::npages(), ConstTensor4View::nrows(), propmat_clearsky_agendaExecute(), and Tensor7::resize().

Referenced by propmat_clearsky_fieldCalc_g().

◆ propmat_clearskyAddFromLookup()

void propmat_clearskyAddFromLookup	(	Tensor4 &	propmat_clearsky,
		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 Numeric &	extpolfac,
		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. Alternatively, you can set the input parameter extpolfac to a larger value, to allow extrapolation at the edges.

See also: propmat_clearskyAddOnTheFly.

Author: Stefan Buehler, Richard Larsson

Parameters

[out]	propmat_clearsky	WS Output
[in]	abs_lookup	WS Input
[in]	abs_lookup_is_adapted	WS Input
[in]	abs_p_interp_order	WS Input
[in]	abs_t_interp_order	WS Input
[in]	abs_nls_interp_order	WS Input
[in]	abs_f_interp_order	WS Input
[in]	f_grid	WS Input
[in]	rtp_pressure	WS Input
[in]	rtp_temperature	WS Input
[in]	rtp_vmr	WS Input
[in]	extpolfac	Generic Input (Default: "0.5")

Definition at line 2020 of file m_abs_lookup.cc.

References CREATE_OUT3, GasAbsLookup::Extract(), joker, ConstTensor4View::ncols(), and ConstTensor4View::nrows().

Referenced by propmat_clearskyAddFromLookup_g().

Variable Documentation

◆ GFIELD4_FIELD_NAMES

const Index GFIELD4_FIELD_NAMES

Referenced by abs_lookupSetupBatch().

◆ GFIELD4_P_GRID

const Index GFIELD4_P_GRID

Referenced by abs_lookupSetupBatch().

Functions

Variables

Detailed Description

Function Documentation

◆ abs_lookupAdapt()

◆ abs_lookupCalc()

◆ abs_lookupInit()

◆ abs_lookupSetup()

◆ abs_lookupSetupBatch()

◆ abs_lookupSetupWide()

◆ abs_lookupTestAccMC()

◆ abs_lookupTestAccuracy()

◆ abs_speciesAdd()

◆ abs_speciesAdd2()

◆ abs_speciesInit()

◆ abs_speciesSet()

◆ calc_lookup_error()

◆ choose_abs_nls()

◆ choose_abs_nls_pert()

◆ choose_abs_t_pert()

◆ f_gridFromGasAbsLookup()

◆ find_nonlinear_continua()

◆ p_gridFromGasAbsLookup()

◆ propmat_clearsky_fieldCalc()

◆ propmat_clearskyAddFromLookup()

Variable Documentation

◆ GFIELD4_FIELD_NAMES

◆ GFIELD4_P_GRID