propmat_clearskyAddFaraday

Workspace.propmat_clearskyAddFaraday(self: pyarts.arts._Workspace, propmat_clearsky: pyarts.arts.WorkspaceVariable | pyarts.arts.PropagationMatrix | None = self.propmat_clearsky, dpropmat_clearsky_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfPropagationMatrix | None = self.dpropmat_clearsky_dx, stokes_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.stokes_dim, atmosphere_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmosphere_dim, f_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.f_grid, abs_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSpeciesTag | None = self.abs_species, select_abs_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfSpeciesTag | None = self.select_abs_species, jacobian_quantities: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfRetrievalQuantity | None = self.jacobian_quantities, rtp_vmr: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rtp_vmr, rtp_los: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rtp_los, rtp_mag: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rtp_mag, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None

Calculates absorption matrix describing Faraday rotation.

Faraday rotation is a change of polarization state of an electromagnetic wave propagating through charged matter by interaction with a magnetic field. Hence, this method requires abs_species to contain ‘free_electrons’ and electron content field (as part of vmr_field) as well as magnetic field (mag_u_field, mag_v_field, mag_w_field) to be specified.

Faraday rotation affects Stokes parameters 2 and 3 (but not intensity!). Therefore, this method requires stokes_dim>2.

Like all ‘propmat_clearskyAdd*’ methods, the method is additive, i.e., does not overwrite the propagation matrix propmat_clearsky, but adds further contributions.

Author(s): Patrick Eriksson

Parameters:
  • propmat_clearsky (PropagationMatrix, optional) – This contains the absorption coefficients for one point in the atmosphere. See propmat_clearsky, defaults to self.propmat_clearsky [INOUT]

  • dpropmat_clearsky_dx (ArrayOfPropagationMatrix, optional) – Partial derivative of absorption coefficients. See dpropmat_clearsky_dx, defaults to self.dpropmat_clearsky_dx [INOUT]

  • stokes_dim (Index, optional) – The dimensionality of the Stokes vector (1-4). See stokes_dim, defaults to self.stokes_dim [IN]

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

  • f_grid (Vector, optional) – The frequency grid for monochromatic pencil beam calculations. See f_grid, defaults to self.f_grid [IN]

  • abs_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See abs_species, defaults to self.abs_species [IN]

  • select_abs_species (ArrayOfSpeciesTag, optional) – A select species tag group from abs_species. See select_abs_species, defaults to self.select_abs_species [IN]

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

  • rtp_vmr (Vector, optional) – Absorption species abundances for radiative transfer calculations. See rtp_vmr, defaults to self.rtp_vmr [IN]

  • rtp_los (Vector, optional) – Line-of-sight at a radiative transfer point. See rtp_los, defaults to self.rtp_los [IN]

  • rtp_mag (Vector, optional) – Magnetic field at a radiative transfer point. See rtp_mag, defaults to self.rtp_mag [IN]

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