absorber.hpp

Go to the documentation of this file.

#ifndef SRC_OPACITY_ABSORBER_HPP_
#define SRC_OPACITY_ABSORBER_HPP_
 
// C/C++
#include <map>
#include <memory>
#include <string>
#include <vector>
 
// external
#include <yaml-cpp/yaml.h>
 
// athena
#include <athena/athena.hpp>
 
// canoe
#include <virtual_groups.hpp>
 
class AirParcel;
 
class Absorber : public NamedGroup,
                 public ParameterGroup,
                 public SpeciesIndexGroup,
                 public CheckGroup {
 public:  // constructor and destructor
  Absorber(std::string name);
  virtual ~Absorber();
 
 public:  // member functions
  void SetModel(std::string name) { model_name_ = name; }
 
  void LoadOpacityFromFile(std::string filename);
 
  void SetOpacityFile(std::string filename);
 
  void LoadOpacity();
 
  virtual void LoadCoefficient(std::string fname, size_t bid) {}
 
  virtual Real GetAttenuation(Real wave1, Real wave2,
                              AirParcel const& var) const {
    return 0.;
  }
 
  virtual Real GetSingleScatteringAlbedo(Real wave1, Real wave2,
                                         AirParcel const& var) const {
    return 0.;
  }
 
  virtual void GetPhaseMomentum(Real* pp, Real wave1, Real wave2,
                                AirParcel const& var, int np) const {}
 
 protected:
  std::string model_name_;
 
  std::string opacity_filename_;
};
 
using AbsorberPtr = std::shared_ptr<Absorber>;
using AbsorberContainer = std::vector<AbsorberPtr>;
 
class AbsorberFactory {
 public:
  std::string search_path;
 
  static AbsorberPtr CreateFrom(YAML::Node const& my, std::string band_name);
 
  static AbsorberContainer CreateFrom(std::vector<std::string> const& names,
                                      std::string band_name,
                                      YAML::Node const& rad);
 
 protected:
  static AbsorberPtr createAbsorberPartial(std::string name, std::string type);
};
 
#endif  // SRC_OPACITY_ABSORBER_HPP_