cloudbox_checkedCalc

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 and scat_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 in scat_data_checkedCalc()

scat_species and particle_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 to self.cloudbox_checked [OUT]
atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See atmfields_checked, defaults to self.atmfields_checked [IN]
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]
z_field (Tensor3, optional) – The field of geometrical altitudes. See z_field, defaults to self.z_field [IN]
z_surface (Matrix, optional) – The surface altitude. See z_surface, defaults to self.z_surface [IN]
wind_u_field (Tensor3, optional) – Zonal component of the wind field. See wind_u_field, defaults to self.wind_u_field [IN]
wind_v_field (Tensor3, optional) – Meridional component of the magnetic field. See wind_v_field, defaults to self.wind_v_field [IN]
wind_w_field (Tensor3, optional) – Vertical wind component field. See wind_w_field, defaults to self.wind_w_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]
pnd_field (Tensor4, optional) – Particle number density field. See pnd_field, defaults to self.pnd_field [IN]
dpnd_field_dx (ArrayOfTensor4, optional) – Partial derivatives of pnd_field. See dpnd_field_dx, defaults to self.dpnd_field_dx [IN]
jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [IN]
scat_data (ArrayOfArrayOfSingleScatteringData, optional) – Array of single scattering data. See scat_data, defaults to self.scat_data [IN]
scat_species (ArrayOfString, optional) – Array of Strings defining the scattering species to consider. See scat_species, defaults to self.scat_species [IN]
particle_masses (Matrix, optional) – The mass of individual particles (or bulks). See particle_masses, defaults to self.particle_masses [IN]
abs_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See abs_species, defaults to self.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 to self.verbosity [IN]