Template Numerical Library version\ main:c173bea
Loading...
Searching...
No Matches
TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor > Class Template Reference

Base class for ODE solvers. More...

#include <TNL/Solvers/ODE/ExplicitSolver.h>

Inheritance diagram for TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >:
Collaboration diagram for TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >:

Public Types

using IndexType = Index
 Indexing type.
 
using RealType = Real
 Type of the floating-point arithmetics.
 
using SolverMonitorType = SolverMonitor
 Type of the monitor of the convergence of the solver.
 
- Public Types inherited from TNL::Solvers::IterativeSolver< double, int, IterativeSolverMonitor< double, int > >
using SolverMonitorType
 Type of an object used for monitoring of the convergence.
 

Public Member Functions

 ExplicitSolver ()=default
 Default constructor.
 
bool checkNextIteration ()
 Checks if the solver is allowed to do the next iteration.
 
const RealTypegetMaxTau () const
 Getter of maximal value of the time step.
 
const RealTypegetStopTime () const
 Getter of the time where the evolution computation shall by stopped.
 
const RealTypegetTau () const
 Getter of the time step used for the computation.
 
const RealTypegetTime () const
 Getter of the current time of the evolution computed by the solver.
 
void refreshSolverMonitor (bool force=false)
 This method refreshes the solver monitor.
 
void setMaxTau (const RealType &maxTau)
 Setter of maximal value of the time step.
 
void setStopTime (const RealType &stopTime)
 Setter of the time where the evolution computation shall by stopped.
 
void setTau (const RealType &tau)
 Setter of the time step used for the computation.
 
void setTestingMode (bool testingMode)
 
void setTime (const RealType &t)
 Settter of the current time of the evolution computed by the solver.
 
bool setup (const Config::ParameterContainer &parameters, const std::string &prefix="")
 Method for setup of the iterative solver based on configuration parameters.
 
- Public Member Functions inherited from TNL::Solvers::IterativeSolver< double, int, IterativeSolverMonitor< double, int > >
 IterativeSolver ()=default
 Default constructor.
 
bool checkConvergence ()
 Checks whether the convergence occurred already.
 
bool checkNextIteration ()
 Checks if the solver is allowed to do the next iteration.
 
const double & getConvergenceResidue () const
 Gets the the convergence threshold.
 
const double & getDivergenceResidue () const
 Gets the limit for the divergence criterion.
 
const int & getIterations () const
 Gets the number of iterations performed by the solver so far.
 
const int & getMaxIterations () const
 Gets the maximal number of iterations the solver is allowed to perform.
 
const int & getMinIterations () const
 Gets the minimal number of iterations the solver is supposed to do.
 
const double & getResidue () const
 Gets the residue reached at the current iteration.
 
bool nextIteration ()
 Proceeds to the next iteration.
 
void resetIterations ()
 Sets the the number of the current iterations to zero.
 
void setConvergenceResidue (const double &convergenceResidue)
 Sets the threshold for the convergence.
 
void setDivergenceResidue (const double &divergenceResidue)
 Sets the residue limit for the divergence criterion.
 
void setMaxIterations (const int &maxIterations)
 Sets the maximal number of iterations the solver is allowed to perform.
 
void setMinIterations (const int &minIterations)
 Sets the minimal number of iterations the solver is supposed to do.
 
void setRefreshRate (const int &refreshRate)
 Sets the refresh rate (in milliseconds) for the solver monitor.
 
void setResidue (const double &residue)
 Sets the residue reached at the current iteration.
 
void setSolverMonitor (SolverMonitorType &solverMonitor)
 Sets the solver monitor object.
 
bool setup (const Config::ParameterContainer &parameters, const std::string &prefix="")
 Method for setup of the iterative solver based on configuration parameters.
 

Static Public Member Functions

static void configSetup (Config::ConfigDescription &config, const std::string &prefix="")
 This method defines configuration entries for setup of the iterative solver.
 
- Static Public Member Functions inherited from TNL::Solvers::IterativeSolver< double, int, IterativeSolverMonitor< double, int > >
static void configSetup (Config::ConfigDescription &config, const std::string &prefix="")
 This method defines configuration entries for setup of the iterative solver.
 

Protected Attributes

RealType maxTau = std::numeric_limits< RealType >::max()
 
bool stopOnSteadyState = false
 
RealType stopTime = 0.0
 
RealType tau = 0.0
 
bool testingMode = false
 
RealType time = 0.0
 
- Protected Attributes inherited from TNL::Solvers::IterativeSolver< double, int, IterativeSolverMonitor< double, int > >
double convergenceResidue
 
int currentIteration
 
double currentResidue
 
double divergenceResidue
 
int maxIterations
 
int minIterations
 
int refreshRate
 
std::ofstream residualHistoryFile
 
std::string residualHistoryFileName
 
IterativeSolverMonitor< double, int > * solverMonitor
 

Detailed Description

template<typename Real = double, typename Index = int, typename SolverMonitor = IterativeSolverMonitor< Real, Index >>
class TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >

Base class for ODE solvers.

Template Parameters
Realis type of the floating-point arithmetics.
Indexis type for indexing.
IterativeSolverMonitor<Real, Index > is

Member Function Documentation

◆ checkNextIteration()

template<typename Real , typename Index , typename SolverMonitor >
bool TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >::checkNextIteration ( )
nodiscard

Checks if the solver is allowed to do the next iteration.

Returns
true true if the solver is allowed to do the next iteration.
false if the solver is not allowed to do the next iteration. This may happen because the divergence occurred.

◆ configSetup()

template<typename Real , typename Index , typename SolverMonitor >
void TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >::configSetup ( Config::ConfigDescription & config,
const std::string & prefix = "" )
static

This method defines configuration entries for setup of the iterative solver.

Parameters
configis the config description.
prefixis the prefix of the configuration parameters for this solver.

◆ refreshSolverMonitor()

template<typename Real , typename Index , typename SolverMonitor >
void TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >::refreshSolverMonitor ( bool force = false)

This method refreshes the solver monitor.

The method propagates values of time, time step and others to the solver monitor.

◆ setMaxTau()

template<typename Real , typename Index , typename SolverMonitor >
void TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >::setMaxTau ( const RealType & maxTau)

Setter of maximal value of the time step.

If methods uses adaptive choice of the time step, this sets the upper limit.

◆ setTau()

template<typename Real , typename Index , typename SolverMonitor >
void TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >::setTau ( const RealType & tau)

Setter of the time step used for the computation.

The time step can be changed by methods using adaptive choice of the time step.

◆ setup()

template<typename Real , typename Index , typename SolverMonitor >
bool TNL::Solvers::ODE::ExplicitSolver< Real, Index, SolverMonitor >::setup ( const Config::ParameterContainer & parameters,
const std::string & prefix = "" )

Method for setup of the iterative solver based on configuration parameters.

Parameters
parametersis the container for configuration parameters.
prefixis the prefix of the configuration parameters for this solver.
Returns
true if the parameters where parsed sucessfuly.
false if the method did not succeed to read the configuration parameters.

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