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::ROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl > Class Template Referenceabstract

ROW RungeKutta ODE solver. More...

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

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

Public Types

typedef HelmholtzOperator HelmholtzOperatorType
 
typedef BaseType::TimeStepControlType TimeStepControlType
 
typedef TimeStepControlType::TimeProviderType TimeProviderType
 
typedef TimeStepControlType::ParameterType TimeStepControlParameterType
 
typedef BaseType::NonlinearSolverParameterType NonlinearSolverParameterType
 
typedef NonlinearSolverParameterType ParameterType
 
typedef BaseType::MonitorType MonitorType
 
typedef BaseType::DestinationType DestinationType
 
typedef NonlinearSolver NonlinearSolverType
 
typedef SourceTerm SourceTermType
 
typedef NonlinearSolverType::LinearInverseOperatorType LinearInverseOperatorType
 
typedef HelmholtzOperator::SpaceOperatorType::PreconditionOperatorType PreconditionOperatorType
 

Public Member Functions

 ROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, int order, const TimeStepControlParameterType &tscParam, const NonlinearSolverParameterType &parameter)
 constructor
 
 ROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, int order, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
 
 ROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const TimeStepControlParameterType &tscParam, const NonlinearSolverParameterType &parameter)
 constructor
 
 ROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, 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
 
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 ROWSimpleButcherTable< double > butcherTable (int order)
 

Protected Attributes

HelmholtzOperatorType & helmholtzOp_
 
LinearInverseOperatorType linearSolver_
 
TimeStepControl timeStepControl_
 
SourceTerm sourceTerm_
 
int stages_
 
int ord_
 
double delta_
 
Dune::DynamicMatrix< double > alpha_
 
Dune::DynamicMatrix< double > alpha2_
 
Dune::DynamicVector< double > gamma_
 
Dune::DynamicVector< double > beta_
 
Dune::DynamicVector< double > c_
 
DestinationType rhs_
 
DestinationType temp_
 
std::vector< DestinationType * > update_
 
const int maxLinearIterations_
 
const PreconditionOperatorType * preconditioner_
 

Detailed Description

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

ROW RungeKutta ODE solver.

Member Typedef Documentation

◆ DestinationType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
typedef BaseType::DestinationType DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::DestinationType
inherited

◆ HelmholtzOperatorType

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

◆ LinearInverseOperatorType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
typedef NonlinearSolverType::LinearInverseOperatorType DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::LinearInverseOperatorType
inherited

◆ MonitorType

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

◆ NonlinearSolverParameterType

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

◆ NonlinearSolverType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
typedef NonlinearSolver DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::NonlinearSolverType
inherited

◆ ParameterType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
typedef NonlinearSolverParameterType DuneODE::ROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ParameterType

◆ PreconditionOperatorType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
typedef HelmholtzOperator::SpaceOperatorType::PreconditionOperatorType DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::PreconditionOperatorType
inherited

◆ SourceTermType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
typedef SourceTerm DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::SourceTermType
inherited

◆ TimeProviderType

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

◆ TimeStepControlParameterType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
typedef TimeStepControlType::ParameterType DuneODE::ROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::TimeStepControlParameterType

◆ TimeStepControlType

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

Constructor & Destructor Documentation

◆ ROWRungeKuttaSolver() [1/4]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
DuneODE::ROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ROWRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
int  order,
const TimeStepControlParameterType &  tscParam,
const NonlinearSolverParameterType &  parameter 
)
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

◆ ROWRungeKuttaSolver() [2/4]

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

◆ ROWRungeKuttaSolver() [3/4]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
DuneODE::ROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::ROWRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const TimeStepControlParameterType &  tscParam,
const NonlinearSolverParameterType &  parameter 
)
inline

constructor

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

◆ ROWRungeKuttaSolver() [4/4]

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

Member Function Documentation

◆ butcherTable()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl = ImplicitRungeKuttaTimeStepControl>
static ROWSimpleButcherTable< double > DuneODE::ROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl >::butcherTable ( int  order)
inlinestaticprotected

◆ description()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
void DuneODE::BasicROWRungeKuttaSolver< 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 = NoROWRungeKuttaSourceTerm>
double DuneODE::BasicROWRungeKuttaSolver< 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 = NoROWRungeKuttaSourceTerm>
void DuneODE::BasicROWRungeKuttaSolver< 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 = NoROWRungeKuttaSourceTerm>
int DuneODE::BasicROWRungeKuttaSolver< 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 = NoROWRungeKuttaSourceTerm>
template<class ButcherTable >
void DuneODE::BasicROWRungeKuttaSolver< 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 = NoROWRungeKuttaSourceTerm>
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 = NoROWRungeKuttaSourceTerm>
void DuneODE::BasicROWRungeKuttaSolver< 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 = NoROWRungeKuttaSourceTerm>
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 = NoROWRungeKuttaSourceTerm>
int DuneODE::BasicROWRungeKuttaSolver< 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

◆ alpha2_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
Dune::DynamicMatrix< double > DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::alpha2_
protectedinherited

◆ alpha_

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

◆ beta_

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

◆ c_

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

◆ delta_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
double DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::delta_
protectedinherited

◆ gamma_

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

◆ helmholtzOp_

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

◆ linearSolver_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
LinearInverseOperatorType DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::linearSolver_
protectedinherited

◆ maxLinearIterations_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
const int DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::maxLinearIterations_
protectedinherited

◆ ord_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
int DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::ord_
protectedinherited

◆ preconditioner_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
const PreconditionOperatorType* DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::preconditioner_
protectedinherited

◆ rhs_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
DestinationType DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::rhs_
protectedinherited

◆ sourceTerm_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
SourceTerm DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::sourceTerm_
protectedinherited

◆ stages_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
int DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::stages_
protectedinherited

◆ temp_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
DestinationType DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::temp_
protectedinherited

◆ timeStepControl_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
TimeStepControl DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::timeStepControl_
protectedinherited

◆ update_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
std::vector< DestinationType * > DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::update_
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