A Newton method for models using a finite volume discretization. More...

#include <fvbasenewtonmethod.hh>

Inheritance diagram for Opm::FvBaseNewtonMethod< TypeTag >:

Public Member Functions
	FvBaseNewtonMethod (Simulator &simulator)

void	finishInit ()
	Finialize the construction of the object. More...

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

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

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

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

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

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

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

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

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

bool	apply ()
	Run the Newton method. More...

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

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

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

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

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

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. More...

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

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

Model &	model_ ()
	Returns a reference to the model. More...

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

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

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

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

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. More...

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

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

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

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

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

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

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

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

int	targetIterations_ () const

int	maxIterations_ () const

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_

Scalar	tolerance_

int	numIterations_

LinearSolverBackend	linearSolver_

CollectiveCommunication	comm_

ConvergenceWriter	convergenceWriter_

Friends
class	NewtonMethod< TypeTag >

Detailed Description

template<class TypeTag>
class Opm::FvBaseNewtonMethod< TypeTag >

A Newton method for models using a finite volume discretization.

This class is sufficient for most models which use an Element or a Vertex Centered Finite Volume discretization.

Constructor & Destructor Documentation

◆ FvBaseNewtonMethod()

template<class TypeTag >

Opm::FvBaseNewtonMethod< TypeTag >::FvBaseNewtonMethod ( Simulator & simulator )

inline

Member Function Documentation

◆ apply()

template<class TypeTag >

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

inlineinherited

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 & )

inlineprotectedinherited

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

Parameters

u	The initial solution

References Opm::NewtonMethod< TypeTag >::convergenceWriter_, and Opm::NewtonMethod< TypeTag >::numIterations_.

◆ beginIteration_()

template<class TypeTag >

void Opm::FvBaseNewtonMethod< TypeTag >::beginIteration_ ( )

inlineprotected

Indicates the beginning of a Newton iteration.

References Opm::NewtonMethod< TypeTag >::beginIteration_(), and Opm::FvBaseNewtonMethod< TypeTag >::model_().

◆ converged()

template<class TypeTag >

bool Opm::NewtonMethod< TypeTag >::converged ( ) const

inlineinherited

Returns true if the error of the solution is below the tolerance.

References Opm::NewtonMethod< TypeTag >::error_, and Opm::NewtonMethod< TypeTag >::tolerance().

Referenced by Opm::NewtonMethod< TypeTag >::apply(), and Opm::NewtonMethod< TypeTag >::proceed_().

◆ enableConstraints_()

template<class TypeTag >

static bool Opm::NewtonMethod< TypeTag >::enableConstraints_ ( )

inlinestaticprotectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::preSolve_(), and Opm::NewtonMethod< TypeTag >::update_().

◆ end_()

template<class TypeTag >

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

inlineprotectedinherited

Indicates that we're done solving the non-linear system of equations.

References Opm::NewtonMethod< TypeTag >::convergenceWriter_.

◆ endIteration_()

template<class TypeTag >

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

inlineprotectedinherited

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

References Opm::NewtonMethod< TypeTag >::endIterMsg(), Opm::NewtonMethod< TypeTag >::error_, Opm::NewtonMethod< TypeTag >::numIterations_, Opm::NewtonMethod< TypeTag >::problem(), Opm::NewtonMethod< TypeTag >::simulator_, and Opm::NewtonMethod< TypeTag >::verbose_().

◆ endIterMsg()

template<class TypeTag >

std::ostringstream & Opm::NewtonMethod< TypeTag >::endIterMsg ( )

inlineinherited

Message that should be printed for the user after the end of an iteration.

References Opm::NewtonMethod< TypeTag >::endIterMsgStream_.

Referenced by Opm::NewtonMethod< TypeTag >::endIteration_().

◆ eraseMatrix()

template<class TypeTag >

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

inlineinherited

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

References Opm::NewtonMethod< TypeTag >::linearSolver_.

◆ failed_()

template<class TypeTag >

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

inlineprotectedinherited

Called if the Newton method broke down.

This method is called after end_()

References Opm::NewtonMethod< TypeTag >::numIterations_, and Opm::NewtonMethod< TypeTag >::targetIterations_().

◆ finishInit()

template<class TypeTag >

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

inlineinherited

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.)

◆ linearizeAuxiliaryEquations_()

template<class TypeTag >

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

inlineprotectedinherited

References Opm::NewtonMethod< TypeTag >::model().

◆ linearizeDomain_()

template<class TypeTag >

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

inlineprotectedinherited

Linearize the global non-linear system of equations associated with the spatial domain.

References Opm::NewtonMethod< TypeTag >::model().

◆ linearizeTimer()

template<class TypeTag >

const Timer & Opm::NewtonMethod< TypeTag >::linearizeTimer ( ) const

inlineinherited

References Opm::NewtonMethod< TypeTag >::linearizeTimer_.

◆ linearSolver() [1/2]

template<class TypeTag >

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

inlineinherited

Returns the linear solver backend object for external use.

References Opm::NewtonMethod< TypeTag >::linearSolver_.

◆ linearSolver() [2/2]

template<class TypeTag >

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

inlineinherited

Returns the linear solver backend object for external use.

References Opm::NewtonMethod< TypeTag >::linearSolver_.

◆ maxIterations_()

template<class TypeTag >

int Opm::NewtonMethod< TypeTag >::maxIterations_ ( ) const

inlineprotectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::proceed_().

◆ model() [1/2]

template<class TypeTag >

Model & Opm::NewtonMethod< TypeTag >::model ( )

inlineinherited

Returns a reference to the numeric model.

References Opm::NewtonMethod< TypeTag >::simulator_.

Referenced by Opm::NewtonMethod< TypeTag >::apply(), Opm::NewtonMethod< TypeTag >::linearizeAuxiliaryEquations_(), Opm::NewtonMethod< TypeTag >::linearizeDomain_(), Opm::FvBaseNewtonMethod< TypeTag >::model_(), Opm::NewtonMethod< TypeTag >::postSolve_(), Opm::NewtonMethod< TypeTag >::preSolve_(), and Opm::NewtonMethod< TypeTag >::update_().

◆ model() [2/2]

template<class TypeTag >

const Model & Opm::NewtonMethod< TypeTag >::model ( ) const

inlineinherited

Returns a reference to the numeric model.

References Opm::NewtonMethod< TypeTag >::simulator_.

◆ model_() [1/2]

template<class TypeTag >

Model & Opm::FvBaseNewtonMethod< TypeTag >::model_ ( )

inlineprotected

Returns a reference to the model.

References Opm::NewtonMethod< TypeTag >::model().

Referenced by Opm::FvBaseNewtonMethod< TypeTag >::beginIteration_(), and Opm::FvBaseNewtonMethod< TypeTag >::update_().

◆ model_() [2/2]

template<class TypeTag >

const Model & Opm::FvBaseNewtonMethod< TypeTag >::model_ ( ) const

inlineprotected

Returns a reference to the model.

References Opm::NewtonMethod< TypeTag >::model().

◆ numIterations()

template<class TypeTag >

int Opm::NewtonMethod< TypeTag >::numIterations ( ) const

inlineinherited

Returns the number of iterations done since the Newton method was invoked.

References Opm::NewtonMethod< TypeTag >::numIterations_.

Referenced by Opm::NewtonMethod< TypeTag >::proceed_().

◆ postSolve_()

template<class TypeTag >

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

inlineprotectedinherited

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

References Opm::NewtonMethod< TypeTag >::model(), and Opm::NewtonMethod< TypeTag >::simulator_.

◆ prePostProcessTimer()

template<class TypeTag >

const Timer & Opm::NewtonMethod< TypeTag >::prePostProcessTimer ( ) const

inlineinherited

References Opm::NewtonMethod< TypeTag >::prePostProcessTimer_.

◆ preSolve_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::preSolve_	(	const SolutionVector &	,
		const GlobalEqVector &	currentResidual
	)

inlineprotectedinherited

References Opm::NewtonMethod< TypeTag >::comm_, Opm::NewtonMethod< TypeTag >::enableConstraints_(), Opm::NewtonMethod< TypeTag >::error_, Opm::NewtonMethod< TypeTag >::lastError_, and Opm::NewtonMethod< TypeTag >::model().

◆ problem() [1/2]

template<class TypeTag >

Problem & Opm::NewtonMethod< TypeTag >::problem ( )

inlineinherited

Returns a reference to the object describing the current physical problem.

References Opm::NewtonMethod< TypeTag >::simulator_.

Referenced by Opm::NewtonMethod< TypeTag >::beginIteration_(), Opm::NewtonMethod< TypeTag >::endIteration_(), and Opm::NewtonMethod< TypeTag >::suggestTimeStepSize().

◆ problem() [2/2]

template<class TypeTag >

const Problem & Opm::NewtonMethod< TypeTag >::problem ( ) const

inlineinherited

Returns a reference to the object describing the current physical problem.

References Opm::NewtonMethod< TypeTag >::simulator_.

◆ proceed_()

template<class TypeTag >

bool Opm::NewtonMethod< TypeTag >::proceed_ ( ) const

inlineprotectedinherited

Returns true iff another Newton iteration should be done.

References Opm::NewtonMethod< TypeTag >::converged(), Opm::NewtonMethod< TypeTag >::error_, Opm::NewtonMethod< TypeTag >::lastError_, Opm::NewtonMethod< TypeTag >::maxIterations_(), and Opm::NewtonMethod< TypeTag >::numIterations().

Referenced by Opm::NewtonMethod< TypeTag >::apply().

◆ registerParameters()

template<class TypeTag >

static void Opm::NewtonMethod< TypeTag >::registerParameters ( )

inlinestaticinherited

Register all run-time parameters for the Newton method.

Referenced by Opm::FvBaseDiscretization< TypeTag >::registerParameters().

◆ setIterationIndex()

template<class TypeTag >

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

inlineinherited

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.

References Opm::NewtonMethod< TypeTag >::numIterations_.

◆ setTolerance()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::setTolerance ( Scalar value )

inlineinherited

Set the current tolerance at which the Newton method considers itself to be converged.

References Opm::NewtonMethod< TypeTag >::tolerance_.

◆ solveTimer()

template<class TypeTag >

const Timer & Opm::NewtonMethod< TypeTag >::solveTimer ( ) const

inlineinherited

References Opm::NewtonMethod< TypeTag >::solveTimer_.

◆ succeeded_()

template<class TypeTag >

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

inlineprotectedinherited

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

inlineinherited

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.

References Opm::NewtonMethod< TypeTag >::numIterations_, Opm::NewtonMethod< TypeTag >::problem(), and Opm::NewtonMethod< TypeTag >::targetIterations_().

◆ targetIterations_()

template<class TypeTag >

int Opm::NewtonMethod< TypeTag >::targetIterations_ ( ) const

inlineprotectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::failed_(), and Opm::NewtonMethod< TypeTag >::suggestTimeStepSize().

◆ tolerance()

template<class TypeTag >

Scalar Opm::NewtonMethod< TypeTag >::tolerance ( ) const

inlineinherited

Return the current tolerance at which the Newton method considers itself to be converged.

References Opm::NewtonMethod< TypeTag >::tolerance_.

Referenced by Opm::NewtonMethod< TypeTag >::converged().

◆ update_()

template<class TypeTag >

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

inlineprotected

Update the current solution with a delta vector.

The error estimates required for the converged() and proceed() methods should be updated inside this method.

Different update strategies, such as line search and chopped updates can be implemented. The default behavior is just to subtract deltaU from uLastIter, i.e.

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

Parameters

nextSolution	The solution vector at the end of the current iteration
currentSolution	The solution vector at the beginning of the current iteration
solutionUpdate	The delta as calculated by solving the linear system of equations. This parameter also stores the updated solution.
currentResidual	The residual (i.e., right-hand-side) of the current solution.

References Opm::FvBaseNewtonMethod< TypeTag >::model_(), and Opm::NewtonMethod< TypeTag >::update_().

◆ updateConstraintDof_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::updateConstraintDof_	(	unsigned	,
		PrimaryVariables &	nextValue,
		const Constraints &	constraints
	)

inlineprotectedinherited

Update the primary variables for a degree of freedom which is constraint.

◆ updatePrimaryVariables_()

template<class TypeTag >

void Opm::NewtonMethod< TypeTag >::updatePrimaryVariables_	(	unsigned	,
		PrimaryVariables &	nextValue,
		const PrimaryVariables &	currentValue,
		const EqVector &	update,
		const EqVector &
	)

inlineprotectedinherited

Update a single primary variables object.

◆ updateTimer()

template<class TypeTag >

const Timer & Opm::NewtonMethod< TypeTag >::updateTimer ( ) const

inlineinherited

References Opm::NewtonMethod< TypeTag >::updateTimer_.

◆ verbose_()

template<class TypeTag >

bool Opm::NewtonMethod< TypeTag >::verbose_ ( ) const

inlineprotectedinherited

Returns true if the Newton method ought to be chatty.

References Opm::NewtonMethod< TypeTag >::comm_.

Referenced by Opm::NewtonMethod< TypeTag >::apply(), and Opm::NewtonMethod< TypeTag >::endIteration_().

◆ writeConvergence_()

template<class TypeTag >

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

inlineprotectedinherited

Write the convergence behaviour of the newton method to disk.

This method is called as part of the update proceedure.

References Opm::NewtonMethod< TypeTag >::convergenceWriter_.

Friends And Related Function Documentation

◆ NewtonMethod< TypeTag >

template<class TypeTag >

friend class NewtonMethod< TypeTag >

friend

Member Data Documentation

◆ comm_

template<class TypeTag >

CollectiveCommunication Opm::NewtonMethod< TypeTag >::comm_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::preSolve_(), and Opm::NewtonMethod< TypeTag >::verbose_().

◆ convergenceWriter_

template<class TypeTag >

ConvergenceWriter Opm::NewtonMethod< TypeTag >::convergenceWriter_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::begin_(), Opm::NewtonMethod< TypeTag >::end_(), and Opm::NewtonMethod< TypeTag >::writeConvergence_().

◆ endIterMsgStream_

template<class TypeTag >

std::ostringstream Opm::NewtonMethod< TypeTag >::endIterMsgStream_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::beginIteration_(), and Opm::NewtonMethod< TypeTag >::endIterMsg().

◆ error_

template<class TypeTag >

Scalar Opm::NewtonMethod< TypeTag >::error_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::beginIteration_(), Opm::NewtonMethod< TypeTag >::converged(), Opm::NewtonMethod< TypeTag >::endIteration_(), Opm::NewtonMethod< TypeTag >::NewtonMethod(), Opm::NewtonMethod< TypeTag >::preSolve_(), and Opm::NewtonMethod< TypeTag >::proceed_().

◆ lastError_

template<class TypeTag >

Scalar Opm::NewtonMethod< TypeTag >::lastError_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::beginIteration_(), Opm::NewtonMethod< TypeTag >::NewtonMethod(), Opm::NewtonMethod< TypeTag >::preSolve_(), and Opm::NewtonMethod< TypeTag >::proceed_().

◆ linearizeTimer_

template<class TypeTag >

Timer Opm::NewtonMethod< TypeTag >::linearizeTimer_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::apply(), and Opm::NewtonMethod< TypeTag >::linearizeTimer().

◆ linearSolver_

template<class TypeTag >

LinearSolverBackend Opm::NewtonMethod< TypeTag >::linearSolver_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::apply(), Opm::NewtonMethod< TypeTag >::eraseMatrix(), and Opm::NewtonMethod< TypeTag >::linearSolver().

◆ numIterations_

template<class TypeTag >

int Opm::NewtonMethod< TypeTag >::numIterations_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::begin_(), Opm::NewtonMethod< TypeTag >::endIteration_(), Opm::NewtonMethod< TypeTag >::failed_(), Opm::NewtonMethod< TypeTag >::NewtonMethod(), Opm::NewtonMethod< TypeTag >::numIterations(), Opm::NewtonMethod< TypeTag >::setIterationIndex(), and Opm::NewtonMethod< TypeTag >::suggestTimeStepSize().

◆ prePostProcessTimer_

template<class TypeTag >

Timer Opm::NewtonMethod< TypeTag >::prePostProcessTimer_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::apply(), and Opm::NewtonMethod< TypeTag >::prePostProcessTimer().

◆ simulator_

template<class TypeTag >

Simulator& Opm::NewtonMethod< TypeTag >::simulator_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::beginIteration_(), Opm::NewtonMethod< TypeTag >::endIteration_(), Opm::NewtonMethod< TypeTag >::model(), Opm::NewtonMethod< TypeTag >::postSolve_(), and Opm::NewtonMethod< TypeTag >::problem().

◆ solveTimer_

template<class TypeTag >

Timer Opm::NewtonMethod< TypeTag >::solveTimer_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::apply(), and Opm::NewtonMethod< TypeTag >::solveTimer().

◆ tolerance_

template<class TypeTag >

Scalar Opm::NewtonMethod< TypeTag >::tolerance_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::NewtonMethod(), Opm::NewtonMethod< TypeTag >::setTolerance(), and Opm::NewtonMethod< TypeTag >::tolerance().

◆ updateTimer_

template<class TypeTag >

Timer Opm::NewtonMethod< TypeTag >::updateTimer_

protectedinherited

Referenced by Opm::NewtonMethod< TypeTag >::apply(), and Opm::NewtonMethod< TypeTag >::updateTimer().

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

fvbasenewtonmethod.hh

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ FvBaseNewtonMethod()

Member Function Documentation

◆ apply()

◆ begin_()

◆ beginIteration_()

◆ converged()

◆ enableConstraints_()

◆ end_()

◆ endIteration_()

◆ endIterMsg()

◆ eraseMatrix()

◆ failed_()

◆ finishInit()

◆ linearizeAuxiliaryEquations_()

◆ linearizeDomain_()

◆ linearizeTimer()

◆ linearSolver() [1/2]

◆ linearSolver() [2/2]

◆ maxIterations_()

◆ model() [1/2]

◆ model() [2/2]

◆ model_() [1/2]

◆ model_() [2/2]

◆ numIterations()

◆ postSolve_()

◆ prePostProcessTimer()

◆ preSolve_()

◆ problem() [1/2]

◆ problem() [2/2]

◆ proceed_()

◆ registerParameters()

◆ setIterationIndex()

◆ setTolerance()

◆ solveTimer()

◆ succeeded_()

◆ suggestTimeStepSize()

◆ targetIterations_()

◆ tolerance()

◆ update_()

◆ updateConstraintDof_()

◆ updatePrimaryVariables_()

◆ updateTimer()

◆ verbose_()

◆ writeConvergence_()

Friends And Related Function Documentation

◆ NewtonMethod< TypeTag >

Member Data Documentation

◆ comm_

◆ convergenceWriter_

◆ endIterMsgStream_

◆ error_

◆ lastError_

◆ linearizeTimer_

◆ linearSolver_

◆ numIterations_

◆ prePostProcessTimer_

◆ simulator_

◆ solveTimer_

◆ tolerance_

◆ updateTimer_