gas_abs_lookup.h

Go to the documentation of this file.

/* Copyright (C) 2002-2012 Stefan Buehler <sbuehler@ltu.se>

   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. */

#ifndef gas_abs_lookup_h
#define gas_abs_lookup_h

#include "abs_species_tags.h"
#include "absorption.h"
#include "interpolation_poly.h"
#include "matpackIV.h"
#include "messages.h"

// Declare existance of some classes:
class bifstream;
class bofstream;
class Agenda;
class Workspace;


class GasAbsLookup {
 public:
  GasAbsLookup()
      : species(),
        nonlinear_species(),
        f_grid(),
        p_grid(),
        vmrs_ref(),
        t_ref(),
        t_pert(),
        nls_pert(),
        xsec() { /* Nothing to do here */
  }

  // Documentation is with the implementation!
  void Adapt(const ArrayOfArrayOfSpeciesTag& current_species,
             ConstVectorView current_f_grid,
             const Verbosity& verbosity);

  // Documentation is with the implementation!
  void Extract(Matrix& sga,
               const Index& p_interp_order,
               const Index& t_interp_order,
               const Index& h2o_interp_order,
               const Index& f_interp_order,
               const Numeric& p,
               const Numeric& T,
               ConstVectorView abs_vmrs,
               ConstVectorView new_f_grid,
               const Numeric& extpolfac) const;

  const Vector& GetFgrid() const;

  const Vector& GetPgrid() const;

  Index GetSpeciesIndex(const Index& isp) const {
    return species[isp][0].Species();
  }

  // IO functions must be friends:
  friend void xml_read_from_stream(istream& is_xml,
                                   GasAbsLookup& gal,
                                   bifstream* pbifs,
                                   const Verbosity& verbosity);
  friend void xml_write_to_stream(ostream& os_xml,
                                  const GasAbsLookup& gal,
                                  bofstream* pbofs,
                                  const String& name,
                                  const Verbosity& verbosity);

  friend void abs_lookupCalc(  // Workspace reference:
      Workspace& ws,
      // WS Output:
      GasAbsLookup& abs_lookup,
      Index& abs_lookup_is_adapted,
      // WS Input:
      const ArrayOfArrayOfSpeciesTag& abs_species,
      const ArrayOfArrayOfSpeciesTag& abs_nls,
      const Vector& f_grid,
      const Vector& abs_p,
      const Matrix& abs_vmrs,
      const Vector& abs_t,
      const Vector& abs_t_pert,
      const Vector& abs_nls_pert,
      const Agenda& abs_xsec_agenda,
      // Verbosity object:
      const Verbosity& verbosity);

  friend Numeric calc_lookup_error(  // Parameters for lookup table:
      Workspace& ws,
      const GasAbsLookup& al,
      const Index& abs_p_interp_order,
      const Index& abs_t_interp_order,
      const Index& abs_nls_interp_order,
      const bool ignore_errors,
      // Parameters for LBL:
      const Agenda& abs_xsec_agenda,
      // Parameters for both:
      const Numeric& local_p,
      const Numeric& local_t,
      const Vector& local_vmrs,
      const Verbosity& verbosity);

  friend void abs_lookupTestAccuracy(  // Workspace reference:
      Workspace& ws,
      // WS Input:
      const GasAbsLookup& abs_lookup,
      const Index& abs_lookup_is_adapted,
      const Index& abs_p_interp_order,
      const Index& abs_t_interp_order,
      const Index& abs_nls_interp_order,
      const Agenda& abs_xsec_agenda,
      // Verbosity object:
      const Verbosity& verbosity);

  friend void abs_lookupTestAccMC(  // Workspace reference:
      Workspace& ws,
      // WS Input:
      const GasAbsLookup& abs_lookup,
      const Index& abs_lookup_is_adapted,
      const Index& abs_p_interp_order,
      const Index& abs_t_interp_order,
      const Index& abs_nls_interp_order,
      const Index& mc_seed,
      const Agenda& abs_xsec_agenda,
      // Verbosity object:
      const Verbosity& verbosity);

  friend void nca_read_from_file(const int ncid,
                                 GasAbsLookup& gal,
                                 const Verbosity&);

  friend void nca_write_to_file(const int ncid,
                                const GasAbsLookup& gal,
                                const Verbosity&);

  ArrayOfArrayOfSpeciesTag& Species() {return species;}
  
  ArrayOfIndex& NonLinearSpecies() {return nonlinear_species;}
  
  Vector& Fgrid() {return f_grid;}
  
  ArrayOfGridPosPoly& FGPDefault() {return fgp_default;}
  
  Vector& Pgrid() {return p_grid;}
  
  Vector& LogPgrid() {return log_p_grid;}
  
  Matrix& VMRs() {return vmrs_ref;}
  
  Vector& Tref() {return t_ref;}
  
  Vector& Tpert() {return t_pert;}
  
  Vector& NLSPert() {return nls_pert;}
  
  Tensor4& Xsec() {return xsec;}
  
 private:
  ArrayOfArrayOfSpeciesTag species;


  ArrayOfIndex nonlinear_species;


  Vector f_grid;


  ArrayOfGridPosPoly fgp_default;


  Vector p_grid;


  Vector log_p_grid;


  Matrix vmrs_ref;


  Vector t_ref;


  Vector t_pert;


  Vector nls_pert;


  Tensor4 xsec;
};

ostream& operator<<(ostream& os, const GasAbsLookup& gal);

#endif  //  gas_abs_lookup_h