cia.h

Go to the documentation of this file.

/* Copyright (C) 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 cia_h
#define cia_h
 
#include "arts.h"
#include "gridded_fields.h"
#include "matpackI.h"
#include "messages.h"
#include "mystring.h"
#include "species.h"
 
// Declare existance of some classes:
class bifstream;
class CIARecord;
 
using ArrayOfCIARecord = Array<CIARecord>;
 
/* Header with implementation. */
void cia_interpolation(VectorView result,
                       ConstVectorView frequency,
                       const Numeric& temperature,
                       const GriddedField2& cia_data,
                       const Numeric& T_extrapolfac,
                       const Index& robust,
                       const Verbosity& verbosity);
 
Index cia_get_index(const ArrayOfCIARecord& cia_data,
                    const Species::Species sp1,
                    const Species::Species sp2);
 
class CIARecord {
 public:
  [[nodiscard]] String MoleculeName(const Index i) const;
 
  void SetMoleculeName(const Index i, const String& name);
 
  [[nodiscard]] Species::Species Species(const Index i) const {
    // Assert that i is 0 or 1:
    ARTS_ASSERT(i >= 0);
    ARTS_ASSERT(i <= 1);
 
    return mspecies[i];
  }
 
  [[nodiscard]] Index DatasetCount() const { return mdata.nelem(); }
 
  [[nodiscard]] ConstVectorView FrequencyGrid(Index dataset) const {
    ARTS_ASSERT(dataset >= 0);
    ARTS_ASSERT(dataset < mdata.nelem());
 
    return mdata[dataset].get_numeric_grid(0);
  }
 
  [[nodiscard]] ConstVectorView TemperatureGrid(Index dataset) const {
    ARTS_ASSERT(dataset >= 0);
    ARTS_ASSERT(dataset < mdata.nelem());
 
    return mdata[dataset].get_numeric_grid(1);
  }
 
  [[nodiscard]] const GriddedField2& Dataset(Index dataset) const {
    ARTS_ASSERT(dataset >= 0);
    ARTS_ASSERT(dataset < mdata.nelem());
 
    return mdata[dataset];
  }
 
  [[nodiscard]] const ArrayOfGriddedField2& Data() const { return mdata; }
 
  ArrayOfGriddedField2& Data() { return mdata; }
 
  void SetSpecies(const Species::Species first, const Species::Species second) {
    mspecies[0] = first;
    mspecies[1] = second;
  }
 
  void Extract(VectorView result,
               ConstVectorView f_grid,
               const Numeric& temperature,
               const Index& dataset,
               const Numeric& T_extrapolfac,
               const Index& robust,
               const Verbosity& verbosity) const;
 
  [[nodiscard]] Numeric Extract(const Numeric& frequency,
                                const Numeric& temperature,
                                const Index& dataset,
                                const Numeric& T_extrapolfac,
                                const Index& robust,
                                const Verbosity& verbosity) const {
    Vector result(1);
    const Vector freqvec(1, frequency);
 
    Extract(result,
            freqvec,
            temperature,
            dataset,
            T_extrapolfac,
            robust,
            verbosity);
 
    return result[0];
  }
 
  void ReadFromCIA(const String& filename, const Verbosity& verbosity);
 
  friend void xml_read_from_stream(istream& is_xml,
                                   CIARecord& cr,
                                   bifstream* pbifs,
                                   const Verbosity& verbosity);
 
  void AppendDataset(const CIARecord& c2);
 
  [[nodiscard]] std::array<Species::Species, 2> TwoSpecies() const {
    return mspecies;
  }
  std::array<Species::Species, 2>& TwoSpecies() { return mspecies; }
 
  CIARecord() = default;
  
  CIARecord(ArrayOfGriddedField2 data,
            Species::Species spec1,
            Species::Species spec2)
      : mdata(std::move(data)), mspecies({spec1, spec2}) {}
 
  friend ostream& operator<<(ostream& os, const CIARecord& cr);
 
 private:
  void AppendDataset(const Vector& freq,
                     const ArrayOfNumeric& temp,
                     const ArrayOfVector& cia);
 
  ArrayOfGriddedField2 mdata;
 
  std::array<Species::Species, 2> mspecies;
};
 
#endif  // cia_h