AMRLevelPolytropicGasFactory Class Reference

AMR Godunov factory. More...

#include <AMRLevelPolytropicGasFactory.H>

Inheritance diagram for AMRLevelPolytropicGasFactory:

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 AMRLevel *	new_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 GodunovPhysics *	m_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() [1/2]

AMRLevelPolytropicGasFactory::AMRLevelPolytropicGasFactory

(

)

Null constructor.

~AMRLevelPolytropicGasFactory()

virtual AMRLevelPolytropicGasFactory::~AMRLevelPolytropicGasFactory ( )

virtual

Destructor.

AMRLevelPolytropicGasFactory() [2/2]

AMRLevelPolytropicGasFactory::AMRLevelPolytropicGasFactory ( const AMRLevelPolytropicGasFactory &  )

private

Member Function Documentation

define()

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_cfl	CFL number
a_domainLength	physical dimension of the longest side of the domain
a_verbosity	verbosity level
a_refineThresh	undivided gradient size over which a cell will be tagged for refinement
a_tagBufferSize	number of buffer cells around each tagged cell that will also be tagged
a_initialDtMultiplier	CFL number at beginning of calculation
a_godunovPhysics	physics class
a_normalPredOrder	order of the normal predictor: 1 for PLM, 2 for PPM
a_useFourthOrderSlopes	whether to use 4th-order slopes
a_usePrimLimiting	whether to apply slope limiting to primitive variables
a_useCharLimiting	whether to apply slope limiting to characteristic variables
a_useFlattening	whether to apply slope flattening
a_useArtificialViscosity	whether to apply artificial viscosity
a_artificialViscosity	artificial viscosity coefficient
a_useSourceTerm	whether to apply source term
a_sourceTermScaling	scaling of source term
a_highOrderLimiter	whether to apply 4th-order limiter

new_amrlevel()

virtual AMRLevel* AMRLevelPolytropicGasFactory::new_amrlevel ( ) const

virtual

Create a new AMRLevel (for polytropic gases)

Implements AMRLevelFactory.

isDefined()

bool AMRLevelPolytropicGasFactory::isDefined

(

)

const

Check that this object has been defined.

operator=()

void AMRLevelPolytropicGasFactory::operator= ( const AMRLevelPolytropicGasFactory &  )

private

Member Data Documentation

m_cfl

Real AMRLevelPolytropicGasFactory::m_cfl

protected

m_domainLength

Real AMRLevelPolytropicGasFactory::m_domainLength

protected

m_verbosity

int AMRLevelPolytropicGasFactory::m_verbosity

protected

m_refineThresh

Real AMRLevelPolytropicGasFactory::m_refineThresh

protected

m_tagBufferSize

int AMRLevelPolytropicGasFactory::m_tagBufferSize

protected

m_initialDtMultiplier

Real AMRLevelPolytropicGasFactory::m_initialDtMultiplier

protected

m_godunovPhysics

const GodunovPhysics* AMRLevelPolytropicGasFactory::m_godunovPhysics

protected

m_normalPredOrder

int AMRLevelPolytropicGasFactory::m_normalPredOrder

protected

m_useFourthOrderSlopes

bool AMRLevelPolytropicGasFactory::m_useFourthOrderSlopes

protected

m_usePrimLimiting

bool AMRLevelPolytropicGasFactory::m_usePrimLimiting

protected

m_useCharLimiting

bool AMRLevelPolytropicGasFactory::m_useCharLimiting

protected

m_useFlattening

bool AMRLevelPolytropicGasFactory::m_useFlattening

protected

m_useArtificialViscosity

bool AMRLevelPolytropicGasFactory::m_useArtificialViscosity

protected

m_artificialViscosity

Real AMRLevelPolytropicGasFactory::m_artificialViscosity

protected

m_useSourceTerm

bool AMRLevelPolytropicGasFactory::m_useSourceTerm

protected

m_sourceTermScaling

Real AMRLevelPolytropicGasFactory::m_sourceTermScaling

protected

m_highOrderLimiter

bool AMRLevelPolytropicGasFactory::m_highOrderLimiter

protected

m_isDefined

bool AMRLevelPolytropicGasFactory::m_isDefined

protected

---

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

• AMRLevelPolytropicGasFactory.H