ARTS built-in documentation server

Workspace Method jacobianAddShapeCatalogParameter


Adds a line shape parameter to the Jacobian calculations. These
are constant over all levels so only a single x-value is added

Line function parameter assume the derivatives of internal pressure
broadening and line mixing functionality follows a f(T, T0, X0, X1, X2)
format. The shape of the function f() is determined by input
catalog; please see the ARTS documentation for more details.

The input are as follows:
  line_identity: Identifier of preferably a single line
  species:       A SpeciesTag, e.g., "O2" or "H2O" for common species.
                 Note that "SELF" and "AIR" tags are used for shape parameters
                 affected by self and air-broadening, respectively.
  variable:      A variable supported by the line, these can be
                    "G0":  Speed-independent pressure broadening
                    "G2":  Speed-dependent pressure broadening
                    "D0":  Speed-independent pressure shift
                    "D2":  Speed-dependent pressure shift
                    "FVC": Frequency of velocity changing collisions
                    "ETA": partial correlation between velocity and
                             rotational state changes due to collisions
                    "Y":   First order line-mixing parameter
                    "G":   Second order line-mixing parameter for strength
                    "DV":  Second order line-mixing parameter for shifting
  coefficient:   A coefficient in the model to compute the above parameters.

Note that we cannot test if the line in question supports the variable and
coefficient at the level of this function, so many errors will only be reported
at a later stage.

For other spectroscopic parameters, see jacobianAddBasicCatalogParameter.
Also see said function for an example of how to set the QuantumIdentifier.

Authors: Richard Larsson


jacobianAddShapeCatalogParameter( jacobian_quantities, jacobian_agenda, line_identity, species, variable, coefficient )


OUT+INjacobian_quantities(ArrayOfRetrievalQuantity)The retrieval quantities in the Jacobian matrix.
OUT+INjacobian_agenda(Agenda)Pure numerical Jacobian calculation agenda.
GINline_identity(QuantumIdentifier)Line identifier
GINspecies(String)Species of interest
GINvariable(String)Variable of interest
GINcoefficient(String)Coefficient of interest