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

#include <AMRLevelMappedStabilityStrategy.H>

Public Member Functions

 AMRLevelMappedStabilityStrategy (Real a_stabilityFactor)
 
virtual ~AMRLevelMappedStabilityStrategy ()
 Destructor. More...
 
Real maxTimeStep (const ProblemDomain &a_problem_domain, const DisjointBoxLayout &a_grids, const LevelGridMetrics *const a_gridMetrics, const MOLPhysics &a_physics, const MappedLevelData &a_data, Real a_dx, Real a_time) const
 
virtual Real maxWaveSpeed (const ProblemDomain &a_problem_domain, const DisjointBoxLayout &a_grids, const LevelGridMetrics *const a_gridMetrics, const MOLPhysics &a_physics, const MappedLevelData &a_data, Real a_dx, Real a_time) const =0
 
virtual AMRLevelMappedStabilityStrategyclone () const =0
 Override this method to create a new AMRLevelMappedStabilityStrategy instance. More...
 

Protected Attributes

Real m_stabilityFactor
 The stability factor. More...
 

Private Member Functions

 AMRLevelMappedStabilityStrategy ()
 
 AMRLevelMappedStabilityStrategy (const AMRLevelMappedStabilityStrategy &)
 
AMRLevelMappedStabilityStrategyoperator= (const AMRLevelMappedStabilityStrategy &)
 

Detailed Description

This class defines an interface for computing quantities needed for deciding on a stable time step for high-order mapped AMR algorithms.

Constructor & Destructor Documentation

◆ AMRLevelMappedStabilityStrategy() [1/3]

AMRLevelMappedStabilityStrategy::AMRLevelMappedStabilityStrategy ( Real  a_stabilityFactor)
explicit

Base class strategy constructor. Must be called by all subclasses.

Parameters
a_stabilityFactorThe factor representing the broadest height of the region of stability for the time integrator of interest.

◆ ~AMRLevelMappedStabilityStrategy()

virtual AMRLevelMappedStabilityStrategy::~AMRLevelMappedStabilityStrategy ( )
virtual

Destructor.

◆ AMRLevelMappedStabilityStrategy() [2/3]

AMRLevelMappedStabilityStrategy::AMRLevelMappedStabilityStrategy ( )
private

◆ AMRLevelMappedStabilityStrategy() [3/3]

AMRLevelMappedStabilityStrategy::AMRLevelMappedStabilityStrategy ( const AMRLevelMappedStabilityStrategy )
private

Member Function Documentation

◆ maxTimeStep()

Real AMRLevelMappedStabilityStrategy::maxTimeStep ( const ProblemDomain a_problem_domain,
const DisjointBoxLayout a_grids,
const LevelGridMetrics *const  a_gridMetrics,
const MOLPhysics a_physics,
const MappedLevelData a_data,
Real  a_dx,
Real  a_time 
) const

This returns the maximum allowable time step (without a CFL safety factor.

Parameters
a_dataThe mapped grid data to be used in determining the time step.
a_dxThe grid spacing that determines the time step.
a_timeThe time at which the time step is computed.

◆ maxWaveSpeed()

virtual Real AMRLevelMappedStabilityStrategy::maxWaveSpeed ( const ProblemDomain a_problem_domain,
const DisjointBoxLayout a_grids,
const LevelGridMetrics *const  a_gridMetrics,
const MOLPhysics a_physics,
const MappedLevelData a_data,
Real  a_dx,
Real  a_time 
) const
pure virtual

Override this method to determine the maximum wave speed on the computational domain.

Parameters
a_dataThe mapped grid data to be used in determining the wave speed.

◆ clone()

virtual AMRLevelMappedStabilityStrategy* AMRLevelMappedStabilityStrategy::clone ( ) const
pure virtual

Override this method to create a new AMRLevelMappedStabilityStrategy instance.

◆ operator=()

AMRLevelMappedStabilityStrategy& AMRLevelMappedStabilityStrategy::operator= ( const AMRLevelMappedStabilityStrategy )
private

Member Data Documentation

◆ m_stabilityFactor

Real AMRLevelMappedStabilityStrategy::m_stabilityFactor
protected

The stability factor.


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