propmat_clearskyAddParticles

Workspace.propmat_clearskyAddParticles(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_temperature: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.rtp_temperature, scat_data: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSingleScatteringData | None = self.scat_data, scat_data_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.scat_data_checked, use_abs_as_ext: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 1, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None

Calculates absorption coefficients of particles to be used in clearsky (non-cloudbox) calculations.

This is a method to include particles (neglecting possible scattering components) in a clearsky calculation, i.e. without applying the cloudbox and scattering solvers. Particles are handled as absorbing species with one instance of ‘particles’ per scattering element considered added to abs_species. Particle absorption cross- sections at current atmospheric conditions are extracted from the single scattering data stored in scat_data, i.e., one array element per ‘particles’ instance in abs_species is required. Number densities are stored in vmr_field_raw or vmr_field as for all abs_species, but can be taken from (raw) pnd_field type data.

Note that the absorption coefficient is applied both in the extinction term (neglecting scattering out of the line of sight) and the emission term (neglecting the scattering source term, i.e. scattering into the line of sight).

Optionally, particle extinction (sum of absorption and scattering coefficient) can be used instead of absorption only. To choose this case, set the use_abs_as_ext flag to 0. However, be aware that this creates some unphysical emission term, hence is only suitable, where the source term is negligible anyways, e.g. for occultation simulations.

A line-of-sight direction rtp_los is required as particles can exhibit directional dependent absorption properties, which is taken into account by this method. ScatElementsToabs_speciesAdd() can be used to add all required settings/data for individual scattering elements at once, i.e. a ‘particles’ tag to abs_species, a set of single scattering data to scat_data and a number density field to vmr_field_raw (vmr_field is derived applying AtmFieldsCalc once VMRs for all abs_species have been added) is appended for each scattering element.

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): Jana Mendrok

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_temperature (Numeric, optional) – Temperature at a radiative transfer point. See rtp_temperature, defaults to self.rtp_temperature [IN]

  • scat_data (ArrayOfArrayOfSingleScatteringData, optional) – Array of single scattering data. See scat_data, defaults to self.scat_data [IN]

  • scat_data_checked (Index, optional) – OK-flag for scat_data. See scat_data_checked, defaults to self.scat_data_checked [IN]

  • use_abs_as_ext (Index, optional) – A flag with value 1 or 0. If set to one, particle absorption is used in extinction and emission parts of the RT equation, and scattering out of LOS as well as into LOS is neglected. Otherwise, particle extinction (absorption+scattering) is applied in both the extinction as well as the emission part of the RT equation. That is, true extinction is applied, but emission also includes a pseudo-emission contribution from the scattering coefficient. . Defaults to 1 [IN]

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