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

AMR Godunov factory. More...

#include <AMRLevelPolytropicGasFactory.H>

Inheritance diagram for AMRLevelPolytropicGasFactory:
Inheritance graph
[legend]

Public Member Functions

 AMRLevelPolytropicGasFactory ()
 Null constructor. More...
 
virtual ~AMRLevelPolytropicGasFactory ()
 Destructor. More...
 
virtual void define (const Real &a_cfl, const Real &a_domainLength, const int &a_verbosity, const Real &a_refineThresh, const int &a_tagBufferSize, const Real &a_initialDtMultiplier, const GodunovPhysics *const a_godunovPhysics, const int &a_normalPredOrder, const bool &a_useFourthOrderSlopes, const bool &a_usePrimLimiting, const bool &a_useCharLimiting, const bool &a_useFlattening, const bool &a_useArtificialViscosity, const Real &a_artificialViscosity, const bool &a_useSourceTerm, const Real &a_sourceTermScaling, const bool &a_highOrderLimiter)
 Define the parameters of the factory. More...
 
virtual AMRLevelnew_amrlevel () const
 Create a new AMRLevel (for polytropic gases) More...
 
bool isDefined () const
 Check that this object has been defined. More...
 
- Public Member Functions inherited from AMRLevelFactory
virtual ~AMRLevelFactory ()
 

Protected Attributes

Real m_cfl
 
Real m_domainLength
 
int m_verbosity
 
Real m_refineThresh
 
int m_tagBufferSize
 
Real m_initialDtMultiplier
 
const GodunovPhysicsm_godunovPhysics
 
int m_normalPredOrder
 
bool m_useFourthOrderSlopes
 
bool m_usePrimLimiting
 
bool m_useCharLimiting
 
bool m_useFlattening
 
bool m_useArtificialViscosity
 
Real m_artificialViscosity
 
bool m_useSourceTerm
 
Real m_sourceTermScaling
 
bool m_highOrderLimiter
 
bool m_isDefined
 

Private Member Functions

void operator= (const AMRLevelPolytropicGasFactory &)
 
 AMRLevelPolytropicGasFactory (const AMRLevelPolytropicGasFactory &)
 

Detailed Description

AMR Godunov factory.

Constructor & Destructor Documentation

AMRLevelPolytropicGasFactory::AMRLevelPolytropicGasFactory ( )

Null constructor.

virtual AMRLevelPolytropicGasFactory::~AMRLevelPolytropicGasFactory ( )
virtual

Destructor.

AMRLevelPolytropicGasFactory::AMRLevelPolytropicGasFactory ( const AMRLevelPolytropicGasFactory )
private

Member Function Documentation

virtual void AMRLevelPolytropicGasFactory::define ( const Real a_cfl,
const Real a_domainLength,
const int &  a_verbosity,
const Real a_refineThresh,
const int &  a_tagBufferSize,
const Real a_initialDtMultiplier,
const GodunovPhysics *const  a_godunovPhysics,
const int &  a_normalPredOrder,
const bool &  a_useFourthOrderSlopes,
const bool &  a_usePrimLimiting,
const bool &  a_useCharLimiting,
const bool &  a_useFlattening,
const bool &  a_useArtificialViscosity,
const Real a_artificialViscosity,
const bool &  a_useSourceTerm,
const Real a_sourceTermScaling,
const bool &  a_highOrderLimiter 
)
virtual

Define the parameters of the factory.

Parameters
a_cflCFL number
a_domainLengthphysical dimension of the longest side of the domain
a_verbosityverbosity level
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_godunovPhysicsphysics class
a_normalPredOrderorder of the normal predictor: 1 for PLM, 2 for PPM
a_useFourthOrderSlopeswhether to use 4th-order slopes
a_usePrimLimitingwhether to apply slope limiting to primitive variables
a_useCharLimitingwhether to apply slope limiting to characteristic variables
a_useFlatteningwhether to apply slope flattening
a_useArtificialViscositywhether to apply artificial viscosity
a_artificialViscosityartificial viscosity coefficient
a_useSourceTermwhether to apply source term
a_sourceTermScalingscaling of source term
a_highOrderLimiterwhether to apply 4th-order limiter
virtual AMRLevel* AMRLevelPolytropicGasFactory::new_amrlevel ( ) const
virtual

Create a new AMRLevel (for polytropic gases)

Implements AMRLevelFactory.

bool AMRLevelPolytropicGasFactory::isDefined ( ) const

Check that this object has been defined.

void AMRLevelPolytropicGasFactory::operator= ( const AMRLevelPolytropicGasFactory )
private

Member Data Documentation

Real AMRLevelPolytropicGasFactory::m_cfl
protected
Real AMRLevelPolytropicGasFactory::m_domainLength
protected
int AMRLevelPolytropicGasFactory::m_verbosity
protected
Real AMRLevelPolytropicGasFactory::m_refineThresh
protected
int AMRLevelPolytropicGasFactory::m_tagBufferSize
protected
Real AMRLevelPolytropicGasFactory::m_initialDtMultiplier
protected
const GodunovPhysics* AMRLevelPolytropicGasFactory::m_godunovPhysics
protected
int AMRLevelPolytropicGasFactory::m_normalPredOrder
protected
bool AMRLevelPolytropicGasFactory::m_useFourthOrderSlopes
protected
bool AMRLevelPolytropicGasFactory::m_usePrimLimiting
protected
bool AMRLevelPolytropicGasFactory::m_useCharLimiting
protected
bool AMRLevelPolytropicGasFactory::m_useFlattening
protected
bool AMRLevelPolytropicGasFactory::m_useArtificialViscosity
protected
Real AMRLevelPolytropicGasFactory::m_artificialViscosity
protected
bool AMRLevelPolytropicGasFactory::m_useSourceTerm
protected
Real AMRLevelPolytropicGasFactory::m_sourceTermScaling
protected
bool AMRLevelPolytropicGasFactory::m_highOrderLimiter
protected
bool AMRLevelPolytropicGasFactory::m_isDefined
protected

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