ARTS
2.4.0(git:4fb77825)
|
User interface to NLTE variables and functions. More...
#include "absorption.h"
#include "arts.h"
#include "auto_md.h"
#include "lin_alg.h"
#include "nlte.h"
Go to the source code of this file.
Functions | |
void | ArrayOfQuantumIdentifierFromLines (ArrayOfQuantumIdentifier &qid, const ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const Index &global, const Verbosity &) |
WORKSPACE METHOD: ArrayOfQuantumIdentifierFromLines. More... | |
void | nlte_fieldRescalePopulationLevels (EnergyLevelMap &nlte_field, const Numeric &scale, const Verbosity &) |
WORKSPACE METHOD: nlte_fieldRescalePopulationLevels. More... | |
void | nlte_fieldForSingleSpeciesNonOverlappingLines (Workspace &ws, EnergyLevelMap &nlte_field, const ArrayOfArrayOfSpeciesTag &abs_species, const ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfGriddedField1 &collision_coefficients, const ArrayOfQuantumIdentifier &collision_line_identifiers, const SpeciesAuxData &isotopologue_ratios, const Agenda &iy_main_agenda, const Agenda &ppath_agenda, const Agenda &iy_space_agenda, const Agenda &iy_surface_agenda, const Agenda &iy_cloudbox_agenda, const Agenda &propmat_clearsky_agenda, const Agenda &, const Tensor4 &vmr_field, const Tensor3 &t_field, const Tensor3 &z_field, const Vector &p_grid, const Index &atmosphere_dim, const Vector &refellipsoid, const Tensor3 &surface_props_data, const Index &nlte_do, const Numeric &df, const Numeric &convergence_limit, const Index &nz, const Index &nf, const Index &dampened, const Index &iteration_limit, const Verbosity &verbosity) |
WORKSPACE METHOD: nlte_fieldForSingleSpeciesNonOverlappingLines. More... | |
void | collision_coefficientsFromSplitFiles (ArrayOfArrayOfGriddedField1 &collision_coefficients, ArrayOfQuantumIdentifier &collision_line_identifiers, const ArrayOfArrayOfSpeciesTag &abs_species, const String &basename, const Verbosity &verbosity) |
WORKSPACE METHOD: collision_coefficientsFromSplitFiles. More... | |
void | nlteOff (Index &nlte_do, EnergyLevelMap &nlte_field, ArrayOfQuantumIdentifier &nlte_level_identifiers, const Verbosity &) |
WORKSPACE METHOD: nlteOff. More... | |
void ArrayOfQuantumIdentifierFromLines | ( | ArrayOfQuantumIdentifier & | out, |
const ArrayOfArrayOfAbsorptionLines & | abs_lines_per_species, | ||
const Index & | global, | ||
const Verbosity & | verbosity | ||
) |
WORKSPACE METHOD: ArrayOfQuantumIdentifierFromLines.
Sets an ArrayOfQuantumIdentifier to all levels in abs_lines_per_species with defined quantum numbers
Lines without defined quantum numbers are ignored
[out] | out | Generic output |
[in] | abs_lines_per_species | WS Input |
[in] | global | Generic Input (Default: "1") |
Definition at line 34 of file m_nlte.cc.
References ARTS::Var::abs_lines_per_species().
Referenced by ArrayOfQuantumIdentifierFromLines_g().
void collision_coefficientsFromSplitFiles | ( | ArrayOfArrayOfGriddedField1 & | collision_coefficients, |
ArrayOfQuantumIdentifier & | collision_line_identifiers, | ||
const ArrayOfArrayOfSpeciesTag & | abs_species, | ||
const String & | basename, | ||
const Verbosity & | verbosity | ||
) |
WORKSPACE METHOD: collision_coefficientsFromSplitFiles.
Reads collision_coefficients and collision_line_identifiers from location on filesystem with many species. The species in this location must match abs_species. The location must also contain an ArrayOfQuantumIdentifier file ending with qid.xml
[out] | collision_coefficients | WS Output |
[out] | collision_line_identifiers | WS Output |
[in] | abs_species | WS Input |
[in] | basename | Generic Input (Default: "./") |
Definition at line 245 of file m_nlte.cc.
References ARTS::Var::abs_species(), check_collision_line_identifiers(), ARTS::Var::collision_coefficients(), ARTS::Var::collision_line_identifiers(), Array< base >::nelem(), ARTS::Var::verbosity(), and xml_read_from_file().
Referenced by collision_coefficientsFromSplitFiles_g().
void nlte_fieldForSingleSpeciesNonOverlappingLines | ( | Workspace & | ws, |
EnergyLevelMap & | nlte_field, | ||
const ArrayOfArrayOfSpeciesTag & | abs_species, | ||
const ArrayOfArrayOfAbsorptionLines & | abs_lines_per_species, | ||
const ArrayOfArrayOfGriddedField1 & | collision_coefficients, | ||
const ArrayOfQuantumIdentifier & | collision_line_identifiers, | ||
const SpeciesAuxData & | isotopologue_ratios, | ||
const Agenda & | iy_main_agenda, | ||
const Agenda & | ppath_agenda, | ||
const Agenda & | iy_space_agenda, | ||
const Agenda & | iy_surface_agenda, | ||
const Agenda & | iy_cloudbox_agenda, | ||
const Agenda & | propmat_clearsky_agenda, | ||
const Agenda & | water_p_eq_agenda, | ||
const Tensor4 & | vmr_field, | ||
const Tensor3 & | t_field, | ||
const Tensor3 & | z_field, | ||
const Vector & | p_grid, | ||
const Index & | atmosphere_dim, | ||
const Vector & | refellipsoid, | ||
const Tensor3 & | surface_props_data, | ||
const Index & | nlte_do, | ||
const Numeric & | df, | ||
const Numeric & | convergence_limit, | ||
const Index & | nz, | ||
const Index & | nf, | ||
const Index & | dampened, | ||
const Index & | iteration_limit, | ||
const Verbosity & | verbosity | ||
) |
WORKSPACE METHOD: nlte_fieldForSingleSpeciesNonOverlappingLines.
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.
[in,out] | ws | Workspace |
[in,out] | nlte_field | WS Input/Output |
[in] | abs_species | WS Input |
[in] | abs_lines_per_species | WS Input |
[in] | collision_coefficients | WS Input |
[in] | collision_line_identifiers | WS Input |
[in] | isotopologue_ratios | WS Input |
[in] | iy_main_agenda | WS Input |
[in] | ppath_agenda | WS Input |
[in] | iy_space_agenda | WS Input |
[in] | iy_surface_agenda | WS Input |
[in] | iy_cloudbox_agenda | WS Input |
[in] | propmat_clearsky_agenda | WS Input |
[in] | water_p_eq_agenda | WS Input |
[in] | vmr_field | WS Input |
[in] | t_field | WS Input |
[in] | z_field | WS Input |
[in] | p_grid | WS Input |
[in] | atmosphere_dim | WS Input |
[in] | refellipsoid | WS Input |
[in] | surface_props_data | WS Input |
[in] | nlte_do | WS Input |
[in] | df | Generic Input |
[in] | convergence_limit | Generic Input (Default: "1e-6") |
[in] | nz | Generic Input |
[in] | nf | Generic Input |
[in] | dampened | Generic Input |
[in] | iteration_limit | Generic Input (Default: "20") |
Definition at line 87 of file m_nlte.cc.
References abs, ARTS::Var::abs_lines_per_species(), ARTS::Var::abs_species(), ARTS::Var::atmosphere_dim(), ARTS::Var::collision_coefficients(), ARTS::Var::collision_line_identifiers(), CREATE_OUT2, createAij(), createBij(), createBji(), dampened_statistical_equilibrium_equation(), find_first_unique_in_lower(), ARTS::Var::isotopologue_ratios(), ARTS::Var::iy_cloudbox_agenda(), ARTS::Var::iy_main_agenda(), ARTS::Var::iy_space_agenda(), ARTS::Var::iy_surface_agenda(), joker, ARTS::Var::line_irradiance(), line_irradianceCalcForSingleSpeciesNonOverlappingLinesPseudo2D(), ARTS::Var::line_transmission(), max, Absorption::nelem(), nlines, nlte_collision_factorsCalcFromCoeffs(), ARTS::Var::nlte_do(), ARTS::Var::nlte_field(), nlte_positions_in_statistical_equilibrium_matrix(), ARTS::Var::p_grid(), ARTS::Var::ppath_agenda(), ARTS::Var::propmat_clearsky_agenda(), ARTS::Var::refellipsoid(), set_constant_statistical_equilibrium_matrix(), solve(), statistical_equilibrium_equation(), ARTS::Var::surface_props_data(), ARTS::Var::t_field(), ARTS::Var::verbosity(), ARTS::Var::vmr_field(), ARTS::Var::x(), and ARTS::Var::z_field().
Referenced by nlte_fieldForSingleSpeciesNonOverlappingLines_g().
void nlte_fieldRescalePopulationLevels | ( | EnergyLevelMap & | nlte_field, |
const Numeric & | s, | ||
const Verbosity & | verbosity | ||
) |
WORKSPACE METHOD: nlte_fieldRescalePopulationLevels.
Rescale NLTE field to expected total distribution amongst levels
[in,out] | nlte_field | WS Input/Output |
[in] | s | Generic Input |
Definition at line 80 of file m_nlte.cc.
References ARTS::Var::nlte_field().
Referenced by nlte_fieldRescalePopulationLevels_g().
void nlteOff | ( | Index & | nlte_do, |
EnergyLevelMap & | nlte_field, | ||
ArrayOfQuantumIdentifier & | nlte_level_identifiers, | ||
const Verbosity & | verbosity | ||
) |
WORKSPACE METHOD: nlteOff.
Disable Non-LTE calculations.
The variables are set as follows: <br> nlte_field : Empty. <br> nlte_level_identifiers : Empty.
[out] | nlte_do | WS Output |
[out] | nlte_field | WS Output |
[out] | nlte_level_identifiers | WS Output |
Definition at line 280 of file m_nlte.cc.
References ARTS::Var::nlte_do(), ARTS::Var::nlte_field(), and ARTS::Var::nlte_level_identifiers().
Referenced by nlteOff_g().