Belos Package Browser (Single Doxygen Collection) Development
|
A Belos::StatusTest class for specifying a maximum number of iterations. More...
#include <BelosStatusTestMaxIters.hpp>
Private data members. | |
int | maxIters_ |
Maximum number of iterations allowed. | |
int | nIters_ |
Current number of iterations. | |
StatusType | status_ |
Status. | |
Constructor/Destructor. | |
StatusTestMaxIters (int maxIters) | |
Constructor. | |
virtual | ~StatusTestMaxIters () |
Destructor. | |
Status methods | |
StatusType | checkStatus (Iteration< ScalarType, MV, OP > *iSolver) |
Check convergence status of the iterative solver: Unconverged, Converged, Failed. | |
StatusType | getStatus () const |
Return the result of the most recent CheckStatus call. | |
Reset methods | |
void | reset () |
Resets the status test to the initial internal state. | |
void | setMaxIters (int maxIters) |
Sets the maximum number of iterations allowed. | |
Accessor methods | |
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. | |
Print methods | |
void | print (std::ostream &os, int indent=0) const |
Output formatted description of stopping test to output stream. | |
void | printStatus (std::ostream &os, StatusType type) const |
Print message for each status specific to this stopping test. | |
Overridden from Teuchos::Describable | |
std::string | description () const |
Method to return description of the maximum iteration status test | |
Additional Inherited Members | |
![]() | |
StatusTest () | |
Constructor. | |
virtual | ~StatusTest () |
Destructor. | |
A Belos::StatusTest class for specifying a maximum number of iterations.
This implementation of the Belos::StatusTest base class tests the number of iterations performed against a maximum number allowed.
Definition at line 63 of file BelosStatusTestMaxIters.hpp.
Belos::StatusTestMaxIters< ScalarType, MV, OP >::StatusTestMaxIters | ( | int | maxIters | ) |
Constructor.
Definition at line 153 of file BelosStatusTestMaxIters.hpp.
|
inlinevirtual |
Destructor.
Definition at line 74 of file BelosStatusTestMaxIters.hpp.
|
virtual |
Check convergence status of the iterative solver: Unconverged, Converged, Failed.
This method checks to see if the convergence criteria are met using the current information from the iterative solver.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 165 of file BelosStatusTestMaxIters.hpp.
|
inlinevirtual |
Return the result of the most recent CheckStatus call.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 87 of file BelosStatusTestMaxIters.hpp.
|
virtual |
Resets the status test to the initial internal state.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 175 of file BelosStatusTestMaxIters.hpp.
|
inline |
Sets the maximum number of iterations allowed.
Definition at line 98 of file BelosStatusTestMaxIters.hpp.
|
inline |
Returns the maximum number of iterations set in the constructor.
Definition at line 106 of file BelosStatusTestMaxIters.hpp.
|
inline |
Returns the current number of iterations from the most recent StatusTest call.
Definition at line 109 of file BelosStatusTestMaxIters.hpp.
|
virtual |
Output formatted description of stopping test to output stream.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 182 of file BelosStatusTestMaxIters.hpp.
|
virtual |
Print message for each status specific to this stopping test.
Reimplemented from Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 195 of file BelosStatusTestMaxIters.hpp.
|
inline |
Method to return description of the maximum iteration status test
Definition at line 128 of file BelosStatusTestMaxIters.hpp.
|
private |
Maximum number of iterations allowed.
Definition at line 141 of file BelosStatusTestMaxIters.hpp.
|
private |
Current number of iterations.
Definition at line 144 of file BelosStatusTestMaxIters.hpp.
|
private |
Status.
Definition at line 147 of file BelosStatusTestMaxIters.hpp.