A Newton method for models using a finite volume discretization. More...
#include <fvbasenewtonmethod.hh>
Public Member Functions | |
FvBaseNewtonMethod (Simulator &simulator) | |
![]() | |
NewtonMethod (Simulator &simulator) | |
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. More... | |
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. More... | |
Scalar | suggestTimeStepSize (Scalar oldTimeStep) 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. | |
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. More... | |
const Ewoms::Timer & | prePostProcessTimer () const |
const Ewoms::Timer & | linearizeTimer () const |
const Ewoms::Timer & | solveTimer () const |
const Ewoms::Timer & | updateTimer () const |
Protected Member Functions | |
void | update_ (SolutionVector &nextSolution, const SolutionVector ¤tSolution, const GlobalEqVector &solutionUpdate, const GlobalEqVector ¤tResidual) |
Update the current solution with a delta vector. More... | |
void | beginIteration_ () |
Indicates the beginning of a Newton iteration. | |
Model & | model_ () |
Returns a reference to the model. | |
const Model & | model_ () const |
Returns a reference to the model. | |
![]() | |
bool | verbose_ () const |
Returns true if the Newton method ought to be chatty. | |
void | begin_ (const SolutionVector &u OPM_UNUSED) |
Called before the Newton method is applied to an non-linear system of equations. More... | |
void | beginIteration_ () |
Indicates the beginning of a Newton iteration. | |
void | linearize_ () |
Linearize the global non-linear system of equations. | |
void | preSolve_ (const SolutionVector ¤tSolution OPM_UNUSED, const GlobalEqVector ¤tResidual) |
void | postSolve_ (const SolutionVector &nextSolution OPM_UNUSED, const SolutionVector ¤tSolution OPM_UNUSED, const GlobalEqVector ¤tResidual OPM_UNUSED, const GlobalEqVector &solutionUpdate OPM_UNUSED) |
Update the error of the solution given the previous iteration. More... | |
void | update_ (SolutionVector &nextSolution, const SolutionVector ¤tSolution, const GlobalEqVector &solutionUpdate, const GlobalEqVector ¤tResidual) |
Update the current solution with a delta vector. More... | |
void | updateConstraintDof_ (unsigned globalDofIdx OPM_UNUSED, PrimaryVariables &nextValue, const Constraints &constraints) |
Update the primary variables for a degree of freedom which is constraint. | |
void | updatePrimaryVariables_ (unsigned globalDofIdx OPM_UNUSED, PrimaryVariables &nextValue, const PrimaryVariables ¤tValue, const EqVector &update, const EqVector ¤tResidual OPM_UNUSED) |
Update a single primary variables object. | |
void | writeConvergence_ (const SolutionVector ¤tSolution, const GlobalEqVector &solutionUpdate) |
Write the convergence behaviour of the newton method to disk. More... | |
void | endIteration_ (const SolutionVector &nextSolution OPM_UNUSED, const SolutionVector ¤tSolution OPM_UNUSED) |
Indicates that one Newton iteration was finished. More... | |
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. More... | |
void | succeeded_ () |
Called if the Newton method was successful. More... | |
int | targetIterations_ () const |
int | maxIterations_ () const |
Friends | |
class | Ewoms::NewtonMethod< TypeTag > |
Additional Inherited Members | |
![]() | |
static void | registerParameters () |
Register all run-time parameters for the Newton method. | |
![]() | |
static bool | enableConstraints_ () |
![]() | |
Simulator & | simulator_ |
Ewoms::Timer | prePostProcessTimer_ |
Ewoms::Timer | linearizeTimer_ |
Ewoms::Timer | solveTimer_ |
Ewoms::Timer | updateTimer_ |
std::ostringstream | endIterMsgStream_ |
Scalar | error_ |
Scalar | lastError_ |
Scalar | tolerance_ |
int | numIterations_ |
LinearSolverBackend | linearSolver_ |
CollectiveCommunication | comm_ |
ConvergenceWriter | convergenceWriter_ |
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.
|
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.
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. |