Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV > Class Template Reference

Do one step of a time-stepping scheme. More...

#include <dune/pdelab/instationary/implicitonestep.hh>

Public Types
typedef OneStepMethodResult	Result

Public Member Functions
	OneStepMethod (const TimeSteppingParameterInterface< T > &method_, IGOS &igos_, PDESOLVER &pdesolver_)
	construct a new one step scheme
void	setVerbosityLevel (int level)
	change verbosity level; 0 means completely quiet
void	setStepNumber (int newstep)
	change number of current step
const PDESOLVER &	getPDESolver () const
	Access to the (non) linear solver.
PDESOLVER &	getPDESolver ()
	Access to the (non) linear solver.
const Result &	result () const
void	setResult (const OneStepMethodResult &result_)
	Set a new result.
void	setMethod (const TimeSteppingParameterInterface< T > &method_)
	redefine the method to be used; can be done before every step
T	apply (T time, T dt, TrlV &xold, TrlV &xnew)
	do one step;
template<typename F >
T	apply (T time, T dt, TrlV &xold, F &f, TrlV &xnew)
	do one step; This is a version which interpolates constraints at the start of each stage

Detailed Description

template<class T, class IGOS, class PDESOLVER, class TrlV, class TstV = TrlV>
class Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >

Do one step of a time-stepping scheme.

Template Parameters

T	type to represent time values
IGOS	assembler for instationary problems
PDESOLVER	solver problem in each step (typically Newton)
TrlV	vector type to represent coefficients of solutions
TstV	vector type to represent residuals

Examples

recipe-operator-splitting.cc.

Member Typedef Documentation

Result

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

typedef OneStepMethodResult Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::Result

Constructor & Destructor Documentation

OneStepMethod()

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::OneStepMethod ( const TimeSteppingParameterInterface< T > &  method_, IGOS &  igos_, PDESOLVER &  pdesolver_  )

inline

construct a new one step scheme

Parameters

method_	Parameter object. This chooses the actual method used.
igos_	Assembler object (instationary grid operator space).
pdesolver_	solver object (typically Newton).

The contructed method object stores references to the object it is constructed with, so these objects should be valid for as long as the constructed object is used (or until setMethod() is called, see there).

Member Function Documentation

apply() [1/2]

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

template<typename F >

T Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::apply ( T  time, T  dt, TrlV &  xold, F &  f, TrlV &  xnew  )

inline

do one step; This is a version which interpolates constraints at the start of each stage

Parameters

[in]	time	start of time step
[in]	dt	suggested time step size
[in]	xold	value at begin of time step
[in]	f	function to interpolate boundary conditions from
[in,out]	xnew	value at end of time step; contains initial guess for first substep on entry

Returns

selected time step size

apply() [2/2]

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

T Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::apply ( T  time, T  dt, TrlV &  xold, TrlV &  xnew  )

inline

do one step;

Parameters

[in]	time	start of time step
[in]	dt	suggested time step size
[in]	xold	value at begin of time step
[in,out]	xnew	value at end of time step; contains initial guess for first substep on entry

Returns

selected time step size

getPDESolver() [1/2]

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

PDESOLVER & Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::getPDESolver ( )

inline

Access to the (non) linear solver.

getPDESolver() [2/2]

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

const PDESOLVER & Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::getPDESolver ( ) const

inline

Access to the (non) linear solver.

result()

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

const Result & Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::result ( ) const

inline

setMethod()

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

void Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::setMethod ( const TimeSteppingParameterInterface< T > &  method_ )

inline

redefine the method to be used; can be done before every step

Parameters

method_

Parameter object.

The OneStepMethod object stores a reference to the method_ object. The old method object is no longer referenced after this member function returns.

setResult()

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

void Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::setResult ( const OneStepMethodResult &  result_ )

inline

Set a new result.

Parameters

result_

OneStepMethodResult object

Set the step number to the next timestep according to the result.

setStepNumber()

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

void Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::setStepNumber ( int  newstep )

inline

change number of current step

setVerbosityLevel()

template<class T , class IGOS , class PDESOLVER , class TrlV , class TstV = TrlV>

void Dune::PDELab::OneStepMethod< T, IGOS, PDESOLVER, TrlV, TstV >::setVerbosityLevel ( int  level )

inline

change verbosity level; 0 means completely quiet

---

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

• implicitonestep.hh