DuneODE::OdeSolverInterface< DestinationImp > Class Template Reference

Interface class for ODE Solver. More...

#include <dune/fem/solver/odesolverinterface.hh>

Inheritance diagram for DuneODE::OdeSolverInterface< DestinationImp >:

Classes
struct	Monitor

Public Types
typedef Monitor	MonitorType
	monitor type
typedef DestinationImp	DestinationType
	type of destination

Public Member Functions
virtual	~OdeSolverInterface ()
	destructor
virtual void	initialize (const DestinationType &arg)=0
	initialize solver
virtual void	solve (DestinationType &u)
	solve \(\partial_t u = L(u)\) where \(L\) is the internal operator.
virtual void	solve (DestinationType &u, MonitorType &monitor)=0
	solve \(\partial_t u = L(u)\) where \(L\) is the internal operator.
virtual void	description (std::ostream &) const =0
	print description of ODE solver to out stream
virtual int	stages () const
	return stages of RK solver (-1 if not implemented)
virtual int	order () const
	return order of RK solver (-1 if not implemented)

Protected Member Functions
	OdeSolverInterface ()
	constructor

Detailed Description

template<class DestinationImp>
class DuneODE::OdeSolverInterface< DestinationImp >

Interface class for ODE Solver.

Member Typedef Documentation

DestinationType

template<class DestinationImp >

typedef DestinationImp DuneODE::OdeSolverInterface< DestinationImp >::DestinationType

type of destination

MonitorType

template<class DestinationImp >

typedef Monitor DuneODE::OdeSolverInterface< DestinationImp >::MonitorType

monitor type

Constructor & Destructor Documentation

OdeSolverInterface()

template<class DestinationImp >

DuneODE::OdeSolverInterface< DestinationImp >::OdeSolverInterface ( )

inlineprotected

constructor

~OdeSolverInterface()

template<class DestinationImp >

virtual DuneODE::OdeSolverInterface< DestinationImp >::~OdeSolverInterface ( )

inlinevirtual

destructor

Member Function Documentation

description()

template<class DestinationImp >

virtual void DuneODE::OdeSolverInterface< DestinationImp >::description ( std::ostream &  ) const

pure virtual

print description of ODE solver to out stream

Implemented in DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >, DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl, SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >, DuneODE::BasicImplicitRungeKuttaSolver< ParDGHelmholtz< Destination >, ParDGNewtonInverse< Destination >, ImplicitRungeKuttaTimeStepControl >, DuneODE::BasicImplicitRungeKuttaSolver< ParDGHelmholtz< Destination >, ParDGNewtonInverse< Destination >, ImplicitRungeKuttaTimeStepControl, SemiImplicitRungeKuttaSourceTerm< SpaceOperatorInterface< Destination > > >, DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >, DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, and DuneODE::ExplicitRungeKuttaSolver< DestinationImp >.

initialize()

template<class DestinationImp >

virtual void DuneODE::OdeSolverInterface< DestinationImp >::initialize ( const DestinationType &  arg )

pure virtual

initialize solver

Parameters

[in]

arg

argument to apply internal operator once for intial time step estimate

Implemented in DuneODE::ExplicitMultiStepSolver< DestinationImp >, and DuneODE::ExplicitRungeKuttaSolver< DestinationImp >.

order()

template<class DestinationImp >

virtual int DuneODE::OdeSolverInterface< DestinationImp >::order ( ) const

inlinevirtual

return order of RK solver (-1 if not implemented)

Reimplemented in DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >, DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl, SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >, DuneODE::BasicImplicitRungeKuttaSolver< ParDGHelmholtz< Destination >, ParDGNewtonInverse< Destination >, ImplicitRungeKuttaTimeStepControl >, DuneODE::BasicImplicitRungeKuttaSolver< ParDGHelmholtz< Destination >, ParDGNewtonInverse< Destination >, ImplicitRungeKuttaTimeStepControl, SemiImplicitRungeKuttaSourceTerm< SpaceOperatorInterface< Destination > > >, DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >, DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, and DuneODE::ExplicitRungeKuttaSolver< DestinationImp >.

solve() [1/2]

template<class DestinationImp >

virtual void DuneODE::OdeSolverInterface< DestinationImp >::solve ( DestinationType &  u )

inlinevirtual

solve \(\partial_t u = L(u)\) where \(L\) is the internal operator.

Parameters

[in]

u

unknown to solve for

Reimplemented in DuneODE::ExplicitMultiStepSolver< DestinationImp >.

solve() [2/2]

template<class DestinationImp >

virtual void DuneODE::OdeSolverInterface< DestinationImp >::solve ( DestinationType &  u, MonitorType &  monitor  )

pure virtual

solve \(\partial_t u = L(u)\) where \(L\) is the internal operator.

Parameters

[in]	u	unknown to solve for
[in]	monitor	Monitor to get some inside information

Implemented in DuneODE::ExplicitRungeKuttaSolver< DestinationImp >.

stages()

template<class DestinationImp >

virtual int DuneODE::OdeSolverInterface< DestinationImp >::stages ( ) const

inlinevirtual

return stages of RK solver (-1 if not implemented)

Reimplemented in DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >, DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl, SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >, DuneODE::BasicImplicitRungeKuttaSolver< ParDGHelmholtz< Destination >, ParDGNewtonInverse< Destination >, ImplicitRungeKuttaTimeStepControl >, DuneODE::BasicImplicitRungeKuttaSolver< ParDGHelmholtz< Destination >, ParDGNewtonInverse< Destination >, ImplicitRungeKuttaTimeStepControl, SemiImplicitRungeKuttaSourceTerm< SpaceOperatorInterface< Destination > > >, DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >, DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, and DuneODE::ExplicitRungeKuttaSolver< DestinationImp >.

---

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

• odesolverinterface.hh