3.4
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | List of all members
Dumux::Experimental::MultiStageTimeStepper< PDESolver > Class Template Reference

Time stepping with a multi-stage method. More...

#include <dumux/timestepping/multistagetimestepper.hh>

Description

template<class PDESolver>
class Dumux::Experimental::MultiStageTimeStepper< PDESolver >

Time stepping with a multi-stage method.

Note
We limit ourselves to "diagonally" implicit multi-stage methods where solving a stage can only depend on the values of the same stage and stages before but not future stages (which would require solving larger linear systems)

Public Member Functions

 MultiStageTimeStepper (std::shared_ptr< PDESolver > pdeSolver, std::shared_ptr< const MultiStageMethod< Scalar > > msMethod)
 The constructor. More...
 
void step (Variables &vars, const Scalar t, const Scalar dt)
 Advance one time step of the given time loop. More...
 
void setMethod (std::shared_ptr< const MultiStageMethod< Scalar > > msMethod)
 Set/change the time step method. More...
 

Constructor & Destructor Documentation

◆ MultiStageTimeStepper()

template<class PDESolver >
Dumux::Experimental::MultiStageTimeStepper< PDESolver >::MultiStageTimeStepper ( std::shared_ptr< PDESolver pdeSolver,
std::shared_ptr< const MultiStageMethod< Scalar > >  msMethod 
)
inline

The constructor.

Parameters
pdeSolverSolver class for solving a PDE in each stage
msMethodThe multi-stage method which is to be used for time integration
Todo:
TODO: Add time step control if the pde solver doesn't converge

Member Function Documentation

◆ setMethod()

template<class PDESolver >
void Dumux::Experimental::MultiStageTimeStepper< PDESolver >::setMethod ( std::shared_ptr< const MultiStageMethod< Scalar > >  msMethod)
inline

Set/change the time step method.

◆ step()

template<class PDESolver >
void Dumux::Experimental::MultiStageTimeStepper< PDESolver >::step ( Variables &  vars,
const Scalar  t,
const Scalar  dt 
)
inline

Advance one time step of the given time loop.

Parameters
varsThe variables object at the current time level.
tThe current time level
dtThe time step size to be used
Note
We expect the time level in vars to correspond to the given time t
Todo:
: TODO: Add time step control if the pde solver doesn't converge

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