ARTS built-in documentation server

Workspace Method jacobianAddAbsSpecies


Includes an absorption species in the Jacobian.

For 1D or 2D calculations the latitude and/or longitude grid of
the retrieval field should set to have zero length.

These retrieval units are at hand for all gas species:
   "vmr"    : Volume mixing ratio.
   "nd"     : Number density.
   "rel"    : Relative unit (e.g. 1.1 means 10% more of the gas).

For water vapour, also these units are at hand:
   "rh"     : Relative humidity.
   "q"      : Specific humidity.

Note that *for_species_tag* is used to indicate if species tag VMR,
rather than atmospheric gas VMR is calculated. Set it to 0 and we
calculate the atmospheric gas VMR, but this only works for "analytical".

Note that the Jacobian is set to zero where volume mixing ratio equals zero.

The number of elements added to the state vector (x) is:
   n_g1 * n_g2 * n_g3
where n_g1, n_g2 and n_g3 are the length of GIN *g1*, *g2* and *g3*,
respectively. Here empty vectors should be considered to have a length 1.
The elements are sorted with pressure as innermost loop, followed by
latitude and longitude as outermost loop.

Authors: Mattias Ekstrom, Patrick Eriksson


jacobianAddAbsSpecies( jacobian_quantities, jacobian_agenda, atmosphere_dim, p_grid, lat_grid, lon_grid, g1, g2, g3, species, unit, for_species_tag )


OUT+INjacobian_quantities(ArrayOfRetrievalQuantity)The retrieval quantities in the Jacobian matrix.
OUT+INjacobian_agenda(Agenda)Pure numerical Jacobian calculation agenda.
INatmosphere_dim(Index)The atmospheric dimensionality (1-3).
INp_grid(Vector)The pressure grid.
INlat_grid(Vector)The latitude grid.
INlon_grid(Vector)The longitude grid.
GINg1(Vector)Pressure retrieval grid.
GINg2(Vector)Latitude retrieval grid.
GINg3(Vector)Longitude retreival grid.
GINspecies(String)The species tag of the retrieval quantity.
GINunit(String, Default: "vmr")Retrieval unit. See above.
GINfor_species_tag(Index, Default: 1)Index-bool for acting on species tags or species.