ARTS built-in documentation server

Workspace Method basics_checkedCalc

Description

Checks consistency of the (clear sky) atmosphere.

The following WSVs are treated: f_grid, stokes_dim, p_grid,
lat_grid, lon_grid, t_field, z_field, vmr_field, wind_u/v/w_field,
r_geoid and z_surface.
If any of these variables are changed, then this method shall be
called again (no automatic check that this is fulfilled!).

The tests include:
 1. That basic control variables stokes_dim and atmosphere_dim
    are inside defined ranges.
 2. That f_grid is sorted and increasing.
 3. If atmospheric grids (p/lat/lon_grid) are OK with respect to
    atmosphere_dim.
 4. If atmospheric fields, r_geoid and z_surface have sizes
    consistent with the atmospheric grids.
 5. There is no gap between z_surface and z_field.

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

The cloudbox is covered by cloudbox_checked.

Authors: Patrick Eriksson

Synopsis

basics_checkedCalc( basics_checked, atmosphere_dim, p_grid, lat_grid, lon_grid, abs_species, z_field, t_field, vmr_field, wind_u_field, wind_v_field, wind_w_field, r_geoid, z_surface, stokes_dim, f_grid )

Variables

OUTbasics_checked(Index)OK-flag for basic variables and grids.
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 scalar gas absorption.
INz_field(Tensor3)The field of geometrical altitudes.
INt_field(Tensor3)The field of atmospheric temperatures.
INvmr_field(Tensor4)VMR field.
INwind_u_field(Tensor3)Meridional (second horizontal wind) component field for 3D.
INwind_v_field(Tensor3)Horizontal 1D, 2D or 3D wind components.
INwind_w_field(Tensor3)Vertical wind component field.
INr_geoid(Matrix)Geoid radius.
INz_surface(Matrix)The surface altitude.
INstokes_dim(Index)The dimensionality of the Stokes vector (1-4).
INf_grid(Vector)The frequency grid for monochromatic pencil beam calculations.