atmfields_checkedCalc

Checks consistency of (clear sky) atmospheric fields.

The following WSVs are treated: p_grid, lat_grid, lon_grid, t_field, vmr_field, wind_u/v/w_field and mag_u/v/w_field.

If any of the variables above is changed, then this method shall be called again (no automatic check that this is fulfilled!).

The tests include that:

Atmospheric grids (p/lat/lon_grid) are OK with respect to atmosphere_dim (and vmr_field also regarding abs_species).
Atmospheric fields have sizes consistent with the atmospheric grids.
abs_f_interp_order is not zero if any wind is nonzero.
All values in t_field are > 0.

Default is that values in vmr_field are demanded to be >= 0 (ie. zero allowed, in contrast to t_field), but this requirement can be removed by the negative_vmr_ok argument.

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

The cloudbox is covered by cloudbox_checked, z_field is part of the checks done around atmgeom_checked.

Author(s): Patrick Eriksson

Parameters:

atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See atmfields_checked, defaults to self.atmfields_checked [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]
abs_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See abs_species, defaults to self.abs_species [IN]
t_field (Tensor3, optional) – The field of atmospheric temperatures. See t_field, defaults to self.t_field [IN]
vmr_field (Tensor4, optional) – VMR field. See vmr_field, defaults to self.vmr_field [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]
mag_u_field (Tensor3, optional) – Zonal component of the magnetic field. See mag_u_field, defaults to self.mag_u_field [IN]
mag_v_field (Tensor3, optional) – Meridional component of the magnetic field. See mag_v_field, defaults to self.mag_v_field [IN]
mag_w_field (Tensor3, optional) – Vertical component of the magnetic field. See mag_w_field, defaults to self.mag_w_field [IN]
abs_f_interp_order (Index, optional) – Frequency interpolation order for absorption lookup table. See abs_f_interp_order, defaults to self.abs_f_interp_order [IN]
negative_vmr_ok (Index, optional) – Flag whether to accept vmr_field < 0. Defaults to 0 [IN]
verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]