ARTS built-in documentation server

Workspace Method nlte_fieldForSingleSpeciesNonOverlappingLines

Description

NLTE field for a simple setup.

This will solve for nlte_field in the input atmosphere.
The solver depends on the lines not overlapping and that there
is only a single species in the atmosphere.

Authors: Richard Larsson

Synopsis

nlte_fieldForSingleSpeciesNonOverlappingLines(

nlte_field, abs_species, abs_lines_per_species, collision_coefficients, collision_line_identifiers, isotopologue_ratios, iy_main_agenda, ppath_agenda, iy_space_agenda, iy_surface_agenda, iy_cloudbox_agenda, propmat_clearsky_agenda, water_p_eq_agenda, vmr_field, t_field, z_field, p_grid, atmosphere_dim, refellipsoid, surface_props_data, nlte_do, df, convergence_limit, nz, nf, dampened, iteration_limit )

Variables

OUT+IN	nlte_field	(EnergyLevelMap)	The field of NLTE temperatures and/or ratios.
IN	abs_species	(ArrayOfArrayOfSpeciesTag)	Tag groups for gas absorption.
IN	abs_lines_per_species	(ArrayOfArrayOfAbsorptionLines)	A list of spectral line data for each tag.
IN	collision_coefficients	(ArrayOfArrayOfGriddedField1)	An array of coefficients for effective collisions
IN	collision_line_identifiers	(ArrayOfQuantumIdentifier)	An array of quantum identifiers for finding collisional rates
IN	isotopologue_ratios	(SpeciesAuxData)	Contains the isotopologue ratios.
IN	iy_main_agenda	(Agenda)	Agenda calculating the single monochromatic pencil beam spectrum.
IN	ppath_agenda	(Agenda)	Agenda calculating complete propagation paths.
IN	iy_space_agenda	(Agenda)	Agenda providing the downwelling radiation at the top of the atmosphere.
IN	iy_surface_agenda	(Agenda)	Agenda providing the upwelling radiation from the surface.
IN	iy_cloudbox_agenda	(Agenda)	Agenda deriving the intensity at boundary or interior of the cloudbox.
IN	propmat_clearsky_agenda	(Agenda)	Agenda calculating the absorption coefficient matrices.
IN	water_p_eq_agenda	(Agenda)	Agenda to calculate the saturation pressure of water.
IN	vmr_field	(Tensor4)	VMR field.
IN	t_field	(Tensor3)	The field of atmospheric temperatures.
IN	z_field	(Tensor3)	The field of geometrical altitudes.
IN	p_grid	(Vector)	The pressure grid.
IN	atmosphere_dim	(Index)	The atmospheric dimensionality (1-3).
IN	refellipsoid	(Vector)	Reference ellipsoid.
IN	surface_props_data	(Tensor3)	Various surface properties.
IN	nlte_do	(Index)	Flag to perform Non-LTE calculations.
GIN	df	(Numeric)	relative frequency to line center
GIN	convergence_limit	(Numeric, Default: 1e-6)	max relative change in ratio of level to stop iterations
GIN	nz	(Index)	number of zenith angles
GIN	nf	(Index)	number of frequency grid-points per line
GIN	dampened	(Index)	use transmission dampening or not
GIN	iteration_limit	(Index, Default: 20)	max number of iterations before defaul break of iterations