The multi-dimensional Newton method. More...

#include <newtonmethod.hh>

Inheritance diagram for Opm::NewtonMethod< TypeTag >:

Public Member Functions
	NewtonMethod (Simulator &simulator)

void	finishInit ()
	Finialize the construction of the object.

bool	converged () const
	Returns true if the error of the solution is below the tolerance.

Problem &	problem ()
	Returns a reference to the object describing the current physical problem.

const Problem &	problem () const
	Returns a reference to the object describing the current physical problem.

Model &	model ()
	Returns a reference to the numeric model.

const Model &	model () const
	Returns a reference to the numeric model.

int	numIterations () const
	Returns the number of iterations done since the Newton method was invoked.

void	setIterationIndex (int value)
	Set the index of current iteration.

Scalar	tolerance () const
	Return the current tolerance at which the Newton method considers itself to be converged.

void	setTolerance (Scalar value)
	Set the current tolerance at which the Newton method considers itself to be converged.

bool	apply ()
	Run the Newton method.

Scalar	suggestTimeStepSize (Scalar oldDt) const
	Suggest a new time-step size based on the old time-step size.

std::ostringstream &	endIterMsg ()
	Message that should be printed for the user after the end of an iteration.

void	eraseMatrix ()
	Causes the solve() method to discared the structure of the linear system of equations the next time it is called.

LinearSolverBackend &	linearSolver ()
	Returns the linear solver backend object for external use.

const LinearSolverBackend &	linearSolver () const
	Returns the linear solver backend object for external use.

const Timer &	prePostProcessTimer () const

const Timer &	linearizeTimer () const

const Timer &	solveTimer () const

const Timer &	updateTimer () const

Static Public Member Functions
static void	registerParameters ()
	Register all run-time parameters for the Newton method.

Protected Member Functions
bool	verbose_ () const
	Returns true if the Newton method ought to be chatty.

void	begin_ (const SolutionVector &)
	Called before the Newton method is applied to an non-linear system of equations.

void	beginIteration_ ()
	Indicates the beginning of a Newton iteration.

void	linearizeDomain_ ()
	Linearize the global non-linear system of equations associated with the spatial domain.

void	linearizeAuxiliaryEquations_ ()

void	preSolve_ (const SolutionVector &, const GlobalEqVector &currentResidual)

void	postSolve_ (const SolutionVector &, const GlobalEqVector &, GlobalEqVector &solutionUpdate)
	Update the error of the solution given the previous iteration.

void	update_ (SolutionVector &nextSolution, const SolutionVector &currentSolution, const GlobalEqVector &solutionUpdate, const GlobalEqVector &currentResidual)
	Update the current solution with a delta vector.

void	updateConstraintDof_ (unsigned, PrimaryVariables &nextValue, const Constraints &constraints)
	Update the primary variables for a degree of freedom which is constraint.

void	updatePrimaryVariables_ (unsigned, PrimaryVariables &nextValue, const PrimaryVariables &currentValue, const EqVector &update, const EqVector &)
	Update a single primary variables object.

void	writeConvergence_ (const SolutionVector &currentSolution, const GlobalEqVector &solutionUpdate)
	Write the convergence behaviour of the newton method to disk.

void	endIteration_ (const SolutionVector &, const SolutionVector &)
	Indicates that one Newton iteration was finished.

bool	proceed_ () const
	Returns true iff another Newton iteration should be done.

void	end_ ()
	Indicates that we're done solving the non-linear system of equations.

void	failed_ ()
	Called if the Newton method broke down.

void	succeeded_ ()
	Called if the Newton method was successful.

Static Protected Member Functions
static bool	enableConstraints_ ()

Protected Attributes
Simulator &	simulator_

Timer	prePostProcessTimer_

Timer	linearizeTimer_

Timer	solveTimer_

Timer	updateTimer_

std::ostringstream	endIterMsgStream_

Scalar	error_

Scalar	lastError_

NewtonMethodParams< Scalar >	params_

int	numIterations_

LinearSolverBackend	linearSolver_

CollectiveCommunication	comm_

ConvergenceWriter	convergenceWriter_

Detailed Description

template<class TypeTag>
class Opm::NewtonMethod< TypeTag >

The multi-dimensional Newton method.

This class uses static polymorphism to allow implementations to implement different update/convergence strategies.

Member Function Documentation

◆ apply()

template<class TypeTag >

bool Opm::NewtonMethod< TypeTag >::apply ( )

inline

Run the Newton method.

The actual implementation can influence all the strategic decisions via callbacks using static polymorphism.

◆ begin_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::begin_ ( const SolutionVector & )

inlineprotected

Called before the Newton method is applied to an non-linear system of equations.

Parameters

u	The initial solution

◆ endIteration_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::endIteration_	(	const SolutionVector &	,
		const SolutionVector &
	)

inlineprotected

Indicates that one Newton iteration was finished.

Parameters

nextSolution	The solution after the current Newton iteration
currentSolution	The solution at the beginning of the current Newton iteration

◆ failed_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::failed_ ( )

inlineprotected

Called if the Newton method broke down.

This method is called after end_()

◆ finishInit()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::finishInit ( )

inline

Finialize the construction of the object.

At this point, it can be assumed that all objects featured by the simulator have been allocated. (But not that they have been fully initialized yet.)

◆ linearSolver()

template<class TypeTag >

const LinearSolverBackend & Opm::NewtonMethod< TypeTag >::linearSolver ( ) const

inline

Returns the linear solver backend object for external use.

◆ postSolve_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::postSolve_	(	const SolutionVector &	,
		const GlobalEqVector &	,
		GlobalEqVector &	solutionUpdate
	)

inlineprotected

Update the error of the solution given the previous iteration.

For our purposes, the error of a solution is defined as the maximum of the weighted residual of a given solution.

Parameters

currentSolution	The solution at the beginning the current iteration
currentResidual	The residual (i.e., right-hand-side) of the current iteration's solution.
solutionUpdate	The difference between the current and the next solution

◆ setIterationIndex()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::setIterationIndex ( int value )

inline

Set the index of current iteration.

Normally this does not need to be called, but if the non-linear solver is implemented externally, it needs to be set in order for the model to do the Right Thing (TM) while linearizing.

◆ succeeded_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::succeeded_ ( )

inlineprotected

Called if the Newton method was successful.

This method is called after end_()

◆ suggestTimeStepSize()

template<class TypeTag >

Scalar Opm::NewtonMethod< TypeTag >::suggestTimeStepSize ( Scalar oldDt ) const

inline

Suggest a new time-step size based on the old time-step size.

The default behavior is to suggest the old time-step size scaled by the ratio between the target iterations and the iterations required to actually solve the last time-step.

◆ update_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::update_	(	SolutionVector &	nextSolution,
		const SolutionVector &	currentSolution,
		const GlobalEqVector &	solutionUpdate,
		const GlobalEqVector &	currentResidual
	)

inlineprotected

Update the current solution with a delta vector.

Different update strategies, such as chopped updates can be implemented by overriding this method. The default behavior is use the standard Newton-Raphson update strategy, i.e.

$u^{k+1} = u^k - \Delta u^k$

Parameters

nextSolution	The solution vector after the current iteration
currentSolution	The solution vector after the last iteration
solutionUpdate	The delta vector as calculated by solving the linear system of equations
currentResidual	The residual vector of the current Newton-Raphson iteraton

◆ writeConvergence_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::writeConvergence_	(	const SolutionVector &	currentSolution,
		const GlobalEqVector &	solutionUpdate
	)

inlineprotected

Write the convergence behaviour of the newton method to disk.

This method is called as part of the update proceedure.

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

opm/models/nonlinear/newtonmethod.hh

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ apply()

◆ begin_()

◆ endIteration_()

◆ failed_()

◆ finishInit()

◆ linearSolver()

◆ postSolve_()

◆ setIterationIndex()

◆ succeeded_()

◆ suggestTimeStepSize()

◆ update_()

◆ writeConvergence_()