BISICLES AMR ice sheet model  0.9
Public Member Functions | Protected Attributes | List of all members
LevelDataSurfaceFlux Class Reference

#include <LevelDataSurfaceFlux.H>

Inheritance diagram for LevelDataSurfaceFlux:
Inheritance graph
[legend]
Collaboration diagram for LevelDataSurfaceFlux:
Collaboration graph
[legend]

Public Member Functions

 LevelDataSurfaceFlux (RefCountedPtr< LevelData< FArrayBox > > a_flux, const RealVect &a_dx, const Real &a_defaultValue=0.0)
 
 LevelDataSurfaceFlux (RefCountedPtr< std::map< Real, std::string > > &a_timeFileMap, const std::string &a_name, const bool &a_linearInterp, const Real &a_defaultValue=0.0)
 
virtual ~LevelDataSurfaceFlux ()
 destructor More...
 
virtual SurfaceFluxnew_surfaceFlux ()
 factory method More...
 
virtual void surfaceThicknessFlux (LevelData< FArrayBox > &a_flux, const AmrIceBase &a_amrIce, int a_level, Real a_dt)
 define source term for thickness evolution and place it in flux More...
 
- Public Member Functions inherited from SurfaceFlux
virtual ~SurfaceFlux ()
 virtual destructor More...
 
virtual void evaluate (LevelData< FArrayBox > &a_data, const AmrIceBase &a_amrIce, int a_level, Real a_dt)
 Sub-classes of this class turned out to be useful for various data apart from thickness fluxes... More...
 

Protected Attributes

RefCountedPtr< std::map< Real, std::string > > m_timeFileMap
 
Real m_startTime
 
Real m_endTime
 
Real m_defaultValue
 
RefCountedPtr< LevelData< FArrayBox > > m_startFlux
 
RefCountedPtr< LevelData< FArrayBox > > m_endFlux
 
RealVect m_dx
 
bool m_verbose
 
std::string m_name
 
bool m_linearInterp
 

Additional Inherited Members

- Static Public Member Functions inherited from SurfaceFlux
static SurfaceFluxparse (const char *a_prefix)
 assemble a SurfaceFlux* object from ParmParse inputs More...
 

Constructor & Destructor Documentation

◆ LevelDataSurfaceFlux() [1/2]

LevelDataSurfaceFlux::LevelDataSurfaceFlux ( RefCountedPtr< LevelData< FArrayBox > >  a_flux,
const RealVect &  a_dx,
const Real &  a_defaultValue = 0.0 
)
inline

Referenced by new_surfaceFlux().

◆ LevelDataSurfaceFlux() [2/2]

LevelDataSurfaceFlux::LevelDataSurfaceFlux ( RefCountedPtr< std::map< Real, std::string > > &  a_timeFileMap,
const std::string &  a_name,
const bool &  a_linearInterp,
const Real &  a_defaultValue = 0.0 
)
inline

◆ ~LevelDataSurfaceFlux()

virtual LevelDataSurfaceFlux::~LevelDataSurfaceFlux ( )
inlinevirtual

destructor

Member Function Documentation

◆ new_surfaceFlux()

virtual SurfaceFlux* LevelDataSurfaceFlux::new_surfaceFlux ( )
inlinevirtual

factory method

return a pointer to a new SurfaceFlux object

Implements SurfaceFlux.

References LevelDataSurfaceFlux(), m_defaultValue, m_dx, m_linearInterp, m_name, m_startFlux, m_timeFileMap, and surfaceThicknessFlux().

◆ surfaceThicknessFlux()

void LevelDataSurfaceFlux::surfaceThicknessFlux ( LevelData< FArrayBox > &  a_flux,
const AmrIceBase a_amrIce,
int  a_level,
Real  a_dt 
)
virtual

Member Data Documentation

◆ m_defaultValue

Real LevelDataSurfaceFlux::m_defaultValue
protected

◆ m_dx

RealVect LevelDataSurfaceFlux::m_dx
protected

Referenced by new_surfaceFlux().

◆ m_endFlux

RefCountedPtr< LevelData<FArrayBox> > LevelDataSurfaceFlux::m_endFlux
protected

◆ m_endTime

Real LevelDataSurfaceFlux::m_endTime
protected

◆ m_linearInterp

bool LevelDataSurfaceFlux::m_linearInterp
protected

◆ m_name

std::string LevelDataSurfaceFlux::m_name
protected

◆ m_startFlux

RefCountedPtr< LevelData<FArrayBox> > LevelDataSurfaceFlux::m_startFlux
protected

Referenced by new_surfaceFlux().

◆ m_startTime

Real LevelDataSurfaceFlux::m_startTime
protected

◆ m_timeFileMap

RefCountedPtr<std::map<Real,std::string> > LevelDataSurfaceFlux::m_timeFileMap
protected

◆ m_verbose

bool LevelDataSurfaceFlux::m_verbose
protected

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