dune-fem 2.12-git
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl > Class Template Referenceabstract

Implicit RungeKutta ODE solver. More...

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

Inheritance diagram for DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >:
Inheritance graph

Public Types

typedef HelmholtzOperator HelmholtzOperatorType
 
typedef BaseType::TimeStepControlType TimeStepControlType
 
typedef TimeStepControlType::TimeProviderType TimeProviderType
 
typedef BaseType::ParameterType ParameterType
 
typedef BaseType::NonlinearSolverParameterType NonlinearSolverParameterType
 
typedef BaseType::MonitorType MonitorType
 
typedef BaseType::DestinationType DestinationType
 
typedef NonlinearSolver NonlinearSolverType
 
typedef SourceTerm SourceTermType
 

Public Member Functions

 ImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const SimpleButcherTable< double > &butcherTable, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
 constructor
 
 ImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, int order, const ParameterType &tscParam, const NonlinearSolverParameterType &nlsParam)
 constructor
 
 ImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, int order, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
 constructor
 
 ImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const ParameterType &tscParam, const NonlinearSolverParameterType &nlsParam)
 constructor
 
 ImplicitRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
 constructor
 
template<class ButcherTable >
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 > defaultButcherTables (const int solverId)
 

Protected Attributes

HelmholtzOperatorType & helmholtzOp_
 
NonlinearSolverType nonlinearSolver_
 
TimeStepControl timeStepControl_
 
SourceTerm 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_
 

Detailed Description

template<class HelmholtzOperator, class NonlinearSolver, class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
class DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >

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
inherited

◆ HelmholtzOperatorType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
typedef HelmholtzOperator DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::HelmholtzOperatorType

◆ MonitorType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
typedef BaseType::MonitorType DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::MonitorType
inherited

◆ NonlinearSolverParameterType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
typedef BaseType::NonlinearSolverParameterType DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::NonlinearSolverParameterType

◆ NonlinearSolverType

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

◆ ParameterType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
typedef BaseType::ParameterType DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ParameterType

◆ SourceTermType

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

◆ TimeProviderType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
typedef TimeStepControlType::TimeProviderType DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::TimeProviderType

◆ TimeStepControlType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
typedef BaseType::TimeStepControlType DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::TimeStepControlType

Constructor & Destructor Documentation

◆ ImplicitRungeKuttaSolver() [1/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ImplicitRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const SimpleButcherTable< double > &  butcherTable,
const Dune::Fem::ParameterReader &  parameter = Dune::Fem::Parameter::container() 
)
inline

constructor

Parameters
[in]helmholtzOpHelmholtz operator \(L\)
[in]timeProvidertime provider
[in]butcherTableButcher table defining the scheme
[in]parameterParameterReader for reading parameters

◆ ImplicitRungeKuttaSolver() [2/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ImplicitRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
int  order,
const ParameterType &  tscParam,
const NonlinearSolverParameterType &  nlsParam 
)
inline

constructor

Parameters
[in]helmholtzOpHelmholtz operator \(L\)
[in]timeProvidertime provider
[in]orderorder of butcher table to use
[in]tscParamparameters for implicit time step control
[in]nlsParamparameters for non linear solver control

◆ ImplicitRungeKuttaSolver() [3/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ImplicitRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
int  order,
const Dune::Fem::ParameterReader &  parameter = Dune::Fem::Parameter::container() 
)
inline

constructor

Parameters
[in]helmholtzOpHelmholtz operator \(L\)
[in]timeProvidertime provider
[in]orderorder of butcher table to use
[in]tscParamparameters for implicit time step control
[in]nlsParamparameters for non linear solver control

◆ ImplicitRungeKuttaSolver() [4/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ImplicitRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const ParameterType &  tscParam,
const NonlinearSolverParameterType &  nlsParam 
)
inline

constructor

Parameters
[in]helmholtzOpHelmholtz operator \(L\)
[in]timeProvidertime provider
[in]tscParamparameters for implicit time step control
[in]nlsParamparameters for non linear solver control

◆ ImplicitRungeKuttaSolver() [5/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ImplicitRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const Dune::Fem::ParameterReader &  parameter = Dune::Fem::Parameter::container() 
)
inline

constructor

Parameters
[in]helmholtzOpHelmholtz operator \(L\)
[in]timeProvidertime provider
[in]parameterParameterReader for reading parameters

Member Function Documentation

◆ defaultButcherTables()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
static SimpleButcherTable< double > DuneODE::ImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::defaultButcherTables ( const int  solverId)
inlinestaticprotected

◆ description()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::description ( std::ostream &  ) const
inlinevirtualinherited

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
inlineprotectedinherited

◆ initialize() [1/2]

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

initialize solver

Parameters
[in]argargument to apply internal operator once for intial time step estimate

◆ initialize() [2/2]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
void DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::initialize ( const DestinationType &  U0)
inlineinherited

apply operator once to get dt estimate

◆ order()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
int DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::order ( ) const
inlinevirtualinherited

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

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

◆ 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)
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]uunknown to solve for

◆ solve() [2/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
virtual void DuneODE::OdeSolverInterface< DestinationImp >::solve ( DestinationType &  u)
inlineinherited

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

Parameters
[in]uunknown 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 
)
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]uunknown to solve for
[in]monitorMonitor to get some inside information

◆ solve() [5/5]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
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]uunknown to solve for
[in]monitorMonitor 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
inlinevirtualinherited

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

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

Member Data Documentation

◆ alpha_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
Dune::DynamicMatrix< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::alpha_
protectedinherited

◆ beta_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::beta_
protectedinherited

◆ c_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::c_
protectedinherited

◆ delta_

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

◆ gamma_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
Dune::DynamicVector< double > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::gamma_
protectedinherited

◆ helmholtzOp_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
HelmholtzOperatorType& DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::helmholtzOp_
protectedinherited

◆ nonlinearSolver_

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

◆ ord_

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

◆ rhs_

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

◆ sourceTerm_

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

◆ stages_

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

◆ timeStepControl_

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

◆ update_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
std::vector< DestinationType* > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::update_
protectedinherited

◆ updateStorage_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoImplicitRungeKuttaSourceTerm>
std::vector< std::unique_ptr< DestinationType > > DuneODE::BasicImplicitRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::updateStorage_
protectedinherited
The documentation for this class was generated from the following file:
Legal Statements / Impressum   |  Hosted by TU Dresden & Uni Heidelberg  |  Generated by   doxygen 1.9.8