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

ROW RungeKutta ODE solver. More...

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

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

Public Types

typedef BaseType::MonitorType MonitorType
 
typedef BaseType::DestinationType DestinationType
 
typedef HelmholtzOperator HelmholtzOperatorType
 
typedef NonlinearSolver NonlinearSolverType
 
typedef TimeStepControl TimeStepControlType
 
typedef SourceTerm SourceTermType
 
typedef NonlinearSolver::ParameterType NonlinearSolverParameterType
 
typedef NonlinearSolverType::LinearInverseOperatorType LinearInverseOperatorType
 
typedef HelmholtzOperator::SpaceOperatorType::PreconditionOperatorType PreconditionOperatorType
 
typedef Dune::Fem::TimeProviderBase TimeProviderType
 

Public Member Functions

template<class ButcherTable >
 BasicROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const ButcherTable &butcherTable, const TimeStepControlType &timeStepControl, const SourceTermType &sourceTerm, const NonlinearSolverParameterType &parameter)
 constructor
 
template<class ButcherTable >
 BasicROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const ButcherTable &butcherTable, const TimeStepControlType &timeStepControl, const SourceTermType &sourceTerm, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
 
template<class ButcherTable >
 BasicROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const ButcherTable &butcherTable, const TimeStepControlType &timeStepControl, const NonlinearSolverParameterType &parameter)
 constructor
 
template<class ButcherTable >
 BasicROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const ButcherTable &butcherTable, const TimeStepControlType &timeStepControl, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
 
template<class ButcherTable >
 BasicROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const ButcherTable &butcherTable, const NonlinearSolverParameterType &parameter)
 constructor
 
template<class ButcherTable >
 BasicROWRungeKuttaSolver (HelmholtzOperatorType &helmholtzOp, TimeProviderType &timeProvider, const ButcherTable &butcherTable, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
 
template<class ButcherTable >
void setup (const ButcherTable &butcherTable)
 
 ~BasicROWRungeKuttaSolver ()
 destructor
 
void initialize (const DestinationType &U0)
 apply operator once to get dt estimate
 
void solve (DestinationType &U, MonitorType &monitor)
 solve the system
 
int stages () const
 
void description (std::ostream &out) const
 print description of ODE solver to out stream
 
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 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.
 

Protected Member Functions

double infNorm (const DestinationType &U, const DestinationType &Uerr) const
 

Protected Attributes

HelmholtzOperatorType & helmholtzOp_
 
LinearInverseOperatorType linearSolver_
 
TimeStepControl timeStepControl_
 
SourceTerm sourceTerm_
 
int stages_
 
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, class SourceTerm = NoROWRungeKuttaSourceTerm>
class DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >

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

◆ HelmholtzOperatorType

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

◆ LinearInverseOperatorType

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

◆ MonitorType

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

◆ NonlinearSolverParameterType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
typedef NonlinearSolver::ParameterType DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::NonlinearSolverParameterType

◆ NonlinearSolverType

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

◆ PreconditionOperatorType

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

◆ SourceTermType

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

◆ TimeProviderType

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
typedef Dune::Fem::TimeProviderBase DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::TimeProviderType

◆ TimeStepControlType

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

Constructor & Destructor Documentation

◆ BasicROWRungeKuttaSolver() [1/6]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
template<class ButcherTable >
DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicROWRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const ButcherTable &  butcherTable,
const TimeStepControlType &  timeStepControl,
const SourceTermType &  sourceTerm,
const NonlinearSolverParameterType &  parameter 
)
inline

constructor

Parameters
[in]helmholtzOpHelmholtz operator $L$
[in]butcherTablebutcher table to use
[in]timeStepControltime step controller
[in]sourceTermadditional source term

◆ BasicROWRungeKuttaSolver() [2/6]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
template<class ButcherTable >
DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicROWRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const ButcherTable &  butcherTable,
const TimeStepControlType &  timeStepControl,
const SourceTermType &  sourceTerm,
const Dune::Fem::ParameterReader &  parameter = Dune::Fem::Parameter::container() 
)
inline

◆ BasicROWRungeKuttaSolver() [3/6]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
template<class ButcherTable >
DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicROWRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const ButcherTable &  butcherTable,
const TimeStepControlType &  timeStepControl,
const NonlinearSolverParameterType &  parameter 
)
inline

constructor

Parameters
[in]helmholtzOpHelmholtz operator $L$
[in]butcherTablebutcher table to use
[in]timeStepControltime step controller

◆ BasicROWRungeKuttaSolver() [4/6]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
template<class ButcherTable >
DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicROWRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const ButcherTable &  butcherTable,
const TimeStepControlType &  timeStepControl,
const Dune::Fem::ParameterReader &  parameter = Dune::Fem::Parameter::container() 
)
inline

◆ BasicROWRungeKuttaSolver() [5/6]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
template<class ButcherTable >
DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicROWRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const ButcherTable &  butcherTable,
const NonlinearSolverParameterType &  parameter 
)
inline

constructor

Parameters
[in]helmholtzOpHelmholtz operator $L$
[in]butcherTablebutcher table to use

◆ BasicROWRungeKuttaSolver() [6/6]

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
template<class ButcherTable >
DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::BasicROWRungeKuttaSolver ( HelmholtzOperatorType &  helmholtzOp,
TimeProviderType &  timeProvider,
const ButcherTable &  butcherTable,
const Dune::Fem::ParameterReader &  parameter = Dune::Fem::Parameter::container() 
)
inline

◆ ~BasicROWRungeKuttaSolver()

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::~BasicROWRungeKuttaSolver ( )
inline

destructor

Member Function Documentation

◆ description()

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

apply operator once to get dt estimate

◆ 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)
inline

◆ 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)
inline

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 
)
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 $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 
)

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
inline

Member Data Documentation

◆ alpha2_

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

◆ alpha_

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

◆ beta_

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

◆ c_

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

◆ delta_

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

◆ gamma_

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

◆ helmholtzOp_

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

◆ linearSolver_

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

◆ maxLinearIterations_

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

◆ preconditioner_

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

◆ rhs_

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

◆ sourceTerm_

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

◆ stages_

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

◆ temp_

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

◆ timeStepControl_

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

◆ update_

template<class HelmholtzOperator , class NonlinearSolver , class TimeStepControl , class SourceTerm = NoROWRungeKuttaSourceTerm>
std::vector< DestinationType * > DuneODE::BasicROWRungeKuttaSolver< HelmholtzOperator, NonlinearSolver, TimeStepControl, SourceTerm >::update_
protected
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.6