nlte.h

Go to the documentation of this file.

/* Copyright (C) 2018
   Richard Larsson
                            
   This program is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by the
   Free Software Foundation; either version 2, or (at your option) any
   later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
   USA. */

#include "absorption.h"
#include "gridded_fields.h"
#include "matpackI.h"

void statistical_equilibrium_equation(MatrixView A,
                                      ConstVectorView Aij,
                                      ConstVectorView Bij,
                                      ConstVectorView Bji,
                                      ConstVectorView Cij,
                                      ConstVectorView Cji,
                                      ConstVectorView Jij,
                                      const ArrayOfIndex& upper,
                                      const ArrayOfIndex& lower);

void dampened_statistical_equilibrium_equation(
    MatrixView A,
    ConstVectorView x,
    ConstVectorView Aij,
    ConstVectorView Bij,
    ConstVectorView Bji,
    ConstVectorView Cij,
    ConstVectorView Cji,
    ConstVectorView Jij,
    ConstVectorView Lambda,
    const ArrayOfIndex& upper,
    const ArrayOfIndex& lower,
    const Numeric& total_number_count = 1.0);

void set_constant_statistical_equilibrium_matrix(MatrixView A,
                                                 VectorView x,
                                                 const Numeric& sem_ratio,
                                                 const Index row);

Vector createAij(const ArrayOfArrayOfAbsorptionLines& abs_lines);

Vector createBij(const ArrayOfArrayOfAbsorptionLines& abs_lines);

Vector createBji(const Vector& Bij, const ArrayOfArrayOfAbsorptionLines& abs_lines);

Vector createCji(const Vector& Cij,
                 const ArrayOfArrayOfAbsorptionLines& abs_lines,
                 const Numeric& T);

void setCji(Vector& Cji,
            const Vector& Cij,
            const ArrayOfArrayOfAbsorptionLines& abs_lines,
            const Numeric& T);

void nlte_collision_factorsCalcFromCoeffs(
  Vector& Cij,
  Vector& Cji,
  const ArrayOfArrayOfAbsorptionLines& abs_lines,
  const ArrayOfArrayOfSpeciesTag& abs_species,
  const ArrayOfArrayOfGriddedField1& collision_coefficients,
  const ArrayOfQuantumIdentifier& collision_line_identifiers,
  const SpeciesAuxData& isotopologue_ratios,
  const ConstVectorView vmr,
  const Numeric& T,
  const Numeric& P);

void nlte_positions_in_statistical_equilibrium_matrix(
  ArrayOfIndex& upper,
  ArrayOfIndex& lower,
  const ArrayOfArrayOfAbsorptionLines& abs_lines,
  const EnergyLevelMap& nlte_field);

Index find_first_unique_in_lower(const ArrayOfIndex& upper,
                                 const ArrayOfIndex& lower) noexcept;

void check_collision_line_identifiers(
    const ArrayOfQuantumIdentifier& collision_line_identifiers);