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

MuCoeffcient that computes $ \phi $ from data on a uniform grid. More...

#include <MuCoefficient.H>

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

Public Member Functions

 LevelDataMuCoefficient (RefCountedPtr< LevelData< FArrayBox > > a_muCoef, const RealVect &a_dx)
 
 LevelDataMuCoefficient (RefCountedPtr< std::map< Real, std::string > > &a_timeFileMap, const std::string &a_name)
 construct from a sequence of files More...
 
virtual MuCoefficientnew_muCoefficient () const
 factory method More...
 
virtual void setMuCoefficient (LevelData< FArrayBox > &a_muCoef, LevelSigmaCS &a_coordSys, Real a_time, Real a_dt)
 define cell and face-centered coefficient More...
 
- Public Member Functions inherited from MuCoefficient
 MuCoefficient ()
 constructor More...
 
virtual ~MuCoefficient ()
 destructor More...
 

Protected Attributes

RefCountedPtr< std::map< Real, std::string > > m_timeFileMap
 
Real m_startTime
 
Real m_endTime
 
RefCountedPtr< LevelData< FArrayBox > > m_muCoef
 
RefCountedPtr< LevelData< FArrayBox > > m_endMuCoef
 
RealVect m_dx
 
bool m_verbose
 
std::string m_name
 

Additional Inherited Members

- Static Public Member Functions inherited from MuCoefficient
static MuCoefficientparseMuCoefficient (const char *a_prefix)
 assemble a MuCoefficient object from ParmParse input, return pointer More...
 

Detailed Description

MuCoeffcient that computes $ \phi $ from data on a uniform grid.

Run time configuration is carried out in BasalFriction::parse(A, ... ) If the option A.type = LevelData is found, then the expected form is:

for a single file or

for a sequence of files

Constructor & Destructor Documentation

◆ LevelDataMuCoefficient() [1/2]

LevelDataMuCoefficient::LevelDataMuCoefficient ( RefCountedPtr< LevelData< FArrayBox > >  a_muCoef,
const RealVect &  a_dx 
)
inline

◆ LevelDataMuCoefficient() [2/2]

LevelDataMuCoefficient::LevelDataMuCoefficient ( RefCountedPtr< std::map< Real, std::string > > &  a_timeFileMap,
const std::string &  a_name 
)
inline

construct from a sequence of files

Parameters
a_timeFileMapmaps model times to filenames
a_namename of the field in all hdf5 files

References MuCoefficient::new_muCoefficient(), and MuCoefficient::setMuCoefficient().

Member Function Documentation

◆ new_muCoefficient()

MuCoefficient * LevelDataMuCoefficient::new_muCoefficient ( ) const
virtual

factory method

return a pointer to a new Mucoefficient object

Implements MuCoefficient.

References setMuCoefficient().

◆ setMuCoefficient()

void LevelDataMuCoefficient::setMuCoefficient ( LevelData< FArrayBox > &  a_muCoef,
LevelSigmaCS a_coordSys,
Real  a_time,
Real  a_dt 
)
virtual

define cell and face-centered coefficient

Implements MuCoefficient.

References LevelSigmaCS::dx(), FillFromReference(), readLevelData(), and ReflectGhostCells().

Referenced by new_muCoefficient().

Member Data Documentation

◆ m_dx

RealVect LevelDataMuCoefficient::m_dx
protected

◆ m_endMuCoef

RefCountedPtr< LevelData<FArrayBox> > LevelDataMuCoefficient::m_endMuCoef
protected

◆ m_endTime

Real LevelDataMuCoefficient::m_endTime
protected

◆ m_muCoef

RefCountedPtr< LevelData<FArrayBox> > LevelDataMuCoefficient::m_muCoef
protected

◆ m_name

std::string LevelDataMuCoefficient::m_name
protected

◆ m_startTime

Real LevelDataMuCoefficient::m_startTime
protected

◆ m_timeFileMap

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

◆ m_verbose

bool LevelDataMuCoefficient::m_verbose
protected

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