cloudbox_checkedCalc
- Workspace.cloudbox_checkedCalc(self: pyarts.arts._Workspace, cloudbox_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.cloudbox_checked, atmfields_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmfields_checked, 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, z_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.z_field, z_surface: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.z_surface, wind_u_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.wind_u_field, wind_v_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.wind_v_field, wind_w_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.wind_w_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, 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, jacobian_quantities: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfRetrievalQuantity | None = self.jacobian_quantities, scat_data: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSingleScatteringData | None = self.scat_data, scat_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfString | None = self.scat_species, particle_masses: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.particle_masses, abs_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSpeciesTag | None = self.abs_species, demand_latlon_margin: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 1, negative_pnd_ok: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 0, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None
Checks consistency and validity of the cloudbox governing variables.
The following WSVs are treated:
cloudbox_on
,cloudbox_limits
,pnd_field
,scat_data
,scat_species
,abs_species
,particle_masses
particle_bulkprop_field
,particle_bulkprop_names
and wind_u/v/w_field.If any of these variables is changed, then this method shall be called again (no automatic check that this is fulfilled!).
The main checks are if the cloudbox limits are OK with respect to the atmospheric dimensionality and the limits of the atmosphere, and that the scattering element variables
pnd_field
andscat_data
match in size.Default is to demand that there is a margin between the cloudbox and the ends of latitide and longitude grids. Such margins are required by MC and DOIT/3D, but are not needed for e.g. IBA. If the margins not are a demand, set GIN demand_latlon_margin to 0.
Further checks on
scat_data
are performed inscat_data_checkedCalc()
scat_species
andparticle_masses
must either be empty or have a size that matches the other data. If non-empty, some check of these variables are performed.If any test fails, there is an error. Otherwise,
cloudbox_checked
is set to 1.Author(s): Patrick Eriksson, Jana Mendrok
- Parameters:
cloudbox_checked (Index, optional) – OK-flag for variables associated with the cloudbox. See
cloudbox_checked
, defaults toself.cloudbox_checked
[OUT]atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See
atmfields_checked
, defaults toself.atmfields_checked
[IN]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]z_field (Tensor3, optional) – The field of geometrical altitudes. See
z_field
, defaults toself.z_field
[IN]z_surface (Matrix, optional) – The surface altitude. See
z_surface
, defaults toself.z_surface
[IN]wind_u_field (Tensor3, optional) – Zonal component of the wind field. See
wind_u_field
, defaults toself.wind_u_field
[IN]wind_v_field (Tensor3, optional) – Meridional component of the magnetic field. See
wind_v_field
, defaults toself.wind_v_field
[IN]wind_w_field (Tensor3, optional) – Vertical wind component field. See
wind_w_field
, defaults toself.wind_w_field
[IN]cloudbox_on (Index, optional) – Flag to activate the cloud box. See
cloudbox_on
, defaults toself.cloudbox_on
[IN]cloudbox_limits (ArrayOfIndex, optional) – The limits of the cloud box. See
cloudbox_limits
, defaults toself.cloudbox_limits
[IN]pnd_field (Tensor4, optional) – Particle number density field. See
pnd_field
, defaults toself.pnd_field
[IN]dpnd_field_dx (ArrayOfTensor4, optional) – Partial derivatives of
pnd_field
. Seedpnd_field_dx
, defaults toself.dpnd_field_dx
[IN]jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See
jacobian_quantities
, defaults toself.jacobian_quantities
[IN]scat_data (ArrayOfArrayOfSingleScatteringData, optional) – Array of single scattering data. See
scat_data
, defaults toself.scat_data
[IN]scat_species (ArrayOfString, optional) – Array of Strings defining the scattering species to consider. See
scat_species
, defaults toself.scat_species
[IN]particle_masses (Matrix, optional) – The mass of individual particles (or bulks). See
particle_masses
, defaults toself.particle_masses
[IN]abs_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See
abs_species
, defaults toself.abs_species
[IN]demand_latlon_margin (Index, optional) – Flag to demand margin or not w.r.t. to ends of lat/lon grids. Defaults to
1
[IN]negative_pnd_ok (Index, optional) – Flag whether to accept pnd_field < 0. Defaults to
0
[IN]verbosity (Verbosity) – ARTS verbosity. See
verbosity
, defaults toself.verbosity
[IN]