atmgeom_checkedCalc

Workspace.atmgeom_checkedCalc(self: pyarts.arts._Workspace, atmgeom_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmgeom_checked, atmosphere_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmosphere_dim, p_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.p_grid, lat_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lat_grid, lon_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lon_grid, z_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.z_field, refellipsoid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.refellipsoid, z_surface: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.z_surface, lat_true: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lat_true, lon_true: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lon_true, max500hpa_gradient: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = 500, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None

Checks consistency of geometric considerations of the atmosphere.

The following WSVs are checked: z_field, refellipsoid, z_surface, lat_true and lon_true. 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. refellipsoid has correct size, and that eccentricity is set to zero if 1D atmosphere.

  2. z_field and z_surface have sizes consistent with the atmospheric grids.

  3. There is no gap between z_surface and z_field.

  4. A rough search of maximum gradient of the altitude of the pressure level closest to 500 hPa is made. If this value exceeds the GIN max500hpa_gradient an error is issued. Please note that the unit of this GIN is m per 100km. For normal conditions on Earth, large scale gradients of the 500 hPa level is in the order of 20m/100km.

lat_true and lon_true are allowed to be empty.

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

See further atmgeom_checkedCalc().

Author(s): Patrick Eriksson

Parameters:
  • atmgeom_checked (Index, optional) – OK-flag for the geometry of the model atmosphere. See atmgeom_checked, defaults to self.atmgeom_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]

  • z_field (Tensor3, optional) – The field of geometrical altitudes. See z_field, defaults to self.z_field [IN]

  • refellipsoid (Vector, optional) – Reference ellipsoid. See refellipsoid, defaults to self.refellipsoid [IN]

  • z_surface (Matrix, optional) – The surface altitude. See z_surface, defaults to self.z_surface [IN]

  • lat_true (Vector, optional) – Latitudinal geolocation for 1D and 2D data. See lat_true, defaults to self.lat_true [IN]

  • lon_true (Vector, optional) – Longitudinal geolocation for 1D and 2D data. See lon_true, defaults to self.lon_true [IN]

  • max500hpa_gradient (Numeric, optional) – The maximum allowed gradient of 500 hPa pressure level [m/100km]. Defaults to 500 [IN]

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