ARTS built-in documentation server

Workspace Method x2artsAtmAndSurf

Description

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.

Authors: Patrick Eriksson

Synopsis

x2artsAtmAndSurf(

vmr_field, t_field, particle_bulkprop_field, wind_u_field, wind_v_field, wind_w_field, mag_u_field, mag_v_field, mag_w_field, surface_props_data, jacobian_quantities, x, atmfields_checked, atmgeom_checked, atmosphere_dim, p_grid, lat_grid, lon_grid, abs_species, cloudbox_on, cloudbox_checked, particle_bulkprop_names, surface_props_names, water_p_eq_agenda )

Variables

OUT+IN	vmr_field	(Tensor4)	VMR field.
OUT+IN	t_field	(Tensor3)	The field of atmospheric temperatures.
OUT+IN	particle_bulkprop_field	(Tensor4)	Container for various data that describes scattering bulk properties.
OUT+IN	wind_u_field	(Tensor3)	Zonal component of the wind field.
OUT+IN	wind_v_field	(Tensor3)	Meridional component of the magnetic field.
OUT+IN	wind_w_field	(Tensor3)	Vertical wind component field.
OUT+IN	mag_u_field	(Tensor3)	Zonal component of the magnetic field.
OUT+IN	mag_v_field	(Tensor3)	Meridional component of the magnetic field.
OUT+IN	mag_w_field	(Tensor3)	Vertical component of the magnetic field.
OUT+IN	surface_props_data	(Tensor3)	Various surface properties.
IN	jacobian_quantities	(ArrayOfRetrievalQuantity)	The retrieval quantities in the Jacobian matrix.
IN	x	(Vector)	The state vector.
IN	atmfields_checked	(Index)	OK-flag for atmospheric grids and (physical) fields.
IN	atmgeom_checked	(Index)	OK-flag for the geometry of the model atmosphere.
IN	atmosphere_dim	(Index)	The atmospheric dimensionality (1-3).
IN	p_grid	(Vector)	The pressure grid.
IN	lat_grid	(Vector)	The latitude grid.
IN	lon_grid	(Vector)	The longitude grid.
IN	abs_species	(ArrayOfArrayOfSpeciesTag)	Tag groups for gas absorption.
IN	cloudbox_on	(Index)	Flag to activate the cloud box.
IN	cloudbox_checked	(Index)	OK-flag for variables associated with the cloudbox.
IN	particle_bulkprop_names	(ArrayOfString)	Identification of the data in particle_bulkprop_field.
IN	surface_props_names	(ArrayOfString)	Name on surface properties found in surface_props_data.
IN	water_p_eq_agenda	(Agenda)	Agenda to calculate the saturation pressure of water.