ARTS built-in documentation server

Workspace Method jacobianAddNLTE


Experimental NLTE Jacobian.

Intention: Adds the nlte_field level distribution per atmospheric grid
to the Jacobian.

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.

The QuantumIdentifier should identify a single energy level, such as:
"H2O-161 EN J 1 Ka 0 Kc 1", for one of the lower levels in the chains
of transitions of water.  Note that using this method directly is not
best practice, as the quantum identifiers of the levels have to be known
at an early stage in NLTE calculations, and will usually populate the
nlte_level_identifiers variable, meaning it is better to use jacobianAddNLTE
directly than to individually call this function.

Authors: Richard Larsson


jacobianAddNLTE( jacobian_quantities, jacobian_agenda, atmosphere_dim, p_grid, lat_grid, lon_grid, g1, g2, g3, energy_level_identity, dx )


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.
GINenergy_level_identity(QuantumIdentifier)Identifier to the eneregy level
GINdx(Numeric, Default: 1.0e-3)Perturbation of value if required by method