IRadiation Class Reference

#include <ERF_RadiationInterface.H>

Inheritance diagram for IRadiation:

Collaboration diagram for IRadiation:

Public Member Functions
virtual	~IRadiation ()=default
virtual void	Init (const amrex::Geometry &geom, const amrex::BoxArray &ba, amrex::MultiFab *cons_in)=0
virtual void	Run (int &level, int &step, double &time, const double &dt, const amrex::BoxArray &ba, amrex::Geometry &geom, amrex::MultiFab *cons_in, amrex::iMultiFab *lmask, amrex::MultiFab *t_surf, const amrex::Vector< const amrex::MultiFab * > &lsm_input_ptrs, const amrex::Vector< amrex::MultiFab * > &lsm_output_ptrs, amrex::MultiFab *qheating_rates, amrex::MultiFab *rad_fluxes, amrex::MultiFab *z_phys, amrex::MultiFab *lat, amrex::MultiFab *lon, const bool updated_lsm, amrex::Real &declin, amrex::Real &calday)=0
virtual bool	radiation_updated () const
	Reports whether the last radiation call updated its outputs. More...
virtual void	WriteDataLog (const double &time)=0
virtual amrex::Vector< std::string >	get_lsm_input_varnames ()
virtual amrex::Vector< std::string >	get_lsm_output_varnames ()
virtual bool	is_nested_patch () const
void	setupDataLog ()
void	setDataLogFrequency (const int nstep)
bool	hasDatalog ()

Protected Attributes
std::unique_ptr< std::fstream >	datalog = nullptr
std::string	datalogname
int	datalog_int = -1

Private Member Functions
void	setRecordDataInfo (const std::string &filename)

Constructor & Destructor Documentation

~IRadiation()

virtual IRadiation::~IRadiation ( )

virtualdefault

Member Function Documentation

get_lsm_input_varnames()

virtual amrex::Vector<std::string> IRadiation::get_lsm_input_varnames ( )

inlinevirtual

Reimplemented in Radiation.

    {
        amrex::Vector<std::string> empty = {" "};
        return empty;
    }

get_lsm_output_varnames()

virtual amrex::Vector<std::string> IRadiation::get_lsm_output_varnames ( )

inlinevirtual

Reimplemented in Radiation.

    {
        amrex::Vector<std::string> empty = {" "};
        return empty;
    }

hasDatalog()

bool IRadiation::hasDatalog ( )

inline

{ return (datalog != nullptr && datalog->good()); }

Init()

virtual void IRadiation::Init ( const amrex::Geometry &  geom, const amrex::BoxArray &  ba, amrex::MultiFab *  cons_in  )

pure virtual

Implemented in RadiationSimple, and Radiation.

is_nested_patch()

virtual bool IRadiation::is_nested_patch ( ) const

inlinevirtual

Reimplemented in Radiation.

    {
        return false;  // Default: not a nested patch
    }

radiation_updated()

virtual bool IRadiation::radiation_updated ( ) const

inlinevirtual

Reports whether the last radiation call updated its outputs.

Returns

True when the radiation kernel wrote output fields.

Reimplemented in Radiation.

{ return true; }

Run()

virtual void IRadiation::Run ( int &  level, int &  step, double &  time, const double &  dt, const amrex::BoxArray &  ba, amrex::Geometry &  geom, amrex::MultiFab *  cons_in, amrex::iMultiFab *  lmask, amrex::MultiFab *  t_surf, const amrex::Vector< const amrex::MultiFab * > &  lsm_input_ptrs, const amrex::Vector< amrex::MultiFab * > &  lsm_output_ptrs, amrex::MultiFab *  qheating_rates, amrex::MultiFab *  rad_fluxes, amrex::MultiFab *  z_phys, amrex::MultiFab *  lat, amrex::MultiFab *  lon, const bool  updated_lsm, amrex::Real &  declin, amrex::Real &  calday  )

pure virtual

Implemented in Radiation, and RadiationSimple.

setDataLogFrequency()

void IRadiation::setDataLogFrequency ( const int  nstep )

inline

                                          {
        datalog_int = nstep;
    }

setRecordDataInfo()

void IRadiation::setRecordDataInfo ( const std::string &  filename )

inlineprivate

    {
        datalog = std::make_unique<std::fstream>();
        if (amrex::ParallelDescriptor::IOProcessor())
        {
            datalog->open(filename.c_str(),std::ios::out|std::ios::app);
            if (!datalog->good()) {
                amrex::FileOpenFailed(filename);
            }
            datalogname = filename;
        }
        amrex::ParallelDescriptor::Barrier("ERF::Radiation::setRecordDataInfo");
    }

Referenced by setupDataLog().

Here is the caller graph for this function:

setupDataLog()

void IRadiation::setupDataLog ( )

inline

    {
        amrex::ParmParse pp("erf.rad");
        if (pp.contains("datalog")) {
            pp.queryAdd("datalog", datalogname);
 
            setRecordDataInfo(datalogname);
        }
    }

Here is the call graph for this function:

WriteDataLog()

virtual void IRadiation::WriteDataLog ( const double &  time )

pure virtual

Implemented in RadiationSimple, and Radiation.

Member Data Documentation

datalog

std::unique_ptr<std::fstream> IRadiation::datalog = nullptr

protected

Referenced by hasDatalog(), and setRecordDataInfo().

datalog_int

int IRadiation::datalog_int = -1

protected

Referenced by setDataLogFrequency().

datalogname

std::string IRadiation::datalogname

protected

Referenced by setRecordDataInfo(), and setupDataLog().

---

The documentation for this class was generated from the following file:

• Source/Radiation/ERF_RadiationInterface.H