x2artsAtmAndSurf

Maps x to atmospheric and surface variables.

Maps OEM’s state vector, x, to the matching ARTS variables. This method handles atmospheric and surface variables. If you retrieve other variables, make sure that you also call x2artsSensor() and/or x2artsSpectroscopy().

The following retrieval quantities are handled by this method:

Temperature

Absorption species

Scattering species

Winds

Surface variables

Should only be used inside inversion_iterate_agenda.

Author(s): Patrick Eriksson

Parameters:

vmr_field (Tensor4, optional) – VMR field. See vmr_field, defaults to self.vmr_field [INOUT]
t_field (Tensor3, optional) – The field of atmospheric temperatures. See t_field, defaults to self.t_field [INOUT]
particle_bulkprop_field (Tensor4, optional) – Container for various data that describes scattering bulk properties. See particle_bulkprop_field, defaults to self.particle_bulkprop_field [INOUT]
wind_u_field (Tensor3, optional) – Zonal component of the wind field. See wind_u_field, defaults to self.wind_u_field [INOUT]
wind_v_field (Tensor3, optional) – Meridional component of the magnetic field. See wind_v_field, defaults to self.wind_v_field [INOUT]
wind_w_field (Tensor3, optional) – Vertical wind component field. See wind_w_field, defaults to self.wind_w_field [INOUT]
mag_u_field (Tensor3, optional) – Zonal component of the magnetic field. See mag_u_field, defaults to self.mag_u_field [INOUT]
mag_v_field (Tensor3, optional) – Meridional component of the magnetic field. See mag_v_field, defaults to self.mag_v_field [INOUT]
mag_w_field (Tensor3, optional) – Vertical component of the magnetic field. See mag_w_field, defaults to self.mag_w_field [INOUT]
surface_props_data (Tensor3, optional) – Various surface properties. See surface_props_data, defaults to self.surface_props_data [INOUT]
jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [IN]
x (Vector, optional) – The state vector. See x, defaults to self.x [IN]
atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See atmfields_checked, defaults to self.atmfields_checked [IN]
atmgeom_checked (Index, optional) – OK-flag for the geometry of the model atmosphere. See atmgeom_checked, defaults to self.atmgeom_checked [IN]
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]
cloudbox_on (Index, optional) – Flag to activate the cloud box. See cloudbox_on, defaults to self.cloudbox_on [IN]
cloudbox_checked (Index, optional) – OK-flag for variables associated with the cloudbox. See cloudbox_checked, defaults to self.cloudbox_checked [IN]
particle_bulkprop_names (ArrayOfString, optional) – Identification of the data in particle_bulkprop_field. See particle_bulkprop_names, defaults to self.particle_bulkprop_names [IN]
surface_props_names (ArrayOfString, optional) – Name on surface properties found in surface_props_data. See surface_props_names, defaults to self.surface_props_names [IN]
water_p_eq_agenda (Agenda, optional) – Calculation of the saturation pressure of water. See water_p_eq_agenda, defaults to self.water_p_eq_agenda [IN]
verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]