Chombo + EB + MF  3.2
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
AMRLevelAdvectDiffuseFactory Class Reference

#include <AMRLevelAdvectDiffuseFactory.H>

Inheritance diagram for AMRLevelAdvectDiffuseFactory:
Inheritance graph
[legend]

Public Member Functions

 AMRLevelAdvectDiffuseFactory (const AdvectPhysics &a_gphys, AdvectionVelocityFunction a_advFunc, BCHolder a_bcFunc, const Real &a_cfl, const Real &a_domainLength, const Real &a_refineThresh, const int &a_tagBufferSize, const Real &a_initialDtMultiplier, const bool &a_useLimiting, const Real &a_nu)
 Constructor. More...
 
virtual ~AMRLevelAdvectDiffuseFactory ()
 Destructor. More...
 
virtual AMRLevelnew_amrlevel () const
 
- Public Member Functions inherited from AMRLevelFactory
virtual ~AMRLevelFactory ()
 

Protected Attributes

Real m_cfl
 
Real m_domainLength
 
Real m_refineThresh
 
int m_tagBufferSize
 
Real m_initialDtMultiplier
 
bool m_useLimiting
 
Real m_nu
 
RefCountedPtr< AdvectPhysicsm_advPhys
 
AdvectionVelocityFunction m_advFunc
 
BCHolder m_bcFunc
 

Private Member Functions

 AMRLevelAdvectDiffuseFactory ()
 Weak construction is disallowed. More...
 
void operator= (const AMRLevelAdvectDiffuseFactory &)
 
 AMRLevelAdvectDiffuseFactory (const AMRLevelAdvectDiffuseFactory &)
 

Constructor & Destructor Documentation

◆ AMRLevelAdvectDiffuseFactory() [1/3]

AMRLevelAdvectDiffuseFactory::AMRLevelAdvectDiffuseFactory ( const AdvectPhysics a_gphys,
AdvectionVelocityFunction  a_advFunc,
BCHolder  a_bcFunc,
const Real a_cfl,
const Real a_domainLength,
const Real a_refineThresh,
const int &  a_tagBufferSize,
const Real a_initialDtMultiplier,
const bool &  a_useLimiting,
const Real a_nu 
)

Constructor.

Parameters
a_gphysadvection physics class
a_advFuncvelocity function providing the advection velocity
a_bcFuncboundary condition class for diffusion solve
a_cflCFL number
a_domainLengthphysical length of domain
a_refineThreshundivided gradient size over which a cell will be tagged for refinement
a_tagBufferSizenumber of buffer cells around each tagged cell that will also be tagged
a_initialDtMultiplierCFL number at beginning of calculation
a_useLimitingwhether to use van Leer limiting
a_nudiffusion coefficient

◆ ~AMRLevelAdvectDiffuseFactory()

virtual AMRLevelAdvectDiffuseFactory::~AMRLevelAdvectDiffuseFactory ( )
inlinevirtual

Destructor.

References new_amrlevel().

◆ AMRLevelAdvectDiffuseFactory() [2/3]

AMRLevelAdvectDiffuseFactory::AMRLevelAdvectDiffuseFactory ( )
inlineprivate

Weak construction is disallowed.

References MayDay::Error(), and operator=().

◆ AMRLevelAdvectDiffuseFactory() [3/3]

AMRLevelAdvectDiffuseFactory::AMRLevelAdvectDiffuseFactory ( const AMRLevelAdvectDiffuseFactory )
private

Member Function Documentation

◆ new_amrlevel()

virtual AMRLevel* AMRLevelAdvectDiffuseFactory::new_amrlevel ( ) const
virtual

Factory function. Creates a new AMRLevel. In your instantiation you should include defining all the stuff that is not part of the AMRLevel API.

Implements AMRLevelFactory.

Referenced by ~AMRLevelAdvectDiffuseFactory().

◆ operator=()

void AMRLevelAdvectDiffuseFactory::operator= ( const AMRLevelAdvectDiffuseFactory )
private

Member Data Documentation

◆ m_cfl

Real AMRLevelAdvectDiffuseFactory::m_cfl
protected

◆ m_domainLength

Real AMRLevelAdvectDiffuseFactory::m_domainLength
protected

◆ m_refineThresh

Real AMRLevelAdvectDiffuseFactory::m_refineThresh
protected

◆ m_tagBufferSize

int AMRLevelAdvectDiffuseFactory::m_tagBufferSize
protected

◆ m_initialDtMultiplier

Real AMRLevelAdvectDiffuseFactory::m_initialDtMultiplier
protected

◆ m_useLimiting

bool AMRLevelAdvectDiffuseFactory::m_useLimiting
protected

◆ m_nu

Real AMRLevelAdvectDiffuseFactory::m_nu
protected

◆ m_advPhys

RefCountedPtr<AdvectPhysics> AMRLevelAdvectDiffuseFactory::m_advPhys
protected

◆ m_advFunc

AdvectionVelocityFunction AMRLevelAdvectDiffuseFactory::m_advFunc
protected

◆ m_bcFunc

BCHolder AMRLevelAdvectDiffuseFactory::m_bcFunc
protected

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