Implicit RungeKutta ODE solver. More...

#include <dune/fem/solver/rungekutta/basicimplicit.hh>

Inheritance diagram for DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >:

Public Types
typedef BaseType::MonitorType	MonitorType

typedef BaseType::DestinationType	DestinationType

typedef HelmholtzOperator	HelmholtzOperatorType

typedef NonlinearSolver	NonlinearSolverType

typedef TimeStepControl	TimeStepControlType

typedef SourceTerm	SourceTermType

typedef Dune::Fem::TimeProviderBase	TimeProviderType

typedef TimeStepControlType::ParameterType	ParameterType

typedef NonlinearSolver::ParameterType	NonlinearSolverParameterType

Public Member Functions
template<class ButcherTable >
	BasicImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, const ButcherTable &butcherTable, const TimeStepControlType &timeStepControl, const SourceTermType &sourceTerm, const NonlinearSolverParameterType &parameters)
	constructor More...

template<class ButcherTable >
	BasicImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, const ButcherTable &butcherTable, const TimeStepControlType &timeStepControl, const NonlinearSolverParameterType &parameters)
	constructor More...

template<class ButcherTable >
	BasicImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, const ButcherTable &butcherTable, const TimeStepControlType &timeStepControl, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())

template<class ButcherTable >
	BasicImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, const ButcherTable &butcherTable, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())

template<class ButcherTable >
void	setup (const ButcherTable &butcherTable)

void	initialize (const DestinationType &U0)
	apply operator once to get dt estimate More...

void	solve (DestinationType &U, MonitorType &monitor)
	solve the system More...

int	stages () const

void	description (std::ostream &out) const
	print description of ODE solver to out stream More...

virtual void	solve (DestinationType &u)
	solve $\partial_t u = L(u)$ where is the internal operator. More...

virtual void	solve (DestinationType &u, MonitorType &monitor)=0
	solve $\partial_t u = L(u)$ where is the internal operator. More...

virtual void	initialize (const DestinationType &arg)=0
	initialize solver More...

virtual void	solve (DestinationType &u)
	solve $\partial_t u = L(u)$ where is the internal operator. More...

virtual void	solve (DestinationType &u, MonitorType &monitor)=0
	solve $\partial_t u = L(u)$ where is the internal operator. More...

Protected Member Functions
double	infNorm (const DestinationType &U, const DestinationType &Uerr) const

Protected Attributes
HelmholtzOperatorType &	helmholtzOp_

NonlinearSolverType	nonlinearSolver_

TimeStepControl	timeStepControl_

SourceTerm	sourceTerm_

int	stages_

double	delta_

Dune::DynamicMatrix< double >	alpha_

Dune::DynamicVector< double >	gamma_

Dune::DynamicVector< double >	beta_

Dune::DynamicVector< double >	c_

DestinationType	rhs_

std::vector< std::unique_ptr< DestinationType > >	updateStorage_

std::vector< DestinationType * >	update_

Detailed Description

template<class HelmholtzOperator, class NonlinearSolver, class TimeStepControl, class SourceTerm = NoImplicitRungeKuttaSourceTerm>
class DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >

Implicit RungeKutta ODE solver.

Member Typedef Documentation

◆ DestinationType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef BaseType::DestinationType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::DestinationType

◆ HelmholtzOperatorType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef HelmholtzOperator DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::HelmholtzOperatorType

◆ MonitorType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef BaseType::MonitorType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::MonitorType

◆ NonlinearSolverParameterType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef NonlinearSolver::ParameterType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::NonlinearSolverParameterType

◆ NonlinearSolverType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef NonlinearSolver DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::NonlinearSolverType

◆ ParameterType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef TimeStepControlType::ParameterType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::ParameterType

◆ SourceTermType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef SourceTerm DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::SourceTermType

◆ TimeProviderType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef Dune::Fem::TimeProviderBase DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::TimeProviderType

◆ TimeStepControlType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

typedef TimeStepControl DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::TimeStepControlType

Constructor & Destructor Documentation

◆ BasicImplicitRungeKuttaSolver() [1/4]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

template<class ButcherTable >

DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicImplicitRungeKuttaSolver	(	HelmholtzOperatorType &	helmholtzOp,
		const ButcherTable &	butcherTable,
		const TimeStepControlType &	timeStepControl,
		const SourceTermType &	sourceTerm,
		const NonlinearSolverParameterType &	parameters
	)

inline

constructor

Parameters

[in]	helmholtzOp	Helmholtz operator
[in]	butcherTable	butcher table to use
[in]	timeStepControl	time step controller
[in]	sourceTerm	additional source term

◆ BasicImplicitRungeKuttaSolver() [2/4]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

template<class ButcherTable >

DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicImplicitRungeKuttaSolver	(	HelmholtzOperatorType &	helmholtzOp,
		const ButcherTable &	butcherTable,
		const TimeStepControlType &	timeStepControl,
		const NonlinearSolverParameterType &	parameters
	)

inline

constructor

Parameters

[in]	helmholtzOp	Helmholtz operator
[in]	butcherTable	butcher table to use
[in]	timeStepControl	time step controller

◆ BasicImplicitRungeKuttaSolver() [3/4]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

template<class ButcherTable >

DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicImplicitRungeKuttaSolver	(	HelmholtzOperatorType &	helmholtzOp,
		const ButcherTable &	butcherTable,
		const TimeStepControlType &	timeStepControl,
		const Dune::Fem::ParameterReader &	parameter = `Dune::Fem::Parameter::container()`
	)

inline

◆ BasicImplicitRungeKuttaSolver() [4/4]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

template<class ButcherTable >

DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicImplicitRungeKuttaSolver	(	HelmholtzOperatorType &	helmholtzOp,
		const ButcherTable &	butcherTable,
		const Dune::Fem::ParameterReader &	parameter = `Dune::Fem::Parameter::container()`
	)

inline

Member Function Documentation

◆ description()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::description ( std::ostream & ) const

inlinevirtual

print description of ODE solver to out stream

Implements DuneODE::OdeSolverInterface< HelmholtzOperator::DomainFunctionType >.

◆ infNorm()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

double DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::infNorm	(	const DestinationType &	U,
		const DestinationType &	Uerr
	)		const

inlineprotected

◆ initialize() [1/2]

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

pure virtualinherited

initialize solver

Parameters

[in] arg argument to apply internal operator once for intial time step estimate

Implemented in DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, and DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl, SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >.

◆ initialize() [2/2]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::initialize ( const DestinationType & U0 )

inline

apply operator once to get dt estimate

◆ setup()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

template<class ButcherTable >

void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::setup ( const ButcherTable & butcherTable )

inline

◆ solve() [1/5]

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

inlinevirtualinherited

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

Parameters

[in] u unknown to solve for

◆ solve() [2/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

virtual void DuneODE::OdeSolverInterface< DestinationImp >::solve

inline

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

Parameters

[in] u unknown to solve for

◆ solve() [3/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::solve	(	DestinationType &	U,
		MonitorType &	monitor
	)

inline

solve the system

◆ solve() [4/5]

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

pure virtualinherited

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

Parameters

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

Implemented in DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl >, and DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl, SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >.

◆ solve() [5/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

virtual void DuneODE::OdeSolverInterface< DestinationImp >::solve

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

Parameters

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

◆ stages()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

int DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::stages ( ) const

inline

Member Data Documentation

◆ alpha_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

Dune::DynamicMatrix< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::alpha_

protected

◆ beta_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::beta_

protected

◆ c_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::c_

protected

◆ delta_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

double DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::delta_

protected

◆ gamma_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::gamma_

protected

◆ helmholtzOp_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

HelmholtzOperatorType& DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::helmholtzOp_

protected

◆ nonlinearSolver_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

NonlinearSolverType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::nonlinearSolver_

protected

◆ rhs_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

DestinationType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::rhs_

protected

◆ sourceTerm_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

SourceTerm DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::sourceTerm_

protected

◆ stages_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

int DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::stages_

protected

◆ timeStepControl_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

TimeStepControl DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::timeStepControl_

protected

◆ update_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

std::vector< DestinationType* > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::update_

protected

◆ updateStorage_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>

std::vector< std::unique_ptr< DestinationType > > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::updateStorage_

protected

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

basicimplicit.hh

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class HelmholtzOperator, class NonlinearSolver, class TimeStepControl, class SourceTerm = NoImplicitRungeKuttaSourceTerm> class DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >

Member Typedef Documentation

◆ DestinationType

◆ HelmholtzOperatorType

◆ MonitorType

◆ NonlinearSolverParameterType

◆ NonlinearSolverType

◆ ParameterType

◆ SourceTermType

◆ TimeProviderType

◆ TimeStepControlType

Constructor & Destructor Documentation

◆ BasicImplicitRungeKuttaSolver() [1/4]

◆ BasicImplicitRungeKuttaSolver() [2/4]

◆ BasicImplicitRungeKuttaSolver() [3/4]

◆ BasicImplicitRungeKuttaSolver() [4/4]

Member Function Documentation

◆ description()

◆ infNorm()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ setup()

◆ solve() [1/5]

◆ solve() [2/5]

◆ solve() [3/5]

◆ solve() [4/5]

◆ solve() [5/5]

◆ stages()

Member Data Documentation

◆ alpha_

◆ beta_

◆ c_

◆ delta_

◆ gamma_

◆ helmholtzOp_

◆ nonlinearSolver_

◆ rhs_

◆ sourceTerm_

◆ stages_

◆ timeStepControl_

◆ update_

◆ updateStorage_

template<class HelmholtzOperator, class NonlinearSolver, class TimeStepControl, class SourceTerm = NoImplicitRungeKuttaSourceTerm>
class DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >