Ewoms::ConvergenceCriterion< Vector > Class Template Referenceabstract Base class for all convergence criteria which only defines an virtual API. More...
Inheritance diagram for Ewoms::ConvergenceCriterion< Vector >:
Detailed Descriptiontemplate<class Vector>
|
|
inlinevirtual |
Destructor.
In the ConvergenceCriterion it does not do anything, but it is required to be declared virtual.
|
pure virtual |
Returns the accuracy of the solution at the last update.
A value of zero means that the solution was exact.
Implemented in Ewoms::WeightedResidualReductionCriterion< Vector, CollectiveCommunication >, Ewoms::FixPointCriterion< Vector, CollectiveCommunication >, and Ewoms::ResidReductionCriterion< Vector >.
|
pure virtual |
Returns true if and only if the convergence criterion is met.
Implemented in Ewoms::WeightedResidualReductionCriterion< Vector, CollectiveCommunication >, Ewoms::FixPointCriterion< Vector, CollectiveCommunication >, and Ewoms::ResidReductionCriterion< Vector >.
|
inlinevirtual |
Prints the information about the convergence behaviour for the current iteration.
iter | The iteration number. The semantics of this parameter are chosen by the linear solver. |
os | The output stream to which the message gets written. |
Reimplemented in Ewoms::WeightedResidualReductionCriterion< Vector, CollectiveCommunication >, and Ewoms::ResidReductionCriterion< Vector >.
|
inlinevirtual |
Prints the initial information about the convergence behaviour.
This method is called after setInitial() if the solver thinks it's a good idea to be verbose. In practice, "printing the initial information" means printing column headers and the initial state.
os | The output stream to which the message gets written. |
Reimplemented in Ewoms::WeightedResidualReductionCriterion< Vector, CollectiveCommunication >, and Ewoms::ResidReductionCriterion< Vector >.
|
pure virtual |
Set the initial solution of the linear system of equations.
This version of the method does NOT take the two-norm of the residual as argument. If the two-norm of the defect is available for the linear solver, the version of the update() method with it should be called.
curSol | The current iterative solution of the linear system of equations |
curResid | The residual vector of the current iterative solution of the linear system of equations |
Implemented in Ewoms::WeightedResidualReductionCriterion< Vector, CollectiveCommunication >, Ewoms::FixPointCriterion< Vector, CollectiveCommunication >, and Ewoms::ResidReductionCriterion< Vector >.
|
pure virtual |
Update the internal members of the convergence criterion with the current solution.
This version of the method does NOT take the two-norm of the residual as argument. If the two-norm of the defect is available for the linear solver, the version of the update() method with it should be called.
curSol | The current iterative solution of the linear system of equations |
curResid | The residual vector of the current iterative solution of the linear system of equations |
Implemented in Ewoms::WeightedResidualReductionCriterion< Vector, CollectiveCommunication >, Ewoms::FixPointCriterion< Vector, CollectiveCommunication >, and Ewoms::ResidReductionCriterion< Vector >.