AMDiS 2.10
The Adaptive Multi-Dimensional Simulation Toolbox
AdaptBase Class Referenceabstract

Interface for adaption loops. More...

#include <AdaptBase.hpp>

Inherited by AdaptInstationary, and AdaptStationary.

Public Member Functions

 AdaptBase (std::string const &name, ProblemIterationInterface *problemIteration, AdaptInfo &adaptInfo, ProblemTimeInterface *problemTime=nullptr, AdaptInfo *initialAdaptInfo=nullptr)
 Constructor.
 
virtual ~AdaptBase ()=default
 Destructor.
 
virtual int adapt ()=0
 Pure virtual method. Must be overloaded by sub classes to perform a concrete adaption loop. More...
 
std::string const & name () const
 Returns name.
 
ProblemIterationInterfaceproblemIteration () const
 Returns problemIteration.
 
void setProblemIteration (ProblemIterationInterface *problemIteration)
 
AdaptInfoadaptInfo () const
 Returns adaptInfo.
 
ProblemTimeInterfaceproblemTime () const
 Returns problemTime.
 
void setProblemTime (ProblemTimeInterface *problemTime)
 
AdaptInfoinitialAdaptInfo () const
 Returns initialAdaptInfo.
 

Protected Attributes

std::string name_
 Name of the adaption loop.
 
ProblemIterationInterfaceproblemIteration_
 Problem iteration interface.
 
AdaptInfoadaptInfo_
 Main adapt info.
 
ProblemTimeInterfaceproblemTime_
 problem time interface
 
AdaptInfoinitialAdaptInfo_
 Adapt info for initial adapt. Will be given to problemTime->solveInitialProblem().
 

Detailed Description

Interface for adaption loops.

Member Function Documentation

◆ adapt()

virtual int adapt ( )
pure virtual

Pure virtual method. Must be overloaded by sub classes to perform a concrete adaption loop.

Implemented in AdaptInstationary, and AdaptStationary.


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