DuneODE::ImplicitRungeKuttaSolverParameters Struct Reference

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

Inheritance diagram for DuneODE::ImplicitRungeKuttaSolverParameters:

Public Types
enum	{ noVerbosity = 0 , noConvergenceVerbosity = 1 , cflVerbosity = 2 , fullVerbosity = 3 }

Public Member Functions
	ImplicitRungeKuttaSolverParameters (const std::string keyPrefix, const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
	ImplicitRungeKuttaSolverParameters (const Dune::Fem::ParameterReader &parameter=Dune::Fem::Parameter::container())
virtual	~ImplicitRungeKuttaSolverParameters ()
const Dune::Fem::ParameterReader &	parameter () const
virtual double	tolerance () const
	tolerance for the non-linear solver (should be larger than the tolerance for the linear solver
virtual int	iterations () const
virtual int	verbose () const
	verbosity level ( none, noconv, cfl, full )
virtual double	cflStart () const
virtual double	cflMax () const
double	initialDeltaT (double dt) const
virtual bool	cflFactor (const double imOpTimeStepEstimate, const double exOpTimeStepEstimate, const int numberOfLinearIterations, bool converged, double &factor) const
	return multiplication factor for the current cfl number
virtual void	initTimeStepEstimate (const double dtEstExpl, const double dtEstImpl, double &dtEst, double &cfl) const
virtual int	maxLinearIterations () const
virtual int	selectedSolver (const int order) const
	return number of selected solver (default = order of solver)
virtual ImplicitRungeKuttaSolverParameters *	clone () const

Protected Member Functions
const ImplicitRungeKuttaSolverParameters &	asImp () const

Protected Attributes
const std::string	keyPrefix_
const int	minIter_
const int	maxIter_
const double	sigma_
Dune::Fem::ParameterReader	parameter_

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
noVerbosity
noConvergenceVerbosity
cflVerbosity
fullVerbosity

Constructor & Destructor Documentation

ImplicitRungeKuttaSolverParameters() [1/2]

DuneODE::ImplicitRungeKuttaSolverParameters::ImplicitRungeKuttaSolverParameters ( const std::string  keyPrefix, const Dune::Fem::ParameterReader &  parameter = Dune::Fem::Parameter::container()  )

inline

ImplicitRungeKuttaSolverParameters() [2/2]

DuneODE::ImplicitRungeKuttaSolverParameters::ImplicitRungeKuttaSolverParameters ( const Dune::Fem::ParameterReader &  parameter = Dune::Fem::Parameter::container() )

inline

~ImplicitRungeKuttaSolverParameters()

virtual DuneODE::ImplicitRungeKuttaSolverParameters::~ImplicitRungeKuttaSolverParameters ( )

inlinevirtual

Member Function Documentation

asImp()

const ImplicitRungeKuttaSolverParameters & Dune::Fem::LocalParameter< ImplicitRungeKuttaSolverParameters , ImplicitRungeKuttaSolverParameters >::asImp ( ) const

inlineprotectedinherited

cflFactor()

virtual bool DuneODE::ImplicitRungeKuttaSolverParameters::cflFactor ( const double  imOpTimeStepEstimate, const double  exOpTimeStepEstimate, const int  numberOfLinearIterations, bool  converged, double &  factor  ) const

inlinevirtual

return multiplication factor for the current cfl number

Parameters

[in]	imOpTimeStepEstimate	Time step estimate of the first ode solver
[in]	exOpTimeStepEstimate	Time step estimate of the second ode solver
[in]	solver	Iterative linear solver (ILS)
[in]	converged	Convergence of the ILS
[out]	factor	Multiplication factor for the current cfl number

Note

Do not increase the cfl number of the implicit solver if its time step estimate is already larger than the one of the explicit solver

cflMax()

virtual double DuneODE::ImplicitRungeKuttaSolverParameters::cflMax ( ) const

inlinevirtual

cflStart()

virtual double DuneODE::ImplicitRungeKuttaSolverParameters::cflStart ( ) const

inlinevirtual

clone()

virtual ImplicitRungeKuttaSolverParameters * Dune::Fem::LocalParameter< ImplicitRungeKuttaSolverParameters , ImplicitRungeKuttaSolverParameters >::clone ( ) const

inlinevirtualinherited

initialDeltaT()

double DuneODE::ImplicitRungeKuttaSolverParameters::initialDeltaT ( double  dt ) const

inline

initTimeStepEstimate()

virtual void DuneODE::ImplicitRungeKuttaSolverParameters::initTimeStepEstimate ( const double  dtEstExpl, const double  dtEstImpl, double &  dtEst, double &  cfl  ) const

inlinevirtual

iterations()

virtual int DuneODE::ImplicitRungeKuttaSolverParameters::iterations ( ) const

inlinevirtual

maxLinearIterations()

virtual int DuneODE::ImplicitRungeKuttaSolverParameters::maxLinearIterations ( ) const

inlinevirtual

parameter()

const Dune::Fem::ParameterReader & DuneODE::ImplicitRungeKuttaSolverParameters::parameter ( ) const

inline

selectedSolver()

virtual int DuneODE::ImplicitRungeKuttaSolverParameters::selectedSolver ( const int  order ) const

inlinevirtual

return number of selected solver (default = order of solver)

tolerance()

virtual double DuneODE::ImplicitRungeKuttaSolverParameters::tolerance ( ) const

inlinevirtual

tolerance for the non-linear solver (should be larger than the tolerance for the linear solver

verbose()

virtual int DuneODE::ImplicitRungeKuttaSolverParameters::verbose ( ) const

inlinevirtual

verbosity level ( none, noconv, cfl, full )

Member Data Documentation

keyPrefix_

const std::string DuneODE::ImplicitRungeKuttaSolverParameters::keyPrefix_

protected

maxIter_

const int DuneODE::ImplicitRungeKuttaSolverParameters::maxIter_

protected

minIter_

const int DuneODE::ImplicitRungeKuttaSolverParameters::minIter_

protected

parameter_

Dune::Fem::ParameterReader DuneODE::ImplicitRungeKuttaSolverParameters::parameter_

protected

sigma_

const double DuneODE::ImplicitRungeKuttaSolverParameters::sigma_

protected

---

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

• timestepcontrol.hh