pnd_fieldCalcFromParticleBulkProps

Workspace.pnd_fieldCalcFromParticleBulkProps(self: pyarts.arts._Workspace, pnd_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.pnd_field, dpnd_field_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfTensor4 | None = self.dpnd_field_dx, atmosphere_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmosphere_dim, p_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.p_grid, lat_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lat_grid, lon_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lon_grid, t_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.t_field, cloudbox_on: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.cloudbox_on, cloudbox_limits: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfIndex | None = self.cloudbox_limits, scat_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfString | None = self.scat_species, scat_data: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSingleScatteringData | None = self.scat_data, scat_meta: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfScatteringMetaData | None = self.scat_meta, particle_bulkprop_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.particle_bulkprop_field, particle_bulkprop_names: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfString | None = self.particle_bulkprop_names, pnd_agenda_array: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfAgenda | None = self.pnd_agenda_array, pnd_agenda_array_input_names: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfString | None = self.pnd_agenda_array_input_names, jacobian_do: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.jacobian_do, jacobian_quantities: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfRetrievalQuantity | None = self.jacobian_quantities, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) → None

Converts particle bulk property data to pnd_field.

In short, the method combines scat_species, pnd_agenda_array, particle_bulkprop_field and their associated variables to derive pnd_field.

The method does nothing if cloudbox is inactive.

Otherwise, cloudbox limits must be set before calling the method, and particle_bulkprop_field is checked to have non-zero elements just inside the cloudbox.

Author(s): Patrick Eriksson, Jana Mendrok

Parameters:

• pnd_field (Tensor4, optional) – Particle number density field. See pnd_field, defaults to self.pnd_field [OUT]

• dpnd_field_dx (ArrayOfTensor4, optional) – Partial derivatives of pnd_field. See dpnd_field_dx, defaults to self.dpnd_field_dx [OUT]

• 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]

• t_field (Tensor3, optional) – The field of atmospheric temperatures. See t_field, defaults to self.t_field [IN]

• cloudbox_on (Index, optional) – Flag to activate the cloud box. See cloudbox_on, defaults to self.cloudbox_on [IN]

• cloudbox_limits (ArrayOfIndex, optional) – The limits of the cloud box. See cloudbox_limits, defaults to self.cloudbox_limits [IN]

• scat_species (ArrayOfString, optional) – Array of Strings defining the scattering species to consider. See scat_species, defaults to self.scat_species [IN]

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

• scat_meta (ArrayOfArrayOfScatteringMetaData, optional) – An Array of scattering meta data (scat_meta_single). See scat_meta, defaults to self.scat_meta [IN]

• particle_bulkprop_field (Tensor4, optional) – Container for various data that describes scattering bulk properties. See particle_bulkprop_field, defaults to self.particle_bulkprop_field [IN]

• particle_bulkprop_names (ArrayOfString, optional) – Identification of the data in particle_bulkprop_field. See particle_bulkprop_names, defaults to self.particle_bulkprop_names [IN]

• pnd_agenda_array (ArrayOfAgenda, optional) – Returns particle number density data for each scattering species. See pnd_agenda_array, defaults to self.pnd_agenda_array [IN]

• pnd_agenda_array_input_names (ArrayOfArrayOfString, optional) – Naming of all input expected by pnd_agenda_array. See pnd_agenda_array_input_names, defaults to self.pnd_agenda_array_input_names [IN]

• jacobian_do (Index, optional) – Flag to activate (clear-sky) Jacobian calculations. See jacobian_do, defaults to self.jacobian_do [IN]

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

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