|
Belos
Version of the Day
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Belos
Version of the Day
|
This class implements the preconditioned Conjugate Gradient (CG) iteration. More...
#include <BelosCGIter.hpp>
Public Types | |
| typedef MultiVecTraits < ScalarType, MV > | MVT |
| typedef OperatorTraits < ScalarType, MV, OP > | OPT |
| typedef Teuchos::ScalarTraits < ScalarType > | SCT |
| typedef SCT::magnitudeType | MagnitudeType |
Public Member Functions | |
Constructors/Destructor | |
| CGIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, const Teuchos::RCP< StatusTestGenResNorm< ScalarType, MV, OP > > &convTester, Teuchos::ParameterList ¶ms) | |
| CGIter constructor with linear problem, solver utilities, and parameter list of solver options. More... | |
| virtual | ~CGIter () |
| Destructor. More... | |
Solver methods | |
| void | iterate () |
| This method performs CG iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More... | |
| void | initializeCG (CGIterationState< ScalarType, MV > &newstate) |
| Initialize the solver to an iterate, providing a complete state. More... | |
| void | initialize () |
| Initialize the solver with the initial vectors from the linear problem or random data. More... | |
| CGIterationState< ScalarType, MV > | getState () const |
| Get the current state of the linear solver. More... | |
Status methods | |
| int | getNumIters () const |
| Get the current iteration count. More... | |
| void | resetNumIters (int iter=0) |
| Reset the iteration count. More... | |
| Teuchos::RCP< const MV > | getNativeResiduals (std::vector< MagnitudeType > *norms) const |
| Get the norms of the residuals native to the solver. More... | |
| Teuchos::RCP< MV > | getCurrentUpdate () const |
| Get the current update to the linear system. More... | |
Accessor methods | |
| const LinearProblem < ScalarType, MV, OP > & | getProblem () const |
| Get a constant reference to the linear problem. More... | |
| int | getBlockSize () const |
| Get the blocksize to be used by the iterative solver in solving this linear problem. More... | |
| void | setBlockSize (int blockSize) |
| Set the blocksize to be used by the iterative solver in solving this linear problem. More... | |
| bool | isInitialized () |
| States whether the solver has been initialized or not. More... | |
| void | setDoCondEst (bool val) |
| Sets whether or not to store the diagonal for condition estimation. More... | |
| Teuchos::ArrayView< MagnitudeType > | getDiag () |
| Gets the diagonal for condition estimation. More... | |
| Teuchos::ArrayView< MagnitudeType > | getOffDiag () |
| Gets the off-diagonal for condition estimation. More... | |
State methods | |
 Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP > | |
| Iteration () | |
| Default Constructor. More... | |
| virtual | ~Iteration () |
| Destructor. More... | |
| virtual Teuchos::RCP< const MV > | getNativeResiduals (std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > *norms) const =0 |
| Get the residuals native to the solver. More... | |
This class implements the preconditioned Conjugate Gradient (CG) iteration.
Definition at line 47 of file BelosCGIter.hpp.
| typedef MultiVecTraits<ScalarType,MV> Belos::CGIter< ScalarType, MV, OP >::MVT |
Definition at line 54 of file BelosCGIter.hpp.
| typedef OperatorTraits<ScalarType,MV,OP> Belos::CGIter< ScalarType, MV, OP >::OPT |
Definition at line 55 of file BelosCGIter.hpp.
| typedef Teuchos::ScalarTraits<ScalarType> Belos::CGIter< ScalarType, MV, OP >::SCT |
Definition at line 56 of file BelosCGIter.hpp.
| typedef SCT::magnitudeType Belos::CGIter< ScalarType, MV, OP >::MagnitudeType |
Definition at line 57 of file BelosCGIter.hpp.
| Belos::CGIter< ScalarType, MV, OP >::CGIter | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
| const Teuchos::RCP< OutputManager< ScalarType > > & | printer, | ||
| const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | tester, | ||
| const Teuchos::RCP< StatusTestGenResNorm< ScalarType, MV, OP > > & | convTester, | ||
| Teuchos::ParameterList & | params | ||
| ) |
CGIter constructor with linear problem, solver utilities, and parameter list of solver options.
This constructor takes pointers required by the linear solver iteration, in addition to a parameter list of options for the linear solver.
Definition at line 288 of file BelosCGIter.hpp.
|
inlinevirtual |
Destructor.
Definition at line 74 of file BelosCGIter.hpp.
|
virtual |
This method performs CG iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).
iterate() will first determine whether the solver is initialized; if not, it will call initialize() using default arguments. After initialization, the solver performs CG iterations until the status test evaluates as Passed, at which point the method returns to the caller.
The status test is queried at the beginning of the iteration.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 415 of file BelosCGIter.hpp.
|
virtual |
Initialize the solver to an iterate, providing a complete state.
The CGIter contains a certain amount of state, consisting of the current residual, preconditioned residual, and decent direction.
initialize() gives the user the opportunity to manually set these, although only the current unpreconditioned residual is required.
true (see post-conditions of isInitialize())newstate which directly points to the multivectors in the solver, the data is not copied. Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 357 of file BelosCGIter.hpp.
|
inlinevirtual |
Initialize the solver with the initial vectors from the linear problem or random data.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 114 of file BelosCGIter.hpp.
|
inlinevirtual |
Get the current state of the linear solver.
The data is only valid if isInitialized() == true.
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 126 of file BelosCGIter.hpp.
|
inlinevirtual |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 142 of file BelosCGIter.hpp.
|
inlinevirtual |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 145 of file BelosCGIter.hpp.
|
inline |
Get the norms of the residuals native to the solver.
Definition at line 149 of file BelosCGIter.hpp.
|
inlinevirtual |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 160 of file BelosCGIter.hpp.
|
inlinevirtual |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 168 of file BelosCGIter.hpp.
|
inlinevirtual |
Get the blocksize to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 171 of file BelosCGIter.hpp.
|
inlinevirtual |
Set the blocksize to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 174 of file BelosCGIter.hpp.
|
inlinevirtual |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 180 of file BelosCGIter.hpp.
|
inlinevirtual |
Sets whether or not to store the diagonal for condition estimation.
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 184 of file BelosCGIter.hpp.
|
inlinevirtual |
Gets the diagonal for condition estimation.
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 189 of file BelosCGIter.hpp.
|
inlinevirtual |
Gets the off-diagonal for condition estimation.
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 202 of file BelosCGIter.hpp.
1.8.5