AMRLevelConsFactory Class Reference
#include <AMRLevelConsFactory.H>
Inheritance diagram for AMRLevelConsFactory:
Detailed Description
AMR Cons Equation factory.Public Member Functions | |
| AMRLevelConsFactory () | |
| Null constructor. | |
| virtual AMRLevel * | new_amrlevel () const |
| Virtual constructor. | |
| virtual | ~AMRLevelConsFactory () |
| Destructor. | |
| virtual void | CFL (Real a_cfl) |
| CFL number. | |
| virtual void | spaceOrder (int a_spaceOrder) |
| spatial order of accuracy (default is 4) | |
| virtual void | limitFaceValues (bool a_limitFaceValues) |
| sets whether to limit face values in advection (default is false) | |
| virtual void | highOrderLimiter (bool a_highOrderLimiter) |
| sets whether to use high-order limiter (default is true) | |
| virtual void | initialAverage (bool a_initialAverage) |
| sets whether initial data is average; default false | |
| virtual void | useFlattening (bool a_useFlattening) |
| sets whether to flatten extrapolations to faces | |
| virtual void | noPPM (bool a_noPPM) |
| sets whether to turn PPM off | |
| virtual void | doDeconvolution (bool a_doDeconvolution) |
| sets m_doDeconvolution | |
| virtual void | doFaceDeconvolution (bool a_doFaceDeconvolution) |
| sets m_doFaceDeconvolution | |
| virtual void | useArtificialViscosity (bool a_useArtificialViscosity) |
| sets whether to use artificial viscosity (from divergence) | |
| virtual void | artificialViscosity (Real a_artificialViscosity) |
| sets coefficient of artificial viscosity (from divergence) | |
| virtual void | useArtVisc (bool a_useArtVisc) |
| sets whether to use artificial viscosity | |
| virtual void | ratioArtVisc (Real a_ratioArtVisc) |
| sets coefficient of artificial viscosity | |
| virtual void | forwardEuler (bool a_forwardEuler) |
| sets whether forward Euler is used (instead of RK4) | |
| virtual void | enforceMinVal (bool a_enforceMinVal, Real a_minVal) |
| sets whether to enforce a min value in advection, along with valeu | |
| virtual void | domainLength (Real a_domainLength) |
| Physical dimension of the longest side of the domain. | |
| void | x0 (const Real &a_x0) |
| virtual void | verbosity (const int &verbosity) |
| virtual void | refinementThreshold (Real a_refineThresh) |
| Refinement threshold. | |
| virtual void | refinementIsScaled (bool a_refinementIsScaled) |
| Set whether refinement threshold is scaled with dx. | |
| virtual void | tagPressure (bool a_tagPressure) |
| Set whether to tag on pressure instead of on density. | |
| virtual void | tagVorticity (bool a_tagVorticity) |
| Set whether to tag on vorticity instead of on density. | |
| virtual void | tagBufferSize (int a_tagBufferSize) |
| Tag buffer size. | |
| virtual void | molPhysics (const MOLPhysics *const a_molPhysics) |
| MOLPhysics class. | |
| void | initialDtMultiplier (Real a_initialDtMultiplier) |
| Initial dt multiplier. | |
| virtual bool | isDefined () const |
| Check that everything is defined. | |
Protected Member Functions | |
| virtual void | setDefaultValues () |
| virtual void | transferSettings (AMRLevelCons *a_newPtr) const |
Protected Attributes | |
| int | m_verbosity |
| Real | m_cfl |
| bool | m_cflSet |
| int | m_spaceOrder |
| spatial order of accuracy (default is 4) | |
| bool | m_limitFaceValues |
| if true, limit face values in advection | |
| bool | m_highOrderLimiter |
| if true, use high-order limiter | |
| 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 | |
| Real | m_minVal |
| min value to enforce | |
| 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 MOLPhysics * | m_molPhysics |
Private Member Functions | |
| void | operator= (const AMRLevelConsFactory &a_input) |
| AMRLevelConsFactory (const AMRLevelConsFactory &a_input) | |
Constructor & Destructor Documentation
| AMRLevelConsFactory::AMRLevelConsFactory | ( | ) |
Null constructor.
| virtual AMRLevelConsFactory::~AMRLevelConsFactory | ( | ) | [virtual] |
Destructor.
| AMRLevelConsFactory::AMRLevelConsFactory | ( | const AMRLevelConsFactory & | a_input | ) | [private] |
Member Function Documentation
| virtual AMRLevel* AMRLevelConsFactory::new_amrlevel | ( | ) | const [virtual] |
| virtual void AMRLevelConsFactory::CFL | ( | Real | a_cfl | ) | [virtual] |
CFL number.
| virtual void AMRLevelConsFactory::spaceOrder | ( | int | a_spaceOrder | ) | [virtual] |
spatial order of accuracy (default is 4)
| virtual void AMRLevelConsFactory::limitFaceValues | ( | bool | a_limitFaceValues | ) | [virtual] |
sets whether to limit face values in advection (default is false)
| virtual void AMRLevelConsFactory::highOrderLimiter | ( | bool | a_highOrderLimiter | ) | [virtual] |
sets whether to use high-order limiter (default is true)
| virtual void AMRLevelConsFactory::initialAverage | ( | bool | a_initialAverage | ) | [virtual] |
sets whether initial data is average; default false
| virtual void AMRLevelConsFactory::useFlattening | ( | bool | a_useFlattening | ) | [virtual] |
sets whether to flatten extrapolations to faces
| virtual void AMRLevelConsFactory::noPPM | ( | bool | a_noPPM | ) | [virtual] |
sets whether to turn PPM off
| virtual void AMRLevelConsFactory::doDeconvolution | ( | bool | a_doDeconvolution | ) | [virtual] |
sets m_doDeconvolution
| virtual void AMRLevelConsFactory::doFaceDeconvolution | ( | bool | a_doFaceDeconvolution | ) | [virtual] |
sets m_doFaceDeconvolution
| virtual void AMRLevelConsFactory::useArtificialViscosity | ( | bool | a_useArtificialViscosity | ) | [virtual] |
sets whether to use artificial viscosity (from divergence)
| virtual void AMRLevelConsFactory::artificialViscosity | ( | Real | a_artificialViscosity | ) | [virtual] |
sets coefficient of artificial viscosity (from divergence)
| virtual void AMRLevelConsFactory::useArtVisc | ( | bool | a_useArtVisc | ) | [virtual] |
sets whether to use artificial viscosity
| virtual void AMRLevelConsFactory::ratioArtVisc | ( | Real | a_ratioArtVisc | ) | [virtual] |
sets coefficient of artificial viscosity
| virtual void AMRLevelConsFactory::forwardEuler | ( | bool | a_forwardEuler | ) | [virtual] |
sets whether forward Euler is used (instead of RK4)
| virtual void AMRLevelConsFactory::enforceMinVal | ( | bool | a_enforceMinVal, | |
| Real | a_minVal | |||
| ) | [virtual] |
sets whether to enforce a min value in advection, along with valeu
| virtual void AMRLevelConsFactory::domainLength | ( | Real | a_domainLength | ) | [virtual] |
Physical dimension of the longest side of the domain.
| void AMRLevelConsFactory::x0 | ( | const Real & | a_x0 | ) |
| virtual void AMRLevelConsFactory::verbosity | ( | const int & | verbosity | ) | [virtual] |
| virtual void AMRLevelConsFactory::refinementThreshold | ( | Real | a_refineThresh | ) | [virtual] |
Refinement threshold.
| virtual void AMRLevelConsFactory::refinementIsScaled | ( | bool | a_refinementIsScaled | ) | [virtual] |
Set whether refinement threshold is scaled with dx.
| virtual void AMRLevelConsFactory::tagPressure | ( | bool | a_tagPressure | ) | [virtual] |
Set whether to tag on pressure instead of on density.
| virtual void AMRLevelConsFactory::tagVorticity | ( | bool | a_tagVorticity | ) | [virtual] |
Set whether to tag on vorticity instead of on density.
| virtual void AMRLevelConsFactory::tagBufferSize | ( | int | a_tagBufferSize | ) | [virtual] |
Tag buffer size.
| virtual void AMRLevelConsFactory::molPhysics | ( | const MOLPhysics *const | a_molPhysics | ) | [virtual] |
MOLPhysics class.
| void AMRLevelConsFactory::initialDtMultiplier | ( | Real | a_initialDtMultiplier | ) |
Initial dt multiplier.
| virtual bool AMRLevelConsFactory::isDefined | ( | ) | const [virtual] |
| virtual void AMRLevelConsFactory::setDefaultValues | ( | ) | [protected, virtual] |
Reimplemented in AMRLevelMappedConsFactory.
| virtual void AMRLevelConsFactory::transferSettings | ( | AMRLevelCons * | a_newPtr | ) | const [protected, virtual] |
Reimplemented in AMRLevelMappedConsFactory.
| void AMRLevelConsFactory::operator= | ( | const AMRLevelConsFactory & | a_input | ) | [private] |
Member Data Documentation
int AMRLevelConsFactory::m_verbosity [protected] |
Real AMRLevelConsFactory::m_cfl [protected] |
bool AMRLevelConsFactory::m_cflSet [protected] |
int AMRLevelConsFactory::m_spaceOrder [protected] |
spatial order of accuracy (default is 4)
bool AMRLevelConsFactory::m_limitFaceValues [protected] |
if true, limit face values in advection
bool AMRLevelConsFactory::m_highOrderLimiter [protected] |
if true, use high-order limiter
bool AMRLevelConsFactory::m_initialAverage [protected] |
bool AMRLevelConsFactory::m_useFlattening [protected] |
bool AMRLevelConsFactory::m_noPPM [protected] |
bool AMRLevelConsFactory::m_doDeconvolution [protected] |
bool AMRLevelConsFactory::m_doFaceDeconvolution [protected] |
bool AMRLevelConsFactory::m_useArtificialViscosity [protected] |
Real AMRLevelConsFactory::m_artificialViscosity [protected] |
bool AMRLevelConsFactory::m_useArtVisc [protected] |
Real AMRLevelConsFactory::m_ratioArtVisc [protected] |
bool AMRLevelConsFactory::m_forwardEuler [protected] |
bool AMRLevelConsFactory::m_enforceMinVal [protected] |
if true, enforce min value
Real AMRLevelConsFactory::m_minVal [protected] |
min value to enforce
Real AMRLevelConsFactory::m_domainLength [protected] |
bool AMRLevelConsFactory::m_domainLengthSet [protected] |
Real AMRLevelConsFactory::m_refineThresh [protected] |
bool AMRLevelConsFactory::m_refineThreshSet [protected] |
bool AMRLevelConsFactory::m_refinementIsScaled [protected] |
bool AMRLevelConsFactory::m_tagPressure [protected] |
bool AMRLevelConsFactory::m_tagVorticity [protected] |
int AMRLevelConsFactory::m_tagBufferSize [protected] |
bool AMRLevelConsFactory::m_tagBufferSizeSet [protected] |
Real AMRLevelConsFactory::m_initialDtMultiplier [protected] |
bool AMRLevelConsFactory::m_initialDtMultiplierSet [protected] |
const MOLPhysics* AMRLevelConsFactory::m_molPhysics [protected] |
The documentation for this class was generated from the following file:
