Chaste  Release::2017.1
AbstractTimeAdaptivityController Class Referenceabstract

#include <AbstractTimeAdaptivityController.hpp>

+ Collaboration diagram for AbstractTimeAdaptivityController:

Public Member Functions

 AbstractTimeAdaptivityController (double minimumTimeStep, double maximumTimeStep)
 
virtual ~AbstractTimeAdaptivityController ()
 
double GetNextTimeStep (double currentTime, Vec currentSolution)
 

Private Member Functions

virtual double ComputeTimeStep (double currentTime, Vec currentSolution)=0
 

Private Attributes

double mMinimumTimeStep
 
double mMaximumTimeStep
 

Detailed Description

Abstract class for defining rules for adaptive time-stepping.

Definition at line 45 of file AbstractTimeAdaptivityController.hpp.

Constructor & Destructor Documentation

AbstractTimeAdaptivityController::AbstractTimeAdaptivityController ( double  minimumTimeStep,
double  maximumTimeStep 
)
inline

Constructor.

Parameters
minimumTimeStepminimum timestep to be used
maximumTimeStepmaximum timestep to be used

Definition at line 73 of file AbstractTimeAdaptivityController.hpp.

virtual AbstractTimeAdaptivityController::~AbstractTimeAdaptivityController ( )
inlinevirtual

Destructor.

Definition at line 83 of file AbstractTimeAdaptivityController.hpp.

Member Function Documentation

virtual double AbstractTimeAdaptivityController::ComputeTimeStep ( double  currentTime,
Vec  currentSolution 
)
privatepure virtual
Returns
the timestep based on the current solution and current time. Doesn't need to be checked to be between the minimum and maximum timesteps.
Parameters
currentTimecurrent time
currentSolutioncurrent solution

Referenced by GetNextTimeStep().

double AbstractTimeAdaptivityController::GetNextTimeStep ( double  currentTime,
Vec  currentSolution 
)
inline
Returns
the actual timestep to be used.
Parameters
currentTimecurrent time
currentSolutioncurrent solution

Definition at line 93 of file AbstractTimeAdaptivityController.hpp.

References ComputeTimeStep(), mMaximumTimeStep, and mMinimumTimeStep.

Referenced by AbstractDynamicLinearPdeSolver< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Solve().

Member Data Documentation

double AbstractTimeAdaptivityController::mMaximumTimeStep
private

Maximum timestep to be used

Definition at line 53 of file AbstractTimeAdaptivityController.hpp.

Referenced by GetNextTimeStep().

double AbstractTimeAdaptivityController::mMinimumTimeStep
private

Minimum timestep to be used

Definition at line 50 of file AbstractTimeAdaptivityController.hpp.

Referenced by GetNextTimeStep().


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