ARTS built-in documentation server

Workspace Method atmfields_checkedCalc

Description

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:
 1. Atmospheric grids (p/lat/lon_grid) are OK with respect to
    atmosphere_dim (and vmr_field also regarding abs_species).
 2. Atmospheric fields have sizes consistent with the atmospheric
    grids.
 3. abs_f_interp_order is not zero if any wind is nonzero.
 4. 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.

If you choose to use *bad_partition_functions_ok* please note that
this is done on your own risk and that it could introduce hard-to-
track errors into your calculations.  Do not use this for anything
important.

Authors: Patrick Eriksson

Synopsis

atmfields_checkedCalc( atmfields_checked, atmosphere_dim, p_grid, lat_grid, lon_grid, abs_species, t_field, vmr_field, wind_u_field, wind_v_field, wind_w_field, mag_u_field, mag_v_field, mag_w_field, partition_functions, abs_f_interp_order, negative_vmr_ok, bad_partition_functions_ok )

Variables

OUTatmfields_checked(Index)OK-flag for atmospheric grids and (physical) fields.
INatmosphere_dim(Index)The atmospheric dimensionality (1-3).
INp_grid(Vector)The pressure grid.
INlat_grid(Vector)The latitude grid.
INlon_grid(Vector)The longitude grid.
INabs_species(ArrayOfArrayOfSpeciesTag)Tag groups for gas absorption.
INt_field(Tensor3)The field of atmospheric temperatures.
INvmr_field(Tensor4)VMR field.
INwind_u_field(Tensor3)Zonal component of the wind field.
INwind_v_field(Tensor3)Meridional component of the magnetic field.
INwind_w_field(Tensor3)Vertical wind component field.
INmag_u_field(Tensor3)Zonal component of the magnetic field.
INmag_v_field(Tensor3)Meridional component of the magnetic field.
INmag_w_field(Tensor3)Vertical component of the magnetic field.
INpartition_functions(SpeciesAuxData)Partition functions.
INabs_f_interp_order(Index)Frequency interpolation order for absorption lookup table.
GINnegative_vmr_ok(Index, Default: 0)Flag whether to accept vmr_field < 0.
GINbad_partition_functions_ok(Index, Default: 0)Flag whether to accept partition functions not covering t_field range.