inverse operator based on a newton scheme More...

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

Inheritance diagram for Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >:

Public Types
typedef JacobianOperator	JacobianOperatorType
	type of operator's Jacobian

typedef DifferentiableOperator< JacobianOperatorType >	OperatorType
	type of operator to invert

typedef LInvOp	LinearInverseOperatorType
	type of linear inverse operator

typedef SelectPreconditioning< LinearInverseOperatorType >::type	PreconditionerType

typedef BaseType::DomainFunctionType	DomainFunctionType

typedef BaseType::RangeFunctionType	RangeFunctionType

typedef BaseType::DomainFieldType	DomainFieldType

typedef NewtonParameter< typename LinearInverseOperatorType::SolverParameterType >	ParameterType

typedef std::function< bool(const RangeFunctionType &w, const RangeFunctionType &dw, double residualNorm) >	ErrorMeasureType

typedef Impl::SolverInfo	SolverInfoType
	performance info about last solver call

typedef RangeFunction::RangeFieldType	RangeFieldType
	field type of the operator's range

Public Member Functions
	NewtonInverseOperator (LinearInverseOperatorType jInv, const DomainFieldType &epsilon, const ParameterType &parameter)

	NewtonInverseOperator (const ParameterType &parameter=ParameterType(Parameter::container()))

	NewtonInverseOperator (const DomainFieldType &epsilon, const ParameterType &parameter)

	NewtonInverseOperator (const DomainFieldType &epsilon, const ParameterReader &parameter=Parameter::container())

void	setErrorMeasure (ErrorMeasureType finished)

EisenstatWalkerStrategy &	eisenstatWalker ()

void	bind (const OperatorType &op)

void	bind (const OperatorType &op, const PreconditionerType &preconditioner)

void	unbind ()

virtual void	operator() (const DomainFunctionType &u, RangeFunctionType &w) const

int	iterations () const

void	setMaxIterations (int maxIterations)

int	linearIterations () const

void	setMaxLinearIterations (int maxLinearIterations)

void	updateLinearTolerance () const

bool	verbose () const

double	residual () const

NewtonFailure	failed () const

bool	converged () const

virtual int	lineSearch (RangeFunctionType &w, RangeFunctionType &dw, const DomainFunctionType &u, DomainFunctionType &residual) const

const std::vector< double > &	timing () const
	returns [overall, jacobian, solve] timings in seconds for last operator () call.

SolverInfoType	info () const
	return performance information about last solver run *‍/

virtual void	operator() (const DomainFunctionType &u, RangeFunctionType &w) const=0
	application operator

virtual void	finalize ()
	finalization of operator

virtual bool	nonlinear () const

Static Public Attributes
static constexpr bool	preconditioningAvailable = SelectPreconditioning< LinearInverseOperatorType > :: value
	type of preconditioner for linear solver

Protected Member Functions
void	bindOperatorAndPreconditioner (JacobianOperatorType &jOp) const

template<class ... Args>
JacobianOperatorType &	jacobian (Args &&... args) const

Protected Attributes
const OperatorType *	op_ = nullptr

const PreconditionerType *	preconditioner_ = nullptr

const bool	verbose_

const int	maxLineSearchIterations_

DomainFieldType	delta_

int	iterations_

int	linearIterations_

LinearInverseOperatorType	jInv_

std::unique_ptr< JacobianOperatorType >	jOp_

ParameterType	parameter_

int	stepCompleted_

const int	lsMethod_

ErrorMeasureType	finished_

const int	forcing_

EisenstatWalkerStrategy	eisenstatWalker_

std::vector< double >	timing_

Detailed Description

template<class JacobianOperator, class LInvOp>
class Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >

inverse operator based on a newton scheme

Template Parameters

Op	operator to invert (must be a DifferentiableOperator)
LInvOp	linear inverse operator

Note: Verbosity of the NewtonInverseOperator is controlled via the parameter fem.solver.nonlinear.verbose; it defaults to fem.solver.verbose.; Similar to CG solver the initial guess should take the constraints into account. In this case we need the initial residual to be zero on the boundary, i.e., when calling operator()(u,w) then w=g+u should hold on the Dirichlet boundary. This way we do not explicitly need to call the constraints here.

Member Typedef Documentation

◆ DomainFieldType

template<class JacobianOperator , class LInvOp >

typedef BaseType::DomainFieldType Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::DomainFieldType

◆ DomainFunctionType

template<class JacobianOperator , class LInvOp >

typedef BaseType::DomainFunctionType Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::DomainFunctionType

◆ ErrorMeasureType

template<class JacobianOperator , class LInvOp >

typedef std::function< bool ( const RangeFunctionType &w, const RangeFunctionType &dw, double residualNorm ) > Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::ErrorMeasureType

◆ JacobianOperatorType

template<class JacobianOperator , class LInvOp >

typedef JacobianOperator Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::JacobianOperatorType

type of operator's Jacobian

◆ LinearInverseOperatorType

template<class JacobianOperator , class LInvOp >

typedef LInvOp Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::LinearInverseOperatorType

type of linear inverse operator

◆ OperatorType

template<class JacobianOperator , class LInvOp >

typedef DifferentiableOperator< JacobianOperatorType > Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::OperatorType

type of operator to invert

◆ ParameterType

template<class JacobianOperator , class LInvOp >

typedef NewtonParameter<typename LinearInverseOperatorType::SolverParameterType> Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::ParameterType

◆ PreconditionerType

template<class JacobianOperator , class LInvOp >

typedef SelectPreconditioning<LinearInverseOperatorType>::type Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::PreconditionerType

◆ RangeFieldType

typedef RangeFunction::RangeFieldType Dune::Fem::Operator< JacobianOperator::RangeFunctionType , JacobianOperator::DomainFunctionType >::RangeFieldType

inherited

field type of the operator's range

◆ RangeFunctionType

template<class JacobianOperator , class LInvOp >

typedef BaseType::RangeFunctionType Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::RangeFunctionType

◆ SolverInfoType

template<class JacobianOperator , class LInvOp >

typedef Impl::SolverInfo Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::SolverInfoType

performance info about last solver call

Constructor & Destructor Documentation

◆ NewtonInverseOperator() [1/4]

template<class JacobianOperator , class LInvOp >

Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::NewtonInverseOperator	(	LinearInverseOperatorType	jInv,
		const DomainFieldType &	epsilon,
		const ParameterType &	parameter
	)

inline

◆ NewtonInverseOperator() [2/4]

template<class JacobianOperator , class LInvOp >

Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::NewtonInverseOperator ( const ParameterType & parameter = ParameterType( Parameter::container() ) )

inlineexplicit

constructor

Note: The tolerance is read from the parameter fem.solver.nonlinear.tolerance

◆ NewtonInverseOperator() [3/4]

template<class JacobianOperator , class LInvOp >

Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::NewtonInverseOperator	(	const DomainFieldType &	epsilon,
		const ParameterType &	parameter
	)

inline

constructor

Parameters

[in]	epsilon	tolerance for norm of residual
[in]	parameter	parameter set for solver config.

◆ NewtonInverseOperator() [4/4]

template<class JacobianOperator , class LInvOp >

Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::NewtonInverseOperator	(	const DomainFieldType &	epsilon,
		const ParameterReader &	parameter = `Parameter::container()`
	)

inline

constructor

Parameters

[in]	epsilon	tolerance for norm of residual
[in]	parameter	parameter set for solver config.

Member Function Documentation

◆ bind() [1/2]

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::bind ( const OperatorType & op )

inline

◆ bind() [2/2]

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::bind	(	const OperatorType &	op,
		const PreconditionerType &	preconditioner
	)

inline

◆ bindOperatorAndPreconditioner()

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::bindOperatorAndPreconditioner ( JacobianOperatorType & jOp ) const

inlineprotected

◆ converged()

template<class JacobianOperator , class LInvOp >

bool Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::converged ( ) const

inline

◆ eisenstatWalker()

template<class JacobianOperator , class LInvOp >

EisenstatWalkerStrategy & Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::eisenstatWalker ( )

inline

◆ failed()

template<class JacobianOperator , class LInvOp >

NewtonFailure Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::failed ( ) const

inline

◆ finalize()

virtual void Dune::Fem::Operator< JacobianOperator::RangeFunctionType , JacobianOperator::DomainFunctionType >::finalize ( )

inlinevirtualinherited

finalization of operator

Note: The default implementation is empty.

◆ info()

template<class JacobianOperator , class LInvOp >

SolverInfoType Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::info ( ) const

inline

return performance information about last solver run *‍/

◆ iterations()

template<class JacobianOperator , class LInvOp >

int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::iterations ( ) const

inline

◆ jacobian()

template<class JacobianOperator , class LInvOp >

template<class ... Args>

JacobianOperatorType & Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::jacobian ( Args &&... args ) const

inlineprotected

◆ linearIterations()

template<class JacobianOperator , class LInvOp >

int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::linearIterations ( ) const

inline

◆ lineSearch()

template<class JacobianOperator , class LInvOp >

virtual int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::lineSearch	(	RangeFunctionType &	w,
		RangeFunctionType &	dw,
		const DomainFunctionType &	u,
		DomainFunctionType &	residual
	)		const

inlinevirtual

◆ nonlinear()

virtual bool Dune::Fem::Operator< JacobianOperator::RangeFunctionType , JacobianOperator::DomainFunctionType >::nonlinear ( ) const

inlinevirtualinherited

Return true if the Operator is nonlinear and false otherwise (default is true).

◆ operator()() [1/2]

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::operator()	(	const DomainFunctionType &	u,
		RangeFunctionType &	w
	)		const

inlinevirtual

◆ operator()() [2/2]

virtual void Dune::Fem::Operator< JacobianOperator::RangeFunctionType , JacobianOperator::DomainFunctionType >::operator()	(	const DomainFunctionType &	u,
		RangeFunctionType &	w
	)		const

pure virtualinherited

application operator

Parameters

[in]	u	argument discrete function
[out]	w	destination discrete function

Note: This method has to be implemented by all derived classes.

◆ residual()

template<class JacobianOperator , class LInvOp >

double Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::residual ( ) const

inline

◆ setErrorMeasure()

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::setErrorMeasure ( ErrorMeasureType finished )

inline

◆ setMaxIterations()

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::setMaxIterations ( int maxIterations )

inline

◆ setMaxLinearIterations()

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::setMaxLinearIterations ( int maxLinearIterations )

inline

◆ timing()

template<class JacobianOperator , class LInvOp >

const std::vector< double > & Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::timing ( ) const

inline

returns [overall, jacobian, solve] timings in seconds for last operator () call.

◆ unbind()

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::unbind ( )

inline

◆ updateLinearTolerance()

template<class JacobianOperator , class LInvOp >

void Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::updateLinearTolerance ( ) const

inline

◆ verbose()

template<class JacobianOperator , class LInvOp >

bool Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::verbose ( ) const

inline

Member Data Documentation

◆ delta_

template<class JacobianOperator , class LInvOp >

DomainFieldType Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::delta_

mutableprotected

◆ eisenstatWalker_

template<class JacobianOperator , class LInvOp >

EisenstatWalkerStrategy Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::eisenstatWalker_

protected

◆ finished_

template<class JacobianOperator , class LInvOp >

ErrorMeasureType Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::finished_

protected

◆ forcing_

template<class JacobianOperator , class LInvOp >

const int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::forcing_

protected

◆ iterations_

template<class JacobianOperator , class LInvOp >

int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::iterations_

mutableprotected

◆ jInv_

template<class JacobianOperator , class LInvOp >

LinearInverseOperatorType Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::jInv_

mutableprotected

◆ jOp_

template<class JacobianOperator , class LInvOp >

std::unique_ptr< JacobianOperatorType > Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::jOp_

mutableprotected

◆ linearIterations_

template<class JacobianOperator , class LInvOp >

int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::linearIterations_

mutableprotected

◆ lsMethod_

template<class JacobianOperator , class LInvOp >

const int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::lsMethod_

protected

◆ maxLineSearchIterations_

template<class JacobianOperator , class LInvOp >

const int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::maxLineSearchIterations_

protected

◆ op_

template<class JacobianOperator , class LInvOp >

const OperatorType* Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::op_ = nullptr

protected

◆ parameter_

template<class JacobianOperator , class LInvOp >

ParameterType Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::parameter_

protected

◆ preconditioner_

template<class JacobianOperator , class LInvOp >

const PreconditionerType* Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::preconditioner_ = nullptr

protected

◆ preconditioningAvailable

template<class JacobianOperator , class LInvOp >

constexpr bool Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::preconditioningAvailable = SelectPreconditioning< LinearInverseOperatorType > :: value

staticconstexpr

type of preconditioner for linear solver

◆ stepCompleted_

template<class JacobianOperator , class LInvOp >

int Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::stepCompleted_

mutableprotected

◆ timing_

template<class JacobianOperator , class LInvOp >

std::vector<double> Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::timing_

mutableprotected

◆ verbose_

template<class JacobianOperator , class LInvOp >

const bool Dune::Fem::NewtonInverseOperator< JacobianOperator, LInvOp >::verbose_

protected

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

newtoninverseoperator.hh

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DomainFieldType

◆ DomainFunctionType

◆ ErrorMeasureType

◆ JacobianOperatorType

◆ LinearInverseOperatorType

◆ OperatorType

◆ ParameterType

◆ PreconditionerType

◆ RangeFieldType

◆ RangeFunctionType

◆ SolverInfoType

Constructor & Destructor Documentation

◆ NewtonInverseOperator() [1/4]

◆ NewtonInverseOperator() [2/4]

◆ NewtonInverseOperator() [3/4]

◆ NewtonInverseOperator() [4/4]

Member Function Documentation

◆ bind() [1/2]

◆ bind() [2/2]

◆ bindOperatorAndPreconditioner()

◆ converged()

◆ eisenstatWalker()

◆ failed()

◆ finalize()

◆ info()

◆ iterations()

◆ jacobian()

◆ linearIterations()

◆ lineSearch()

◆ nonlinear()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ residual()

◆ setErrorMeasure()

◆ setMaxIterations()

◆ setMaxLinearIterations()

◆ timing()

◆ unbind()

◆ updateLinearTolerance()

◆ verbose()

Member Data Documentation

◆ delta_

◆ eisenstatWalker_

◆ finished_

◆ forcing_

◆ iterations_

◆ jInv_

◆ jOp_

◆ linearIterations_

◆ lsMethod_

◆ maxLineSearchIterations_

◆ op_

◆ parameter_

◆ preconditioner_

◆ preconditioningAvailable

◆ stepCompleted_

◆ timing_

◆ verbose_