jacobianAddSpecialSpecies
- Workspace.jacobianAddSpecialSpecies(self: pyarts.arts._Workspace, jacobian_quantities: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfRetrievalQuantity]] = self.jacobian_quantities, jacobian_agenda: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Agenda]] = self.jacobian_agenda, atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, p_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.p_grid, lat_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.lat_grid, lon_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.lon_grid, g1: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], g2: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], g3: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], species: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) None
Includes a special absorption species in the Jacobian.
Similar to
jacobianAddAbsSpecies()
but only for number densities.Species allowed are:
“electrons”
“particulates”
Note that the average of all particulates are used to scale its
jacobian
, so this method works best when only one type of particulate is being used, i.e., whenscat_data
has only one scattering species.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
andg3
, 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.Author(s): Richard Larsson
- Parameters:
jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See
jacobian_quantities
, defaults toself.jacobian_quantities
[INOUT]jacobian_agenda (Agenda, optional) – Pure numerical Jacobian calculations. See
jacobian_agenda
, defaults toself.jacobian_agenda
[INOUT]atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See
atmosphere_dim
, defaults toself.atmosphere_dim
[IN]p_grid (Vector, optional) – The pressure grid. See
p_grid
, defaults toself.p_grid
[IN]lat_grid (Vector, optional) – The latitude grid. See
lat_grid
, defaults toself.lat_grid
[IN]lon_grid (Vector, optional) – The longitude grid. See
lon_grid
, defaults toself.lon_grid
[IN]g1 (Vector) – Pressure retrieval grid. [IN]
g2 (Vector) – Latitude retrieval grid. [IN]
g3 (Vector) – Longitude retreival grid. [IN]
species (String) – The species of the retrieval quantity. [IN]
verbosity (Verbosity) – ARTS verbosity. See
verbosity
, defaults toself.verbosity
[IN]