dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Dune::Fem::NewtonParameter< SolverParam > Struct Template Reference

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

Inheritance diagram for Dune::Fem::NewtonParameter< SolverParam >:
Inheritance graph

Public Types

enum class  LineSearchMethod { none = 0 , simple = 1 }
 

Public Member Functions

 NewtonParameter (const SolverParam &baseParameter, const std::string keyPrefix="fem.solver.newton.")
 
template<class Parameter , std::enable_if_t<!std::is_base_of< SolverParam, Parameter >::value &&!std::is_same< Parameter, ParameterReader >::value, int > i = 0>
 NewtonParameter (const Parameter &solverParameter, const std::string keyPrefix="fem.solver.newton.")
 
template<class ParamReader , std::enable_if_t<!std::is_same< ParamReader, SolverParam >::value &&std::is_same< ParamReader, ParameterReader >::value, int > i = 0>
 NewtonParameter (const ParamReader &parameter, const std::string keyPrefix="fem.solver.newton.")
 
const ParameterReaderparameter () const
 
const SolverParam & solverParameter () const
 
const SolverParam & linear () const
 
virtual void reset ()
 
virtual double tolerance () const
 
virtual void setTolerance (const double tol)
 
virtual bool verbose () const
 
virtual void setVerbose (bool verb)
 
virtual int maxIterations () const
 
virtual void setMaxIterations (const int maxIter)
 
virtual int maxLinearIterations () const
 = max iterations of each linear solve
 
virtual void setMaxLinearIterations (const int maxLinearIter)
 
virtual int maxLineSearchIterations () const
 
virtual void setMaxLineSearchIterations (const int maxLineSearchIter)
 
virtual LineSearchMethod lineSearch () const
 
virtual void setLineSearch (const LineSearchMethod method)
 
virtual ParamDefault * clone () const
 

Protected Member Functions

const ParamImpl & asImp () const
 

Protected Attributes

std::shared_ptr< SolverParam > baseParam_
 
const std::string keyPrefix_
 
ParameterReader parameter_
 

Member Enumeration Documentation

◆ LineSearchMethod

template<class SolverParam = SolverParameter>
enum class Dune::Fem::NewtonParameter::LineSearchMethod
strong
Enumerator
none 
simple 

Constructor & Destructor Documentation

◆ NewtonParameter() [1/3]

template<class SolverParam = SolverParameter>
Dune::Fem::NewtonParameter< SolverParam >::NewtonParameter ( const SolverParam &  baseParameter,
const std::string  keyPrefix = "fem.solver.newton." 
)
inline

◆ NewtonParameter() [2/3]

template<class SolverParam = SolverParameter>
template<class Parameter , std::enable_if_t<!std::is_base_of< SolverParam, Parameter >::value &&!std::is_same< Parameter, ParameterReader >::value, int > i = 0>
Dune::Fem::NewtonParameter< SolverParam >::NewtonParameter ( const Parameter solverParameter,
const std::string  keyPrefix = "fem.solver.newton." 
)
inline

◆ NewtonParameter() [3/3]

template<class SolverParam = SolverParameter>
template<class ParamReader , std::enable_if_t<!std::is_same< ParamReader, SolverParam >::value &&std::is_same< ParamReader, ParameterReader >::value, int > i = 0>
Dune::Fem::NewtonParameter< SolverParam >::NewtonParameter ( const ParamReader &  parameter,
const std::string  keyPrefix = "fem.solver.newton." 
)
inline

Member Function Documentation

◆ asImp()

template<class ParamDefault , class ParamImpl >
const ParamImpl & Dune::Fem::LocalParameter< ParamDefault, ParamImpl >::asImp ( ) const
inlineprotectedinherited

◆ clone()

template<class ParamDefault , class ParamImpl >
virtual ParamDefault * Dune::Fem::LocalParameter< ParamDefault, ParamImpl >::clone ( ) const
inlinevirtualinherited

◆ linear()

template<class SolverParam = SolverParameter>
const SolverParam & Dune::Fem::NewtonParameter< SolverParam >::linear ( ) const
inline

◆ lineSearch()

template<class SolverParam = SolverParameter>
virtual LineSearchMethod Dune::Fem::NewtonParameter< SolverParam >::lineSearch ( ) const
inlinevirtual

◆ maxIterations()

template<class SolverParam = SolverParameter>
virtual int Dune::Fem::NewtonParameter< SolverParam >::maxIterations ( ) const
inlinevirtual

◆ maxLinearIterations()

template<class SolverParam = SolverParameter>
virtual int Dune::Fem::NewtonParameter< SolverParam >::maxLinearIterations ( ) const
inlinevirtual

= max iterations of each linear solve

◆ maxLineSearchIterations()

template<class SolverParam = SolverParameter>
virtual int Dune::Fem::NewtonParameter< SolverParam >::maxLineSearchIterations ( ) const
inlinevirtual

◆ parameter()

template<class SolverParam = SolverParameter>
const ParameterReader & Dune::Fem::NewtonParameter< SolverParam >::parameter ( ) const
inline

◆ reset()

template<class SolverParam = SolverParameter>
virtual void Dune::Fem::NewtonParameter< SolverParam >::reset ( )
inlinevirtual

◆ setLineSearch()

template<class SolverParam = SolverParameter>
virtual void Dune::Fem::NewtonParameter< SolverParam >::setLineSearch ( const LineSearchMethod  method)
inlinevirtual

◆ setMaxIterations()

template<class SolverParam = SolverParameter>
virtual void Dune::Fem::NewtonParameter< SolverParam >::setMaxIterations ( const int  maxIter)
inlinevirtual

◆ setMaxLinearIterations()

template<class SolverParam = SolverParameter>
virtual void Dune::Fem::NewtonParameter< SolverParam >::setMaxLinearIterations ( const int  maxLinearIter)
inlinevirtual

◆ setMaxLineSearchIterations()

template<class SolverParam = SolverParameter>
virtual void Dune::Fem::NewtonParameter< SolverParam >::setMaxLineSearchIterations ( const int  maxLineSearchIter)
inlinevirtual

◆ setTolerance()

template<class SolverParam = SolverParameter>
virtual void Dune::Fem::NewtonParameter< SolverParam >::setTolerance ( const double  tol)
inlinevirtual

◆ setVerbose()

template<class SolverParam = SolverParameter>
virtual void Dune::Fem::NewtonParameter< SolverParam >::setVerbose ( bool  verb)
inlinevirtual

◆ solverParameter()

template<class SolverParam = SolverParameter>
const SolverParam & Dune::Fem::NewtonParameter< SolverParam >::solverParameter ( ) const
inline

◆ tolerance()

template<class SolverParam = SolverParameter>
virtual double Dune::Fem::NewtonParameter< SolverParam >::tolerance ( ) const
inlinevirtual

◆ verbose()

template<class SolverParam = SolverParameter>
virtual bool Dune::Fem::NewtonParameter< SolverParam >::verbose ( ) const
inlinevirtual

Member Data Documentation

◆ baseParam_

template<class SolverParam = SolverParameter>
std::shared_ptr<SolverParam> Dune::Fem::NewtonParameter< SolverParam >::baseParam_
protected

◆ keyPrefix_

template<class SolverParam = SolverParameter>
const std::string Dune::Fem::NewtonParameter< SolverParam >::keyPrefix_
protected

◆ parameter_

template<class SolverParam = SolverParameter>
ParameterReader Dune::Fem::NewtonParameter< SolverParam >::parameter_
protected

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