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 "check_input.h"
#include "gridded_fields.h"
#include "matpackI.h"
#include "mystring.h"

// Declare existance of some classes:
class bifstream;
class CIARecord;

typedef Array<CIARecord> ArrayOfCIARecord;

/* 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 Index sp1,
                    const Index sp2);

class CIARecord {
 public:
  String MoleculeName(const Index i) const;

  void SetMoleculeName(const Index i, const String& name);

  Index Species(const Index i) const {
    // Assert that i is 0 or 1:
    assert(i >= 0);
    assert(i <= 1);

    return mspecies[i];
  }

  Index DatasetCount() const { return mdata.nelem(); }

  ConstVectorView FrequencyGrid(Index dataset) const {
    assert(dataset >= 0);
    assert(dataset < mdata.nelem());

    return mdata[dataset].get_numeric_grid(0);
  }

  ConstVectorView TemperatureGrid(Index dataset) const {
    assert(dataset >= 0);
    assert(dataset < mdata.nelem());

    return mdata[dataset].get_numeric_grid(1);
  }

  const GriddedField2& Dataset(Index dataset) const {
    assert(dataset >= 0);
    assert(dataset < mdata.nelem());

    return mdata[dataset];
  }

  const ArrayOfGriddedField2& Data() const { return mdata; }
  
  ArrayOfGriddedField2& Data() { return mdata; }

  void SetSpecies(const Index first, const Index 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;

  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);

 private:
  void AppendDataset(const Vector& freq,
                     const ArrayOfNumeric& temp,
                     const ArrayOfVector& cia);

  ArrayOfGriddedField2 mdata;

  Index mspecies[2];
};

ostream& operator<<(ostream& os, const CIARecord& cr);

#endif  // cia_h