Dune::Fem::SolverParameter Struct Reference

#include <dune/fem/solver/parameter.hh>

Inheritance diagram for Dune::Fem::SolverParameter:

Public Member Functions
	LIST_OF_INT_FORWARDED (Solvers, cg=1, bicgstab=2, gmres=3, minres=4, gradient=5, loop=6, superlu=7, bicg=8, preonly=9, fgmres=10)
	LIST_OF_INT_FORWARDED (Preconditioners, none=1, ssor=2, sor=3, ilu=4, gauss_seidel=5, jacobi=6, amg_ilu=7, amg_jacobi=8, ildl=9, oas=10, icc=11)
	SolverParameter (const ParameterReader &parameter=Parameter::container())
	SolverParameter (const std::string keyPrefix, const ParameterReader &parameter=Parameter::container())
const std::string &	keyPrefix () const
const ParameterReader &	parameter () const
virtual void	reset ()
virtual bool	verbose () const
virtual void	setVerbose (const bool verb)
virtual void	setDefaultErrorMeasure (int def)
virtual int	errorMeasure () const
virtual double	tolerance () const
virtual void	setTolerance (const double eps)
virtual int	maxIterations () const
virtual void	setMaxIterations (const int maxIter)
virtual int	solverMethod (const std::vector< int > standardMethods, const std::vector< std::string > &additionalMethods={}, int defaultMethod=0) const
virtual int	gmresRestart () const
virtual int	preconditionMethod (const std::vector< int > standardMethods, const std::vector< std::string > &additionalMethods={}, int defaultMethod=0) const
virtual double	relaxation () const
virtual int	preconditionerIteration () const
virtual int	preconditionerLevel () const
virtual bool	threading () const
virtual bool	knollTrick () const

Static Public Member Functions
static const std::string	solverMethodTable (int id)
static const std::string	preconditionMethodTable (int id)

Public Attributes
int	defaultErrorMeasure = 0

Protected Attributes
const std::string	keyPrefix_
ParameterReader	parameter_

Constructor & Destructor Documentation

SolverParameter() [1/2]

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

inline

SolverParameter() [2/2]

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

inlineexplicit

Member Function Documentation

errorMeasure()

virtual int Dune::Fem::SolverParameter::errorMeasure ( ) const

inlinevirtual

gmresRestart()

virtual int Dune::Fem::SolverParameter::gmresRestart ( ) const

inlinevirtual

keyPrefix()

const std::string & Dune::Fem::SolverParameter::keyPrefix ( ) const

inline

knollTrick()

virtual bool Dune::Fem::SolverParameter::knollTrick ( ) const

inlinevirtual

LIST_OF_INT_FORWARDED() [1/2]

Dune::Fem::SolverParameter::LIST_OF_INT_FORWARDED	(	Preconditioners	,
		none	= 1,
		ssor	= 2,
		sor	= 3,
		ilu	= 4,
		gauss_seidel	= 5,
		jacobi	= 6,
		amg_ilu	= 7,
		amg_jacobi	= 8,
		ildl	= 9,
		oas	= 10,
		icc	= 11
	)

LIST_OF_INT_FORWARDED() [2/2]

Dune::Fem::SolverParameter::LIST_OF_INT_FORWARDED	(	Solvers	,
		cg	= 1,
		bicgstab	= 2,
		gmres	= 3,
		minres	= 4,
		gradient	= 5,
		loop	= 6,
		superlu	= 7,
		bicg	= 8,
		preonly	= 9,
		fgmres	= 10
	)

maxIterations()

virtual int Dune::Fem::SolverParameter::maxIterations ( ) const

inlinevirtual

parameter()

const ParameterReader & Dune::Fem::SolverParameter::parameter ( ) const

inline

preconditionerIteration()

virtual int Dune::Fem::SolverParameter::preconditionerIteration ( ) const

inlinevirtual

preconditionerLevel()

virtual int Dune::Fem::SolverParameter::preconditionerLevel ( ) const

inlinevirtual

preconditionMethod()

virtual int Dune::Fem::SolverParameter::preconditionMethod ( const std::vector< int >  standardMethods, const std::vector< std::string > &  additionalMethods = {}, int  defaultMethod = 0  ) const

inlinevirtual

preconditionMethodTable()

static const std::string Dune::Fem::SolverParameter::preconditionMethodTable ( int  id )

inlinestatic

relaxation()

virtual double Dune::Fem::SolverParameter::relaxation ( ) const

inlinevirtual

reset()

virtual void Dune::Fem::SolverParameter::reset ( )

inlinevirtual

setDefaultErrorMeasure()

virtual void Dune::Fem::SolverParameter::setDefaultErrorMeasure ( int  def )

inlinevirtual

setMaxIterations()

virtual void Dune::Fem::SolverParameter::setMaxIterations ( const int  maxIter )

inlinevirtual

setTolerance()

virtual void Dune::Fem::SolverParameter::setTolerance ( const double  eps )

inlinevirtual

setVerbose()

virtual void Dune::Fem::SolverParameter::setVerbose ( const bool  verb )

inlinevirtual

solverMethod()

virtual int Dune::Fem::SolverParameter::solverMethod ( const std::vector< int >  standardMethods, const std::vector< std::string > &  additionalMethods = {}, int  defaultMethod = 0  ) const

inlinevirtual

solverMethodTable()

static const std::string Dune::Fem::SolverParameter::solverMethodTable ( int  id )

inlinestatic

threading()

virtual bool Dune::Fem::SolverParameter::threading ( ) const

inlinevirtual

tolerance()

virtual double Dune::Fem::SolverParameter::tolerance ( ) const

inlinevirtual

verbose()

virtual bool Dune::Fem::SolverParameter::verbose ( ) const

inlinevirtual

Member Data Documentation

defaultErrorMeasure

int Dune::Fem::SolverParameter::defaultErrorMeasure = 0

keyPrefix_

const std::string Dune::Fem::SolverParameter::keyPrefix_

protected

parameter_

ParameterReader Dune::Fem::SolverParameter::parameter_

protected

---

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

• solver/parameter.hh