jacobianAddMagField

Workspace.jacobianAddMagField(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], component: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String]] = "v", dB: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = 1.0e-7, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Includes one magnetic field component in the Jacobian.

The method follows the pattern of other Jacobian methods. The calculations can only be performed by analytic expressions.

The magnetic field components are retrieved separately, and, hence, the argument component can be “u”, “v”, “w”, and “strength”.

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 dB-parameter is only used for Faraday rotation.

Author(s): Patrick Eriksson, Richard Larsson

Parameters:

  • jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [INOUT]

  • jacobian_agenda (Agenda, optional) – Pure numerical Jacobian calculations. See jacobian_agenda, defaults to self.jacobian_agenda [INOUT]

  • atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See atmosphere_dim, defaults to self.atmosphere_dim [IN]

  • p_grid (Vector, optional) – The pressure grid. See p_grid, defaults to self.p_grid [IN]

  • lat_grid (Vector, optional) – The latitude grid. See lat_grid, defaults to self.lat_grid [IN]

  • lon_grid (Vector, optional) – The longitude grid. See lon_grid, defaults to self.lon_grid [IN]

  • g1 (Vector) – Pressure retrieval grid. [IN]

  • g2 (Vector) – Latitude retrieval grid. [IN]

  • g3 (Vector) – Longitude retreival grid. [IN]

  • component (String, optional) – Magnetic field component to retrieve. Defaults to "v" [IN]

  • dB (Numeric, optional) – Magnetic field perturbation. Defaults to 1.0e-7 [IN]

  • verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]