Inheritance diagram for AztecOO_StatusTest:
Public Member Functions
|virtual void||PrintStatus (ostream &os, AztecOO_StatusType type) const|
Methods that must be implemented by any AztecOO_StatusTest implementation.
|virtual bool||ResidualVectorRequired () const =0|
|Indicates if residual vector is required by this convergence test. |
|virtual AztecOO_StatusType||CheckStatus (int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)=0|
|Check convergence status: Unconverged, Converged, Failed. |
|virtual AztecOO_StatusType||GetStatus () const =0|
|Return the result of the most recent checkStatus call. |
|virtual ostream &||Print (ostream &stream, int indent=0) const =0|
|Output formatted description of stopping test to output stream. |
Check convergence status: Unconverged, Converged, Failed.
This method checks to see if the convergence criteria are met. The calling routine may pass in the current native residual vector (the one naturally produced as part of the iterative method) or a pre-computed estimate of the two-norm of the current residual, or both or neither. The calling routine should also indicate if the solution of the linear problem has been updated to be compatible with the residual. Some methods, such as GMRES do update the solution at each iteration.
Indicates if residual vector is required by this convergence test.
If this method returns true, then the ResidualVector argument to the Converged() method will defined. If this method returns false, then the ResidualVector may not be defined when Converged() is called. Some iterative methods do not explicitly construct the residual vector at each iteration. Thus, if this vector is not required, this vector will not need to be constructed if this method returns false.