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

AMR Cons Equation factory. More...

#include <AMRLevelMappedConsFactory.H>

Inheritance diagram for AMRLevelMappedConsFactory:
Inheritance graph
[legend]

Public Member Functions

 AMRLevelMappedConsFactory ()
 Null constructor. More...
 
 AMRLevelMappedConsFactory (NewCoordSysFactory *const a_coordSysFact, AMRLevelMappedStabilityStrategy *a_stableTimeSteppingStrategy, AMRLevelMappedTaggingStrategy *a_taggingStategy)
 Constructor for a single-block coordinate system. More...
 
 AMRLevelMappedConsFactory (MultiBlockCoordSysFactory *const a_coordSysFact, AMRLevelMappedStabilityStrategy *a_stableTimeSteppingStrategy, AMRLevelMappedTaggingStrategy *a_taggingStategy)
 Constructor for a multi-block coordinate system. More...
 
virtual AMRLevelnew_amrlevel () const
 Virtual constructor. More...
 
virtual ~AMRLevelMappedConsFactory ()
 Destructor. More...
 
void coordinateSystemFactory (MultiBlockCoordSysFactory *a_coordSysFact)
 Set the factory for the coordinate system. More...
 
virtual void useSourceTerm (bool a_useSourceTerm)
 Set whether to use source term. More...
 
virtual void sourceTerm (const LevelSourceTerm *const a_sourceTerm)
 Source term class, if necessary. More...
 
virtual void useArtificialDissipation (bool a_useArtificialDissipation)
 Set whether to modify fluxes by adding artificial dissipation based on 5th derivative. More...
 
virtual void artificialDissipation (Real a_artificialDissipation)
 Set coefficient of artificial dissipation. More...
 
void plotPrefix (const std::string &a_plotfile_prefix)
 
bool isDefined () const
 Check that everything is defined. More...
 
virtual void writeJ (bool a_writeJ)
 
virtual void writeExact (bool a_writeExact)
 
virtual void writeError (bool a_writeError)
 
virtual void writeMap (bool a_writeMap)
 
- Public Member Functions inherited from AMRLevelConsFactory
 AMRLevelConsFactory ()
 Null constructor. More...
 
virtual ~AMRLevelConsFactory ()
 Destructor. More...
 
virtual void CFL (Real a_cfl)
 CFL number. More...
 
virtual void spaceOrder (int a_spaceOrder)
 spatial order of accuracy (default is 4) More...
 
virtual void limitFaceValues (bool a_limitFaceValues)
 sets whether to limit face values in advection (default is false) More...
 
virtual void highOrderLimiter (bool a_highOrderLimiter)
 sets whether to use high-order limiter (default is true) More...
 
virtual void initialAverage (bool a_initialAverage)
 sets whether initial data is average; default false More...
 
virtual void useFlattening (bool a_useFlattening)
 sets whether to flatten extrapolations to faces More...
 
virtual void noPPM (bool a_noPPM)
 sets whether to turn PPM off More...
 
virtual void doDeconvolution (bool a_doDeconvolution)
 sets m_doDeconvolution More...
 
virtual void doFaceDeconvolution (bool a_doFaceDeconvolution)
 sets m_doFaceDeconvolution More...
 
virtual void useArtificialViscosity (bool a_useArtificialViscosity)
 sets whether to use artificial viscosity (from divergence) More...
 
virtual void artificialViscosity (Real a_artificialViscosity)
 sets coefficient of artificial viscosity (from divergence) More...
 
virtual void useArtVisc (bool a_useArtVisc)
 sets whether to use artificial viscosity More...
 
virtual void ratioArtVisc (Real a_ratioArtVisc)
 sets coefficient of artificial viscosity More...
 
virtual void forwardEuler (bool a_forwardEuler)
 sets whether forward Euler is used (instead of RK4) More...
 
virtual void enforceMinVal (bool a_enforceMinVal, Real a_minVal)
 sets whether to enforce a min value in advection, along with valeu More...
 
virtual void domainLength (Real a_domainLength)
 Physical dimension of the longest side of the domain. More...
 
void x0 (const Real &a_x0)
 
virtual void verbosity (const int &verbosity)
 
virtual void refinementThreshold (Real a_refineThresh)
 Refinement threshold. More...
 
virtual void refinementIsScaled (bool a_refinementIsScaled)
 Set whether refinement threshold is scaled with dx. More...
 
virtual void tagPressure (bool a_tagPressure)
 Set whether to tag on pressure instead of on density. More...
 
virtual void tagVorticity (bool a_tagVorticity)
 Set whether to tag on vorticity instead of on density. More...
 
virtual void tagBufferSize (int a_tagBufferSize)
 Tag buffer size. More...
 
virtual void molPhysics (const MOLPhysics *const a_molPhysics)
 MOLPhysics class. More...
 
void initialDtMultiplier (Real a_initialDtMultiplier)
 Initial dt multiplier. More...
 
- Public Member Functions inherited from AMRLevelFactory
virtual ~AMRLevelFactory ()
 

Protected Member Functions

virtual void setDefaultValues ()
 
virtual void transferSettings (AMRLevelCons *a_newPtr) const
 

Protected Attributes

bool m_singleBlock
 
bool m_useSourceTerm
 
const LevelSourceTermm_sourceTerm
 
bool m_useArtificialDissipation
 
Real m_artificialDissipation
 
MultiBlockCoordSysFactorym_coordSysFact
 
std::string m_plotPrefix
 
bool m_writeJ
 
bool m_writeExact
 
bool m_writeError
 
bool m_writeMap
 Whether to write out mapping file. More...
 
AMRLevelMappedStabilityStrategym_stabilityStrategy
 
AMRLevelMappedTaggingStrategym_taggingStrategy
 
- Protected Attributes inherited from AMRLevelConsFactory
int m_verbosity
 
Real m_cfl
 
bool m_cflSet
 
int m_spaceOrder
 spatial order of accuracy (default is 4) More...
 
bool m_limitFaceValues
 if true, limit face values in advection More...
 
bool m_highOrderLimiter
 if true, use high-order limiter More...
 
bool m_initialAverage
 
bool m_useFlattening
 
bool m_noPPM
 
bool m_doDeconvolution
 
bool m_doFaceDeconvolution
 
bool m_useArtificialViscosity
 
Real m_artificialViscosity
 
bool m_useArtVisc
 
Real m_ratioArtVisc
 
bool m_forwardEuler
 
bool m_enforceMinVal
 if true, enforce min value More...
 
Real m_minVal
 min value to enforce More...
 
Real m_domainLength
 
bool m_domainLengthSet
 
Real m_refineThresh
 
bool m_refineThreshSet
 
bool m_refinementIsScaled
 
bool m_tagPressure
 
bool m_tagVorticity
 
int m_tagBufferSize
 
bool m_tagBufferSizeSet
 
Real m_initialDtMultiplier
 
bool m_initialDtMultiplierSet
 
const MOLPhysicsm_molPhysics
 

Private Member Functions

void operator= (const AMRLevelMappedConsFactory &a_input)
 
 AMRLevelMappedConsFactory (const AMRLevelMappedConsFactory &a_input)
 

Detailed Description

AMR Cons Equation factory.

Constructor & Destructor Documentation

AMRLevelMappedConsFactory::AMRLevelMappedConsFactory ( )

Null constructor.

AMRLevelMappedConsFactory::AMRLevelMappedConsFactory ( NewCoordSysFactory *const  a_coordSysFact,
AMRLevelMappedStabilityStrategy a_stableTimeSteppingStrategy,
AMRLevelMappedTaggingStrategy a_taggingStategy 
)

Constructor for a single-block coordinate system.

AMRLevelMappedConsFactory::AMRLevelMappedConsFactory ( MultiBlockCoordSysFactory *const  a_coordSysFact,
AMRLevelMappedStabilityStrategy a_stableTimeSteppingStrategy,
AMRLevelMappedTaggingStrategy a_taggingStategy 
)

Constructor for a multi-block coordinate system.

virtual AMRLevelMappedConsFactory::~AMRLevelMappedConsFactory ( )
virtual

Destructor.

AMRLevelMappedConsFactory::AMRLevelMappedConsFactory ( const AMRLevelMappedConsFactory a_input)
private

Member Function Documentation

virtual AMRLevel* AMRLevelMappedConsFactory::new_amrlevel ( ) const
virtual

Virtual constructor.

Reimplemented from AMRLevelConsFactory.

void AMRLevelMappedConsFactory::coordinateSystemFactory ( MultiBlockCoordSysFactory a_coordSysFact)

Set the factory for the coordinate system.

virtual void AMRLevelMappedConsFactory::useSourceTerm ( bool  a_useSourceTerm)
virtual

Set whether to use source term.

virtual void AMRLevelMappedConsFactory::sourceTerm ( const LevelSourceTerm *const  a_sourceTerm)
virtual

Source term class, if necessary.

virtual void AMRLevelMappedConsFactory::useArtificialDissipation ( bool  a_useArtificialDissipation)
virtual

Set whether to modify fluxes by adding artificial dissipation based on 5th derivative.

virtual void AMRLevelMappedConsFactory::artificialDissipation ( Real  a_artificialDissipation)
virtual

Set coefficient of artificial dissipation.

void AMRLevelMappedConsFactory::plotPrefix ( const std::string &  a_plotfile_prefix)
bool AMRLevelMappedConsFactory::isDefined ( ) const
virtual

Check that everything is defined.

Reimplemented from AMRLevelConsFactory.

virtual void AMRLevelMappedConsFactory::writeJ ( bool  a_writeJ)
virtual
virtual void AMRLevelMappedConsFactory::writeExact ( bool  a_writeExact)
virtual
virtual void AMRLevelMappedConsFactory::writeError ( bool  a_writeError)
virtual
virtual void AMRLevelMappedConsFactory::writeMap ( bool  a_writeMap)
virtual
virtual void AMRLevelMappedConsFactory::setDefaultValues ( )
protectedvirtual

Reimplemented from AMRLevelConsFactory.

virtual void AMRLevelMappedConsFactory::transferSettings ( AMRLevelCons a_newPtr) const
protectedvirtual

Reimplemented from AMRLevelConsFactory.

void AMRLevelMappedConsFactory::operator= ( const AMRLevelMappedConsFactory a_input)
private

Member Data Documentation

bool AMRLevelMappedConsFactory::m_singleBlock
protected
bool AMRLevelMappedConsFactory::m_useSourceTerm
protected
const LevelSourceTerm* AMRLevelMappedConsFactory::m_sourceTerm
protected
bool AMRLevelMappedConsFactory::m_useArtificialDissipation
protected
Real AMRLevelMappedConsFactory::m_artificialDissipation
protected
MultiBlockCoordSysFactory* AMRLevelMappedConsFactory::m_coordSysFact
protected
std::string AMRLevelMappedConsFactory::m_plotPrefix
protected
bool AMRLevelMappedConsFactory::m_writeJ
protected
bool AMRLevelMappedConsFactory::m_writeExact
protected
bool AMRLevelMappedConsFactory::m_writeError
protected
bool AMRLevelMappedConsFactory::m_writeMap
protected

Whether to write out mapping file.

AMRLevelMappedStabilityStrategy* AMRLevelMappedConsFactory::m_stabilityStrategy
protected
AMRLevelMappedTaggingStrategy* AMRLevelMappedConsFactory::m_taggingStrategy
protected

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