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

AMR Godunov. More...

#include <AMRLevelPolytropicGas.H>

Inheritance diagram for AMRLevelPolytropicGas:
Inheritance graph
[legend]

Public Member Functions

 AMRLevelPolytropicGas ()
 Constructor. More...
 
virtual ~AMRLevelPolytropicGas ()
 Destructor. More...
 
void defineParams (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 the object needs. More...
 
virtual void define (AMRLevel *a_coarserLevelPtr, const Box &a_problemDomain, int a_level, int a_refRatio)
 This instance should never get called - historical. More...
 
virtual void define (AMRLevel *a_coarserLevelPtr, const ProblemDomain &a_problemDomain, int a_level, int a_refRatio)
 Define new AMRLevelPolytropicGas. More...
 
virtual Real advance ()
 Advance by one timestep. More...
 
virtual void postTimeStep ()
 Things to do after a timestep. More...
 
virtual void tagCells (IntVectSet &a_tags)
 Create tags for regridding. More...
 
virtual void tagCellsInit (IntVectSet &a_tags)
 Create tags at initialization. More...
 
virtual void regrid (const Vector< Box > &a_newGrids)
 Set up data on this level after regridding. More...
 
virtual void initialGrid (const Vector< Box > &a_newGrids)
 Initialize grids. More...
 
virtual void initialData ()
 Initialize data. More...
 
virtual void postInitialize ()
 Things to do after initialization. More...
 
virtual void writeCheckpointHeader (HDF5Handle &a_handle) const
 Write checkpoint header. More...
 
virtual void writeCheckpointLevel (HDF5Handle &a_handle) const
 Write checkpoint data for this level. More...
 
virtual void readCheckpointHeader (HDF5Handle &a_handle)
 Read checkpoint header. More...
 
virtual void readCheckpointLevel (HDF5Handle &a_handle)
 Read checkpoint data for this level. More...
 
virtual void writePlotHeader (HDF5Handle &a_handle) const
 Write plotfile header. More...
 
virtual void writePlotLevel (HDF5Handle &a_handle) const
 Write plotfile data for this level. More...
 
virtual Real computeDt ()
 Returns the dt computed earlier for this level. More...
 
virtual Real computeInitialDt ()
 Compute dt using initial data. More...
 
const LevelData< FArrayBox > & getStateNew () const
 
const LevelData< FArrayBox > & getStateOld () const
 
bool allDefined () const
 
- Public Member Functions inherited from AMRLevel
 AMRLevel ()
 
virtual ~AMRLevel ()
 
virtual bool convergedToSteadyState ()
 
virtual void preRegrid (int a_base_level, const Vector< Vector< Box > > &a_new_grids)
 
virtual void postRegrid (int a_base_level)
 
virtual void postInitialGrid (const bool a_restart)
 
virtual void conclude (int a_step) const
 
virtual void writeCustomPlotFile (const std::string &a_prefix, int a_step) const
 
virtual void finerLevelPtr (AMRLevel *a_finer_level_ptr)
 
virtual void dt (Real a_dt)
 
virtual void time (Real a_time)
 
virtual void initialDtMultiplier (Real a_initial_dt_multiplier)
 
virtual Real dt () const
 
virtual Real time () const
 
virtual Real initialDtMultiplier () const
 
virtual const ProblemDomainproblemDomain () const
 
virtual Vector< Boxboxes () const
 
bool isDefined () const
 
bool hasCoarserLevel () const
 
bool hasFinerLevel () const
 
virtual int level () const
 
virtual int refRatio () const
 
Vector< AMRLevel * > getAMRLevelHierarchy ()
 Retrieve an array of all of the AMRLevel objects in the entire hierarchy. More...
 

Protected Member Functions

DisjointBoxLayout loadBalance (const Vector< Box > &a_grids)
 
void levelSetup ()
 
AMRLevelPolytropicGasgetCoarserLevel () const
 
AMRLevelPolytropicGasgetFinerLevel () const
 

Protected Attributes

LevelData< FArrayBoxm_UOld
 
LevelData< FArrayBoxm_UNew
 
Real m_cfl
 
Real m_dx
 
FineInterp m_fineInterp
 
CoarseAverage m_coarseAverage
 
Real m_dtNew
 
int m_numStates
 
Vector< string > m_stateNames
 
int m_numGhost
 
Real m_domainLength
 
LevelGodunov m_levelGodunov
 
LevelFluxRegister m_fluxRegister
 
GodunovPhysicsm_gdnvPhysics
 
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
 
Real m_refineThresh
 
int m_tagBufferSize
 
bool m_hasCoarser
 
bool m_hasFiner
 
DisjointBoxLayout m_grids
 
bool m_paramsDefined
 
- Protected Attributes inherited from AMRLevel
ProblemDomain m_problem_domain
 
Vector< Boxm_level_grids
 
int m_level
 
int m_ref_ratio
 
Real m_initial_dt_multiplier
 
Real m_dt
 
Real m_time
 
AMRLevelm_coarser_level_ptr
 
AMRLevelm_finer_level_ptr
 
bool m_isDefined
 

Private Member Functions

void operator= (const AMRLevelPolytropicGas &)
 
 AMRLevelPolytropicGas (const AMRLevelPolytropicGas &)
 

Additional Inherited Members

- Static Public Member Functions inherited from AMRLevel
static int verbosity ()
 
static void verbosity (int a_verbosity)
 
- Static Protected Attributes inherited from AMRLevel
static int s_verbosity
 

Detailed Description

AMR Godunov.

Constructor & Destructor Documentation

AMRLevelPolytropicGas::AMRLevelPolytropicGas ( )

Constructor.

virtual AMRLevelPolytropicGas::~AMRLevelPolytropicGas ( )
virtual

Destructor.

AMRLevelPolytropicGas::AMRLevelPolytropicGas ( const AMRLevelPolytropicGas )
private

Member Function Documentation

void AMRLevelPolytropicGas::defineParams ( 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 the object needs.

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 void AMRLevelPolytropicGas::define ( AMRLevel a_coarserLevelPtr,
const Box a_problemDomain,
int  a_level,
int  a_refRatio 
)
virtual

This instance should never get called - historical.

Reimplemented from AMRLevel.

virtual void AMRLevelPolytropicGas::define ( AMRLevel a_coarserLevelPtr,
const ProblemDomain a_problemDomain,
int  a_level,
int  a_refRatio 
)
virtual

Define new AMRLevelPolytropicGas.

Reimplemented from AMRLevel.

virtual Real AMRLevelPolytropicGas::advance ( )
virtual

Advance by one timestep.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::postTimeStep ( )
virtual

Things to do after a timestep.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::tagCells ( IntVectSet a_tags)
virtual

Create tags for regridding.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::tagCellsInit ( IntVectSet a_tags)
virtual

Create tags at initialization.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::regrid ( const Vector< Box > &  a_newGrids)
virtual

Set up data on this level after regridding.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::initialGrid ( const Vector< Box > &  a_newGrids)
virtual

Initialize grids.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::initialData ( )
virtual

Initialize data.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::postInitialize ( )
virtual

Things to do after initialization.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::writeCheckpointHeader ( HDF5Handle a_handle) const
virtual

Write checkpoint header.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::writeCheckpointLevel ( HDF5Handle a_handle) const
virtual

Write checkpoint data for this level.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::readCheckpointHeader ( HDF5Handle a_handle)
virtual

Read checkpoint header.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::readCheckpointLevel ( HDF5Handle a_handle)
virtual

Read checkpoint data for this level.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::writePlotHeader ( HDF5Handle a_handle) const
virtual

Write plotfile header.

Implements AMRLevel.

virtual void AMRLevelPolytropicGas::writePlotLevel ( HDF5Handle a_handle) const
virtual

Write plotfile data for this level.

Implements AMRLevel.

virtual Real AMRLevelPolytropicGas::computeDt ( )
virtual

Returns the dt computed earlier for this level.

Implements AMRLevel.

virtual Real AMRLevelPolytropicGas::computeInitialDt ( )
virtual

Compute dt using initial data.

Implements AMRLevel.

const LevelData<FArrayBox>& AMRLevelPolytropicGas::getStateNew ( ) const
const LevelData<FArrayBox>& AMRLevelPolytropicGas::getStateOld ( ) const
bool AMRLevelPolytropicGas::allDefined ( ) const
DisjointBoxLayout AMRLevelPolytropicGas::loadBalance ( const Vector< Box > &  a_grids)
protected
void AMRLevelPolytropicGas::levelSetup ( )
protected
AMRLevelPolytropicGas* AMRLevelPolytropicGas::getCoarserLevel ( ) const
protected
AMRLevelPolytropicGas* AMRLevelPolytropicGas::getFinerLevel ( ) const
protected
void AMRLevelPolytropicGas::operator= ( const AMRLevelPolytropicGas )
private

Member Data Documentation

LevelData<FArrayBox> AMRLevelPolytropicGas::m_UOld
protected
LevelData<FArrayBox> AMRLevelPolytropicGas::m_UNew
protected
Real AMRLevelPolytropicGas::m_cfl
protected
Real AMRLevelPolytropicGas::m_dx
protected
FineInterp AMRLevelPolytropicGas::m_fineInterp
protected
CoarseAverage AMRLevelPolytropicGas::m_coarseAverage
protected
Real AMRLevelPolytropicGas::m_dtNew
protected
int AMRLevelPolytropicGas::m_numStates
protected
Vector<string> AMRLevelPolytropicGas::m_stateNames
protected
int AMRLevelPolytropicGas::m_numGhost
protected
Real AMRLevelPolytropicGas::m_domainLength
protected
LevelGodunov AMRLevelPolytropicGas::m_levelGodunov
protected
LevelFluxRegister AMRLevelPolytropicGas::m_fluxRegister
protected
GodunovPhysics* AMRLevelPolytropicGas::m_gdnvPhysics
protected
int AMRLevelPolytropicGas::m_normalPredOrder
protected
bool AMRLevelPolytropicGas::m_useFourthOrderSlopes
protected
bool AMRLevelPolytropicGas::m_usePrimLimiting
protected
bool AMRLevelPolytropicGas::m_useCharLimiting
protected
bool AMRLevelPolytropicGas::m_useFlattening
protected
bool AMRLevelPolytropicGas::m_useArtificialViscosity
protected
Real AMRLevelPolytropicGas::m_artificialViscosity
protected
bool AMRLevelPolytropicGas::m_useSourceTerm
protected
Real AMRLevelPolytropicGas::m_sourceTermScaling
protected
bool AMRLevelPolytropicGas::m_highOrderLimiter
protected
Real AMRLevelPolytropicGas::m_refineThresh
protected
int AMRLevelPolytropicGas::m_tagBufferSize
protected
bool AMRLevelPolytropicGas::m_hasCoarser
protected
bool AMRLevelPolytropicGas::m_hasFiner
protected
DisjointBoxLayout AMRLevelPolytropicGas::m_grids
protected
bool AMRLevelPolytropicGas::m_paramsDefined
protected

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