cloudboxSetAutomatically

Workspace.cloudboxSetAutomatically(self: pyarts.arts._Workspace, cloudbox_on: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.cloudbox_on, cloudbox_limits: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfIndex]] = self.cloudbox_limits, atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, p_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.p_grid, lat_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.lat_grid, lon_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.lon_grid, particle_field: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Tensor4], cloudbox_margin: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = -1, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Sets the cloud box to encompass the cloud given by the entries in particle_field.

This WSM handles one Tensor4 type particle_field at a time. It can be used to determine the cloudbox from particle_bulkprop_field

The function must be called before executing any WSM that applies cloudbox_limits.

The function iterates over all 3D fields in particle_field (which might correspond to different particle bulk properties as in particle_bulkprop_field). Each field is searched for the first and last pressure index, where the value is unequal to zero. This index is then copied to cloudbox_limits. If particle_field is empty, the cloudbox is switched off (cloudbox_on = 0).

Additionaly the lower cloudbox_limit is altered by cloudbox_margin. The margin is given as a height difference in meters and transformed into a pressure (via isothermal barometric height formula). This alteration is to ensure covering photons that leave the cloud, but reenter through a limb path. If cloudbox_margin is set to -1 (default), the cloudbox will extend to the surface. Hence, the lower cloudbox_limit is set to 0 (index of first pressure level). cloudbox_margin will be applied on each call of the WSM.

Works only for atmosphere_dim == 1.

Author(s): Jana Mendrok, Daniel Kreyling

Parameters:

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

  • cloudbox_limits (ArrayOfIndex, optional) – The limits of the cloud box. See cloudbox_limits, defaults to self.cloudbox_limits [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]

  • particle_field (Tensor4) – A collection of particle property fields (e.g. particle_bulkprop_field). [IN]

  • cloudbox_margin (Numeric, optional) – Minimum distance [m] between lowest ‘cloudy’ level and cloudbox lower limit. If set to -1 (default), the cloudbox lower limit is fixed to 0, i.e., corresponds to the lowest atmospheric level (or the surface). Defaults to -1 [IN]

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