z_fieldFromHSE

Workspace.z_fieldFromHSE(self: pyarts.arts._Workspace, z_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.z_field, 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, lat_true: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lat_true, lon_true: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lon_true, abs_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSpeciesTag | None = self.abs_species, t_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.t_field, vmr_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.vmr_field, refellipsoid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.refellipsoid, z_surface: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.z_surface, atmfields_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmfields_checked, g0_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.g0_agenda, molarmass_dry_air: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.molarmass_dry_air, p_hse: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.p_hse, z_hse_accuracy: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.z_hse_accuracy, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) → None

Force altitudes to fulfil hydrostatic equilibrium.

The method applies hydrostatic equilibrium. A mixture of “dry air” and water vapour (if present as abs_species tag) is assumed. That is, the air is assumed to be well mixed and its weight, apart from the water vapour, is constant (molarmass_dry_air). In addition, the effect of any particles (including liquid and ice particles) is neglected.

The output is an update of z_field. This variable is expected to contain approximative altitudes when calling the function. The altitude matching p_hse is kept constant. Other input altitudes can basically be arbitrary, but good estimates give quicker calculations.

The calculations are repeated until the change in altitude is below z_hse_accuracy. An iterative process is needed as gravity varies with altitude.

For 1D and 2D, the geographical position is taken from lat_true and lon_true.

Author(s): Patrick Eriksson

Parameters:

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

  • 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]

  • 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]

  • 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]

  • 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]

  • atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See atmfields_checked, defaults to self.atmfields_checked [IN]

  • g0_agenda (Agenda, optional) – Calculation of the gravity at zero altitude. See g0_agenda, defaults to self.g0_agenda [IN]

  • molarmass_dry_air (Numeric, optional) – The average molar mass of dry air. See molarmass_dry_air, defaults to self.molarmass_dry_air [IN]

  • p_hse (Numeric, optional) – Reference pressure calculation of hydrostatic equilibrium. See p_hse, defaults to self.p_hse [IN]

  • z_hse_accuracy (Numeric, optional) – Minimum accuracy for calculation of hydrostatic equilibrium. See z_hse_accuracy, defaults to self.z_hse_accuracy [IN]

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