Declarations required for the calculation of jacobians. More...

#include <map>
#include <iostream>
#include <stdexcept>
#include "matpackI.h"
#include "array.h"
#include "mystring.h"
#include "make_array.h"
#include "bifstream.h"
#include "interpolation.h"
#include "logic.h"
#include "methods.h"
#include "ppath.h"
#include "agenda_class.h"

Include dependency graph for jacobian.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	RetrievalQuantity
	Contains the data for one retrieval quantity. More...

Macros
#define	FOR_ANALYTICAL_JACOBIANS_DO(what_to_do)

Typedefs
typedef Array< RetrievalQuantity >	ArrayOfRetrievalQuantity

Functions
ostream &	operator<< (ostream &os, const RetrievalQuantity &ot)
	Output operator for RetrievalQuantity. More...

void	calc_nd_field (Tensor3View &nd, const VectorView &p, const Tensor3View &t)
	Calculate the number density field. More...

bool	check_retrieval_grids (ArrayOfVector &grids, ostringstream &os, const Vector &p_grid, const Vector &lat_grid, const Vector &lon_grid, const Vector &p_retr, const Vector &lat_retr, const Vector &lon_retr, const String &p_retr_name, const String &lat_retr_name, const String &lon_retr_name, const Index &dim)
	Check that the retrieval grids are defined for each atmosphere dim. More...

void	diy_from_path_to_rgrids (Tensor3View diy_dx, const RetrievalQuantity &jacobian_quantity, ConstTensor3View diy_dpath, const Index &atmosphere_dim, const Ppath &ppath, ConstVectorView ppath_p)

void	get_perturbation_gridpos (ArrayOfGridPos &gp, const Vector &atm_grid, const Vector &jac_grid, const bool &is_pressure)
	Calculate array of GridPos for perturbation interpolation. More...

void	get_perturbation_limit (ArrayOfIndex &limit, const Vector &pert_grid, const Vector &atm_limit)
	Get limits for perturbation of a box. More...

void	get_perturbation_range (Range &range, const Index &index, const Index &length)
	Get range for perturbation. More...

void	get_pointers_for_analytical_jacobians (ArrayOfIndex &abs_species_i, ArrayOfIndex &is_t, ArrayOfIndex &wind_i, const ArrayOfRetrievalQuantity &jacobian_quantities, const ArrayOfArrayOfSpeciesTag &abs_species)
	Help function for analytical jacobian calculations. More...

void	perturbation_field_1d (VectorView field, const ArrayOfGridPos &p_gp, const Index &p_pert_n, const Range &p_range, const Numeric &size, const Index &method)
	Calculate the 1D perturbation for a relative perturbation. More...

void	perturbation_field_2d (MatrixView field, const ArrayOfGridPos &p_gp, const ArrayOfGridPos &lat_gp, const Index &p_pert_n, const Index &lat_pert_n, const Range &p_range, const Range &lat_range, const Numeric &size, const Index &method)
	Calculate the 2D perturbation for a relative perturbation. More...

void	perturbation_field_3d (Tensor3View field, const ArrayOfGridPos &p_gp, const ArrayOfGridPos &lat_gp, const ArrayOfGridPos &lon_gp, const Index &p_pert_n, const Index &lat_pert_n, const Index &lon_pert_n, const Range &p_range, const Range &lat_range, const Range &lon_range, const Numeric &size, const Index &method)
	Calculate the 3D perturbation for a relative perturbation. More...

void	polynomial_basis_func (Vector &b, const Vector &x, const Index &poly_coeff)
	Calculates polynomial basis functions. More...

void	vmrunitscf (Numeric &x, const String &unit, const Numeric &vmr, const Numeric &p, const Numeric &t)
	vmrunitscf More...

Detailed Description

Declarations required for the calculation of jacobians.

Author: Mattias Ekstrom

Definition in file jacobian.h.

Macro Definition Documentation

◆ FOR_ANALYTICAL_JACOBIANS_DO

#define FOR_ANALYTICAL_JACOBIANS_DO ( what_to_do )

Value:

for( Index iq=0; iq<jacobian_quantities.nelem(); iq++ ) \
    { \
      if( jacobian_quantities[iq].Analytical() ) \
        { what_to_do } \
    }

Definition at line 114 of file jacobian.h.

Referenced by get_pointers_for_analytical_jacobians(), iyb_calc(), iyb_calc_za_loop_body(), iyEmissionStandard(), iyTransmissionStandard(), yCalc(), and yCalc_mblock_loop_body().

Typedef Documentation

◆ ArrayOfRetrievalQuantity

typedef Array<RetrievalQuantity> ArrayOfRetrievalQuantity

Definition at line 109 of file jacobian.h.

Function Documentation

◆ calc_nd_field()

void calc_nd_field	(	Tensor3View &	nd,
		const VectorView &	p,
		const Tensor3View &	t
	)

Calculate the number density field.

This function returns the number density for each grid point in the Tensor3View.

Parameters

nd	The number density field
p	The pressure grid
t	The temperature field

Author: Mattias Ekstrom

Date: 2005-06-03

Definition at line 347 of file jacobian.cc.

References ConstTensor3View::ncols(), ConstVectorView::nelem(), ConstTensor3View::npages(), ConstTensor3View::nrows(), and number_density().

Referenced by jacobianCalcAbsSpeciesPerturbations().

◆ check_retrieval_grids()

bool check_retrieval_grids	(	ArrayOfVector &	grids,
		ostringstream &	os,
		const Vector &	p_grid,
		const Vector &	lat_grid,
		const Vector &	lon_grid,
		const Vector &	p_retr,
		const Vector &	lat_retr,
		const Vector &	lon_retr,
		const String &	p_retr_name,
		const String &	lat_retr_name,
		const String &	lon_retr_name,
		const Index &	dim
	)

Check that the retrieval grids are defined for each atmosphere dim.

This function checks for the given atmosphere dimension that I) the retrieval grids are defined II) and that they are covered by the corresponding atmospheric grid. If not the return is false and an output string is created to print the error to the user. If the grids are ok they are stored in an array and true is returned.

Parameters

grids	The array of retrieval grids.
os	The output string stream.
p_grid	The atmospheric pressure grid
lat_grid	The atmospheric latitude grid
lon_grid	The atmospheric longitude grid
p_retr	The pressure retrieval grid.
lat_retr	The latitude retrieval grid.
lon_retr	The longitude retrieval grid.
p_retr_name	The control file name used for the pressure retrieval grid.
lat_retr_name	The control file name for the latitude retrieval grid.
lon_retr_name	The control file name for the longitude retrieval grid.
dim	The atmosphere dimension

Returns: Boolean for check.

Author: Mattias Ekstrom

Date: 2005-05-11

Definition at line 396 of file jacobian.cc.

References is_decreasing(), is_increasing(), and ConstVectorView::nelem().

Referenced by jacobianAddAbsSpecies(), jacobianAddTemperature(), and jacobianAddWind().

◆ diy_from_path_to_rgrids()

void diy_from_path_to_rgrids	(	Tensor3View	diy_dx,
		const RetrievalQuantity &	jacobian_quantity,
		ConstTensor3View	diy_dpath,
		const Index &	atmosphere_dim,
		const Ppath &	ppath,
		ConstVectorView	ppath_p
	)

Definition at line 110 of file jacobian.cc.

References add_extrap(), from_dpath_to_dx(), gp4length1grid(), gridpos(), RetrievalQuantity::Grids(), joker, Array< base >::nelem(), Ppath::np, p2gridpos(), and Ppath::pos.

Referenced by iyEmissionStandard(), and iyTransmissionStandard().

◆ get_perturbation_gridpos()

void get_perturbation_gridpos	(	ArrayOfGridPos &	gp,
		const Vector &	atm_grid,
		const Vector &	jac_grid,
		const bool &	is_pressure
	)

Calculate array of GridPos for perturbation interpolation.

This function constructs a perturbation grid which consists of the given retrieval grid with an extra endpoint added at each end. These endpoints lies outside the atmospheric grid. This enables the interpolation of an perturbation on the perturbation grid to be interpolated to the atmospheric grid. For this reason the function returns an ArrayOfGridPos.

If the atmospheric grid is a pressure grid, interpolation is made in logarithm of the atmospheric grid.

Parameters

gp	Array of GridPos for interpolation.
atm_grid	Atmospheric grid.
jac_grid	Retrieval grid.
is_pressure	True for pressure grid

Author: Mattias Ekstrom

Date: 2005-05-12

Definition at line 521 of file jacobian.cc.

References gridpos(), ConstVectorView::nelem(), and p2gridpos().

Referenced by jacobianCalcAbsSpeciesPerturbations(), and jacobianCalcTemperaturePerturbations().

◆ get_perturbation_limit()

void get_perturbation_limit	(	ArrayOfIndex &	limit,
		const Vector &	pert_grid,
		const Vector &	atm_limit
	)

Get limits for perturbation of a box.

This is a helper function that calculates the limits where the perturbation should be added to the perturbation grid. This is needed for example by the particle perturbation that only should be applied for the cloudbox. The limits are defined as the outermost points lying within or just outside the box limits.

The atmospheric limits should be given in the same unit as the perturbation grid. And only the first and last element will be considered as limits.

Assertions are used to perform checks. The input grids are checked so that the atmospheric limits are containg within the perturbation grid. The limit indices are checked so that they are ordered in increasing order before return.

Parameters

limit	The limit indices in the perturbation grid
pert_grid	The perturbation grid
atm_limit	The atmospheric limits of the box.

Author: Mattias Ekstrom

Date: 2005-02-25

Definition at line 580 of file jacobian.cc.

References is_decreasing(), and ConstVectorView::nelem().

◆ get_perturbation_range()

void get_perturbation_range	(	Range &	range,
		const Index &	index,
		const Index &	length
	)

Get range for perturbation.

This is a helper function that calculates the range in which the perturbation should be added to the perturbation grid. This is needed to handle the edge effects. At the edges we want the perturbation to continue outwards.

Parameters

range	The range in the perturbation grid.
index	The index of the perturbation in the retrieval grid.
length	The length of retrieval grid

Author: Mattias Ekstrom

Date: 2004-10-14

Definition at line 632 of file jacobian.cc.

Referenced by jacobianCalcAbsSpeciesPerturbations(), and jacobianCalcTemperaturePerturbations().

◆ get_pointers_for_analytical_jacobians()

void get_pointers_for_analytical_jacobians	(	ArrayOfIndex &	abs_species_i,
		ArrayOfIndex &	is_t,
		ArrayOfIndex &	wind_i,
		const ArrayOfRetrievalQuantity &	jacobian_quantities,
		const ArrayOfArrayOfSpeciesTag &	abs_species
	)

Help function for analytical jacobian calculations.

The function determines which terms in jacobian_quantities that are analytical absorption species and temperature jacobians.

abs_species_i* and is_t shall be sized to have the same length as jacobian_quantities. For analytical absorption species jacobians, abs_species_i is set to the matching index in abs_species*. Otherwise, to -1. For analytical temperature jacobians, is_t is set to 1. Otherwise to 0.

Parameters

abs_species_i	Out: Matching index in abs_species
is_t	Out: Flag for: Is a temperature jacobian?
jacobian_quantities	As the WSV.
abs_species	As the WSV.

Author: Patrick Eriksson

Date: 2009-10-07

Definition at line 292 of file jacobian.cc.

References array_species_tag_from_string(), chk_contains(), and FOR_ANALYTICAL_JACOBIANS_DO.

Referenced by iyEmissionStandard(), and iyTransmissionStandard().

◆ operator<<()

ostream& operator<<	(	ostream &	os,
		const RetrievalQuantity &	ot
	)

Output operator for RetrievalQuantity.

Author: Mattias Ekstrom

Definition at line 38 of file jacobian.cc.

References RetrievalQuantity::Analytical(), RetrievalQuantity::MainTag(), RetrievalQuantity::Mode(), and RetrievalQuantity::Subtag().

◆ perturbation_field_1d()

void perturbation_field_1d	(	VectorView	field,
		const ArrayOfGridPos &	p_gp,
		const Index &	p_pert_n,
		const Range &	p_range,
		const Numeric &	size,
		const Index &	method
	)

Calculate the 1D perturbation for a relative perturbation.

This is a helper function that interpolated the perturbation field for a 1D relative perturbation onto the atmospheric field.

Parameters

field	The interpolated perturbation field.
p_gp	The GridPos for interpolation.
p_pert_n	The number of perturbations.
p_range	The perturbation range in the perturbation grid.
size	The size of the perturbation.
method	Relative perturbation==0, absolute==1

Author: Mattias Ekstrom

Date: 2005-05-11

Definition at line 662 of file jacobian.cc.

References interp(), interpweights(), Array< base >::nelem(), and ConstVectorView::nelem().

Referenced by jacobianCalcAbsSpeciesPerturbations(), and jacobianCalcTemperaturePerturbations().

◆ perturbation_field_2d()

void perturbation_field_2d	(	MatrixView	field,
		const ArrayOfGridPos &	p_gp,
		const ArrayOfGridPos &	lat_gp,
		const Index &	p_pert_n,
		const Index &	lat_pert_n,
		const Range &	p_range,
		const Range &	lat_range,
		const Numeric &	size,
		const Index &	method
	)

Calculate the 2D perturbation for a relative perturbation.

This is a helper function that interpolated the perturbation field for a 2D relative perturbation onto the atmospheric field.

Parameters

field	The interpolated perturbation field.
p_gp	The GridPos for interpolation in the 1st dim.
lat_gp	The GridPos for interpolation in the 2nd dim.
p_pert_n	The number of perturbations in the 1st dim.
lat_pert_n	The number of perturbations in the 2nd dim.
p_range	The perturbation range in the 1st dim.
lat_range	The perturbation range in the 2nd dim.
size	The size of the perturbation.
method	Relative perturbation==0, absolute==1

Author: Mattias Ekstrom

Date: 2005-05-11

Definition at line 707 of file jacobian.cc.

References interp(), interpweights(), ConstMatrixView::ncols(), Array< base >::nelem(), and ConstMatrixView::nrows().

Referenced by jacobianCalcAbsSpeciesPerturbations(), and jacobianCalcTemperaturePerturbations().

◆ perturbation_field_3d()

void perturbation_field_3d	(	Tensor3View	field,
		const ArrayOfGridPos &	p_gp,
		const ArrayOfGridPos &	lat_gp,
		const ArrayOfGridPos &	lon_gp,
		const Index &	p_pert_n,
		const Index &	lat_pert_n,
		const Index &	lon_pert_n,
		const Range &	p_range,
		const Range &	lat_range,
		const Range &	lon_range,
		const Numeric &	size,
		const Index &	method
	)

Calculate the 3D perturbation for a relative perturbation.

This is a helper function that interpolated the perturbation field for a 3D relative perturbation onto the atmospheric field.

Parameters

field	The interpolated perturbation field.
p_gp	The GridPos for interpolation in the 1st dim.
lat_gp	The GridPos for interpolation in the 2nd dim.
lon_gp	The GridPos for interpolation in the 3rd dim.
p_pert_n	The number of perturbations in the 1st dim.
lat_pert_n	The number of perturbations in the 2nd dim.
lon_pert_n	The number of perturbations in the 3rd dim.
p_range	The perturbation range in the 1st dim.
lat_range	The perturbation range in the 2nd dim.
lon_range	The perturbation range in the 3rd dim.
size	The size of the perturbation.
method	Set to 0 for relative, and 1 for absolute.

Author: Mattias Ekstrom

Date: 2005-05-11

Definition at line 758 of file jacobian.cc.

References interp(), interpweights(), ConstTensor3View::ncols(), Array< base >::nelem(), ConstTensor3View::npages(), and ConstTensor3View::nrows().

Referenced by jacobianCalcAbsSpeciesPerturbations(), and jacobianCalcTemperaturePerturbations().

◆ polynomial_basis_func()

void polynomial_basis_func	(	Vector &	b,
		const Vector &	x,
		const Index &	poly_coeff
	)

Calculates polynomial basis functions.

The basis function is b(x) = 1 for poly_coeff = 0. For higher coefficients, x^poly_coeff - m, where first the range covered by x* is normalised to [-1,1] and m is selected in such way that sum(b) = 0.

Parameters

b	Calculated basis function.
x	The grid over which the fit shall be performed.
poly_coeff	Polynomial coefficient.

Author: Patrick Eriksson

Date: 2008-11-07

Definition at line 805 of file jacobian.cc.

References dx, max, mean(), min, ConstVectorView::nelem(), and Vector::resize().

Referenced by jacobianCalcFreqShift(), jacobianCalcFreqStretch(), jacobianCalcPointingZaInterp(), jacobianCalcPointingZaRecalc(), and jacobianCalcPolyfit().

◆ vmrunitscf()

void vmrunitscf	(	Numeric &	x,
		const String &	unit,
		const Numeric &	vmr,
		const Numeric &	p,
		const Numeric &	t
	)

vmrunitscf

Scale factor for conversion between gas species units.

The function finds the factor with which the total absorption of a gas species shall be multiplicated to match the selected (jacobian) unit.

Parameters

x	Out: scale factor
unit	Unit selected.
vmr	VMR value.
p	Pressure
t	Temperature.

Author: Patrick Eriksson

Date: 2009-10-08

Definition at line 853 of file jacobian.cc.

References number_density().

Referenced by iyEmissionStandard(), and iyTransmissionStandard().

Classes

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ FOR_ANALYTICAL_JACOBIANS_DO

Typedef Documentation

◆ ArrayOfRetrievalQuantity

Function Documentation

◆ calc_nd_field()

◆ check_retrieval_grids()

◆ diy_from_path_to_rgrids()

◆ get_perturbation_gridpos()

◆ get_perturbation_limit()

◆ get_perturbation_range()

◆ get_pointers_for_analytical_jacobians()

◆ operator<<()

◆ perturbation_field_1d()

◆ perturbation_field_2d()

◆ perturbation_field_3d()

◆ polynomial_basis_func()

◆ vmrunitscf()