ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ERF_RadiationInterface.H
Go to the documentation of this file.
1 #ifndef ERF_RADIATION_INTERFACE_H
2 #define ERF_RADIATION_INTERFACE_H
3 
4 #include <memory>
5 #include <iostream>
6 
7 #include <AMReX_BoxArray.H>
8 #include <AMReX_Geometry.H>
9 #include <AMReX_MultiFab.H>
10 #include <AMReX_ParmParse.H>
11 
12 // Basic interface class for wrapping different radiation models
14 {
15 public:
16  virtual ~IRadiation () = default;
17 
18  virtual
19  void
20  Init (const amrex::Geometry& geom,
21  const amrex::BoxArray& ba,
22  amrex::MultiFab* cons_in) = 0;
23 
24  virtual
25  void
26  Run (int& level,
27  int& step,
28  amrex::Real& time,
29  const amrex::Real& dt,
30  const amrex::BoxArray& ba,
31  amrex::Geometry& geom,
32  amrex::MultiFab* cons_in,
33  amrex::MultiFab* lsm_fluxes,
34  amrex::MultiFab* lsm_zenith,
35  amrex::Vector<amrex::MultiFab*>& lsm_input_ptrs,
36  amrex::Vector<amrex::MultiFab*>& lsm_output_ptrs,
37  amrex::MultiFab* qheating_rates,
38  amrex::MultiFab* z_phys,
39  amrex::MultiFab* lat,
40  amrex::MultiFab* lon) = 0;
41 
42  virtual
43  void
44  WriteDataLog (const amrex::Real& time) = 0;
45 
46  // Get names input varnames for lsm
47  virtual
48  amrex::Vector<std::string>
50  {
51  amrex::Vector<std::string> empty = {" "};
52  return empty;
53  }
54 
55  // Get names output varnames for lsm
56  virtual
57  amrex::Vector<std::string>
59  {
60  amrex::Vector<std::string> empty = {" "};
61  return empty;
62  }
63 
64  void
66  {
67  amrex::ParmParse pp("erf.rad");
68  if (pp.contains("datalog")) {
69  pp.query("datalog", datalogname);
70 
72  }
73  }
74 
75  void
76  setDataLogFrequency (const int nstep) {
77  datalog_int = nstep;
78  }
79 
80  bool
81  hasDatalog () { return (datalog != nullptr && datalog->good()); }
82 
83 protected:
84  std::unique_ptr<std::fstream> datalog = nullptr;
85  std::string datalogname;
86 
87  int datalog_int = -1; // datalog frequency in steps
88 
89 private:
90  void
91  setRecordDataInfo (const std::string& filename)
92  {
93  datalog = std::make_unique<std::fstream>();
94  if (amrex::ParallelDescriptor::IOProcessor())
95  {
96  datalog->open(filename.c_str(),std::ios::out|std::ios::app);
97  if (!datalog->good()) {
98  amrex::FileOpenFailed(filename);
99  }
100  datalogname = filename;
101  }
102  amrex::ParallelDescriptor::Barrier("ERF::Radiation::setRecordDataInfo");
103  }
104 };
105 
106 #endif
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real pp(amrex::Real y)
Definition: ERF_MicrophysicsUtils.H:230
Definition: ERF_RadiationInterface.H:14
bool hasDatalog()
Definition: ERF_RadiationInterface.H:81
std::string datalogname
Definition: ERF_RadiationInterface.H:85
virtual void Run(int &level, int &step, amrex::Real &time, const amrex::Real &dt, const amrex::BoxArray &ba, amrex::Geometry &geom, amrex::MultiFab *cons_in, amrex::MultiFab *lsm_fluxes, amrex::MultiFab *lsm_zenith, amrex::Vector< amrex::MultiFab * > &lsm_input_ptrs, amrex::Vector< amrex::MultiFab * > &lsm_output_ptrs, amrex::MultiFab *qheating_rates, amrex::MultiFab *z_phys, amrex::MultiFab *lat, amrex::MultiFab *lon)=0
std::unique_ptr< std::fstream > datalog
Definition: ERF_RadiationInterface.H:84
void setupDataLog()
Definition: ERF_RadiationInterface.H:65
void setDataLogFrequency(const int nstep)
Definition: ERF_RadiationInterface.H:76
virtual void Init(const amrex::Geometry &geom, const amrex::BoxArray &ba, amrex::MultiFab *cons_in)=0
int datalog_int
Definition: ERF_RadiationInterface.H:87
virtual ~IRadiation()=default
void setRecordDataInfo(const std::string &filename)
Definition: ERF_RadiationInterface.H:91
virtual void WriteDataLog(const amrex::Real &time)=0
virtual amrex::Vector< std::string > get_lsm_input_varnames()
Definition: ERF_RadiationInterface.H:49
virtual amrex::Vector< std::string > get_lsm_output_varnames()
Definition: ERF_RadiationInterface.H:58