AztecOO Development
Loading...
Searching...
No Matches
Public Member Functions | List of all members
AztecOO_StatusTestMaxIters Class Reference

AztecOO_StatusTestMaxIters: An AztecOO_StatusTest class specifying a maximum number of iterations. More...

#include <AztecOO_StatusTestMaxIters.h>

Inheritance diagram for AztecOO_StatusTestMaxIters:
Inheritance graph
[legend]
Collaboration diagram for AztecOO_StatusTestMaxIters:
Collaboration graph
[legend]

Public Member Functions

 AztecOO_StatusTestMaxIters (int MaxIters)
 Constructor.
 
virtual ~AztecOO_StatusTestMaxIters ()
 Destructor.
 
bool ResidualVectorRequired () const
 Indicates if residual vector is required by this convergence test: returns false for this class.
 
AztecOO_StatusType CheckStatus (int CurrentIter, Epetra_MultiVector *CurrentResVector, double CurrentResNormEst, bool SolutionUpdated)
 Check convergence status: Unconverged, Converged, Failed.
 
AztecOO_StatusType GetStatus () const
 Return the result of the most recent checkStatus call.
 
std::ostream & Print (std::ostream &stream, int indent=0) const
 Output formatted description of stopping test to output stream.
 
int GetMaxIters () const
 Returns the maximum number of iterations set in the constructor.
 
int GetNumIters () const
 Returns the current number of iterations from the most recent StatusTest call.
 
- Public Member Functions inherited from AztecOO_StatusTest
 AztecOO_StatusTest ()
 Constructor.
 
virtual ~AztecOO_StatusTest ()
 Destructor.
 
virtual void PrintStatus (std::ostream &os, AztecOO_StatusType type) const
 

Detailed Description

AztecOO_StatusTestMaxIters: An AztecOO_StatusTest class specifying a maximum number of iterations.

Member Function Documentation

◆ CheckStatus()

AztecOO_StatusType AztecOO_StatusTestMaxIters::CheckStatus ( int CurrentIter,
Epetra_MultiVector * CurrentResVector,
double CurrentResNormEst,
bool SolutionUpdated )
virtual

Check convergence status: Unconverged, Converged, Failed.

This method checks to see if the convergence criteria are met..

Parameters
CurrentIter(In) Current iteration of iterative method. Compared against MaxIters value passed in at construction. If CurrentIter < MaxIters, we return with StatusType = Unconverged. Otherwise, StatusType will be set to Failed.
CurrentResVector(In) Ignored by this class.
CurrentResNormEst(In) Ignored by this class.
SolutionUpdated(In) Ignored by this class.
Returns
StatusType Unconverged if CurrentIter<MaxIters, Failed if CurrentIters>=MaxIters.

Implements AztecOO_StatusTest.

References Failed, and Unconverged.

◆ GetStatus()

AztecOO_StatusType AztecOO_StatusTestMaxIters::GetStatus ( ) const
inlinevirtual

Return the result of the most recent checkStatus call.

Implements AztecOO_StatusTest.

◆ Print()

std::ostream & AztecOO_StatusTestMaxIters::Print ( std::ostream & stream,
int indent = 0 ) const
virtual

Output formatted description of stopping test to output stream.

Implements AztecOO_StatusTest.

◆ ResidualVectorRequired()

bool AztecOO_StatusTestMaxIters::ResidualVectorRequired ( ) const
inlinevirtual

Indicates if residual vector is required by this convergence test: returns false for this class.

Implements AztecOO_StatusTest.


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