ARTS built-in documentation server

Workspace Method cloudbox_checkedCalc

Description

Checks consistency between cloudbox and particle variables.

The following WSVs are treated: cloudbox_on, cloudbox_limits,
pnd_field, scat_data_array, particle_masses and
wind_u/v/w_field.

If any of these variables are 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 particle variables match in size.

If any test fails, there is an error. Otherwise, cloudbox_checked
is set to 1.

Authors: Patrick Eriksson

Synopsis

cloudbox_checkedCalc(

cloudbox_checked, atmfields_checked, atmosphere_dim, p_grid, lat_grid, lon_grid, z_field, z_surface, wind_u_field, wind_v_field, wind_w_field, cloudbox_on, cloudbox_limits, pnd_field, scat_data_array, particle_masses, abs_species )

Variables

OUT	cloudbox_checked	(Index)	OK-flag for variables associated with the cloudbox.
IN	atmfields_checked	(Index)	OK-flag for atmospheric grids and (physical) fields.
IN	atmosphere_dim	(Index)	The atmospheric dimensionality (1-3).
IN	p_grid	(Vector)	The pressure grid.
IN	lat_grid	(Vector)	The latitude grid.
IN	lon_grid	(Vector)	The longitude grid.
IN	z_field	(Tensor3)	The field of geometrical altitudes.
IN	z_surface	(Matrix)	The surface altitude.
IN	wind_u_field	(Tensor3)	Zonal component of the wind field.
IN	wind_v_field	(Tensor3)	Meridional component of the magnetic field.
IN	wind_w_field	(Tensor3)	Vertical wind component field.
IN	cloudbox_on	(Index)	Flag to activate the cloud box.
IN	cloudbox_limits	(ArrayOfIndex)	The limits of the cloud box.
IN	pnd_field	(Tensor4)	Particle number density field.
IN	scat_data_array	(ArrayOfSingleScatteringData)	Raw data of single scattering data.
IN	particle_masses	(Matrix)	The mass of individual particles (or bulks).
IN	abs_species	(ArrayOfArrayOfSpeciesTag)	Tag groups for scalar gas absorption.