Implicit RungeKutta ODE solver. More...

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

Inheritance diagram for DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >:

Public Member Functions
	SemiImplicitRungeKuttaSolver (ExplicitOperatorType &explicitOp, HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, int order, const ParameterType &tscParams, const NonlinearSolverParameterType &nlsParams)
	constructor

	SemiImplicitRungeKuttaSolver (ExplicitOperatorType &explicitOp, HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, int order, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())

	SemiImplicitRungeKuttaSolver (ExplicitOperatorType &explicitOp, HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const ParameterType &tscParams, const NonlinearSolverParameterType &nlsParams)
	constructor

	SemiImplicitRungeKuttaSolver (ExplicitOperatorType &explicitOp, HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())

	SemiImplicitRungeKuttaSolver (ExplicitOperatorType &explicitOp, HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const SimpleButcherTable< double > &explButcherTable, const SimpleButcherTable< double > &implButcherTable, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())

void	setup (const ButcherTable &butcherTable)

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

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

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

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	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.

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

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

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

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

Static Protected Member Functions
static SimpleButcherTable< double >	defaultButcherTable (int order, bool expl)

Detailed Description

template<class ExplicitOperator, class HelmholtzOperator, class NonlinearSolver>
class DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >

Implicit RungeKutta ODE solver.

Member Typedef Documentation

◆ DestinationType

typedef BaseType::DestinationType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::DestinationType

inherited

◆ ExplicitOperatorType

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

typedef ExplicitOperator DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::ExplicitOperatorType

◆ HelmholtzOperatorType

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

typedef HelmholtzOperator DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::HelmholtzOperatorType

◆ MonitorType

typedef BaseType::MonitorType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::MonitorType

inherited

◆ NonlinearSolverParameterType

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

typedef BaseType::NonlinearSolverParameterType DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::NonlinearSolverParameterType

◆ NonlinearSolverType

typedef NonlinearSolver DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::NonlinearSolverType

inherited

◆ ParameterType

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

typedef BaseType::ParameterType DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::ParameterType

◆ SourceTermType

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

typedef BaseType::SourceTermType DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::SourceTermType

◆ TimeProviderType

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

typedef TimeStepControlType::TimeProviderType DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::TimeProviderType

◆ TimeStepControlType

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

typedef BaseType::TimeStepControlType DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::TimeStepControlType

Constructor & Destructor Documentation

◆ SemiImplicitRungeKuttaSolver() [1/5]

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::SemiImplicitRungeKuttaSolver	(	ExplicitOperatorType &	explicitOp,
		HelmholtzOperatorType &	helmholtzOp,
		TimeProviderType &	timeProvider,
		int	order,
		const ParameterType &	tscParams,
		const NonlinearSolverParameterType &	nlsParams
	)

inline

constructor

Parameters

[in]	explicitOp	explicit operator
[in]	helmholtzOp	Helmholtz operator \(L\)
[in]	timeProvider	time provider
[in]	order	order of butcher table to use
[in]	tscParam	parameters for implicit time step control
[in]	nlsParam	parameters for non linear solver control

◆ SemiImplicitRungeKuttaSolver() [2/5]

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::SemiImplicitRungeKuttaSolver	(	ExplicitOperatorType &	explicitOp,
		HelmholtzOperatorType &	helmholtzOp,
		TimeProviderType &	timeProvider,
		int	order,
		const Dune::Fem::ParameterReader &	parameter = `Dune::Fem::Parameter::container()`
	)

inline

◆ SemiImplicitRungeKuttaSolver() [3/5]

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::SemiImplicitRungeKuttaSolver	(	ExplicitOperatorType &	explicitOp,
		HelmholtzOperatorType &	helmholtzOp,
		TimeProviderType &	timeProvider,
		const ParameterType &	tscParams,
		const NonlinearSolverParameterType &	nlsParams
	)

inline

constructor

Parameters

[in]	explicitOp	explicit operator
[in]	helmholtzOp	Helmholtz operator \(L\)
[in]	timeProvider	time provider
[in]	tscParam	parameters for implicit time step control
[in]	nlsParam	parameters for non linear solver control

◆ SemiImplicitRungeKuttaSolver() [4/5]

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::SemiImplicitRungeKuttaSolver	(	ExplicitOperatorType &	explicitOp,
		HelmholtzOperatorType &	helmholtzOp,
		TimeProviderType &	timeProvider,
		const Dune::Fem::ParameterReader &	parameter = `Dune::Fem::Parameter::container()`
	)

inline

◆ SemiImplicitRungeKuttaSolver() [5/5]

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::SemiImplicitRungeKuttaSolver	(	ExplicitOperatorType &	explicitOp,
		HelmholtzOperatorType &	helmholtzOp,
		TimeProviderType &	timeProvider,
		const SimpleButcherTable< double > &	explButcherTable,
		const SimpleButcherTable< double > &	implButcherTable,
		const Dune::Fem::ParameterReader &	parameter = `Dune::Fem::Parameter::container()`
	)

inline

Member Function Documentation

◆ defaultButcherTable()

template<class ExplicitOperator , class HelmholtzOperator , class NonlinearSolver >

static SimpleButcherTable< double > DuneODE::SemiImplicitRungeKuttaSolver< ExplicitOperator, HelmholtzOperator, NonlinearSolver >::defaultButcherTable	(	int	order,
		bool	expl
	)

inlinestaticprotected

◆ description()

void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::description ( std::ostream & out ) const

inlinevirtualinherited

print description of ODE solver to out stream

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

◆ infNorm()

double DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::infNorm	(	const DestinationType &	U,
		const DestinationType &	Uerr
	)		const

inlineprotectedinherited

◆ 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

◆ initialize() [2/2]

void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::initialize ( const DestinationType & U0 )

inlineinherited

apply operator once to get dt estimate

◆ order()

int DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::order ( ) const

inlinevirtualinherited

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

Reimplemented from DuneODE::OdeSolverInterface< HelmholtzOperator::DomainFunctionType >.

◆ setup()

void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::setup ( const ButcherTable & butcherTable )

inlineinherited

◆ solve() [1/5]

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

inlinevirtualinherited

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

Parameters

[in] u unknown to solve for

◆ solve() [2/5]

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

inlineinherited

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

Parameters

[in] u unknown to solve for

◆ solve() [3/5]

void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::solve	(	DestinationType &	U,
		MonitorType &	monitor
	)

inlineinherited

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 \(L\) is the internal operator.

Parameters

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

◆ solve() [5/5]

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

inherited

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

◆ stages()

int DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::stages ( ) const

inlinevirtualinherited

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

Reimplemented from DuneODE::OdeSolverInterface< HelmholtzOperator::DomainFunctionType >.

Member Data Documentation

◆ alpha_

Dune::DynamicMatrix< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::alpha_

protectedinherited

◆ beta_

Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::beta_

protectedinherited

◆ c_

Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::c_

protectedinherited

◆ delta_

double DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::delta_

protectedinherited

◆ gamma_

Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::gamma_

protectedinherited

◆ helmholtzOp_

HelmholtzOperatorType& DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::helmholtzOp_

protectedinherited

◆ nonlinearSolver_

NonlinearSolverType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::nonlinearSolver_

protectedinherited

◆ ord_

int DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::ord_

protectedinherited

◆ rhs_

DestinationType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::rhs_

protectedinherited

◆ sourceTerm_

SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::sourceTerm_

protectedinherited

◆ stages_

int DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::stages_

protectedinherited

◆ timeStepControl_

ImplicitRungeKuttaTimeStepControl DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::timeStepControl_

protectedinherited

◆ update_

std::vector< DestinationType* > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::update_

protectedinherited

◆ updateStorage_

std::vector< std::unique_ptr< DestinationType > > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, ImplicitRungeKuttaTimeStepControl , SemiImplicitRungeKuttaSourceTerm< ExplicitOperator > >::updateStorage_

protectedinherited

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

semiimplicit.hh

Public Types
typedef ExplicitOperator	ExplicitOperatorType

typedef HelmholtzOperator	HelmholtzOperatorType

typedef BaseType::TimeStepControlType	TimeStepControlType

typedef BaseType::SourceTermType	SourceTermType

typedef TimeStepControlType::TimeProviderType	TimeProviderType

typedef BaseType::ParameterType	ParameterType

typedef BaseType::NonlinearSolverParameterType	NonlinearSolverParameterType

typedef BaseType::MonitorType	MonitorType

typedef BaseType::DestinationType	DestinationType

typedef NonlinearSolver	NonlinearSolverType

Protected Attributes
HelmholtzOperatorType &	helmholtzOp_

NonlinearSolverType	nonlinearSolver_

ImplicitRungeKuttaTimeStepControl	timeStepControl_

SemiImplicitRungeKuttaSourceTerm< ExplicitOperator >	sourceTerm_

int	stages_

int	ord_

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_

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DestinationType

◆ ExplicitOperatorType

◆ HelmholtzOperatorType

◆ MonitorType

◆ NonlinearSolverParameterType

◆ NonlinearSolverType

◆ ParameterType

◆ SourceTermType

◆ TimeProviderType

◆ TimeStepControlType

Constructor & Destructor Documentation

◆ SemiImplicitRungeKuttaSolver() [1/5]

◆ SemiImplicitRungeKuttaSolver() [2/5]

◆ SemiImplicitRungeKuttaSolver() [3/5]

◆ SemiImplicitRungeKuttaSolver() [4/5]

◆ SemiImplicitRungeKuttaSolver() [5/5]

Member Function Documentation

◆ defaultButcherTable()

◆ description()

◆ infNorm()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ order()

◆ 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_

◆ ord_

◆ rhs_

◆ sourceTerm_

◆ stages_

◆ timeStepControl_

◆ update_

◆ updateStorage_