Belos Package Browser (Single Doxygen Collection)
Development
|
#include <BelosCGIteration.hpp>
Public Member Functions | |
virtual void | setDoCondEst (bool val)=0 |
Sets whether or not to store the diagonal for condition estimation. More... | |
virtual Teuchos::ArrayView < typename Teuchos::ScalarTraits < ScalarType >::magnitudeType > | getDiag ()=0 |
Gets the diagonal for condition estimation. More... | |
virtual Teuchos::ArrayView < typename Teuchos::ScalarTraits < ScalarType >::magnitudeType > | getOffDiag ()=0 |
Gets the off-diagonal for condition estimation. More... | |
Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP > | |
Iteration () | |
Default Constructor. More... | |
virtual | ~Iteration () |
Destructor. More... | |
virtual void | iterate ()=0 |
This method performs linear solver iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More... | |
virtual void | initialize ()=0 |
Initialize the solver with the initial vectors from the linear problem or random data. More... | |
virtual int | getNumIters () const =0 |
Get the current iteration count. More... | |
virtual void | resetNumIters (int iter=0)=0 |
Reset the iteration count to iter. 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... | |
virtual Teuchos::RCP< MV > | getCurrentUpdate () const =0 |
Get the current update to the linear system. More... | |
virtual const LinearProblem < ScalarType, MV, OP > & | getProblem () const =0 |
Get a constant reference to the linear problem. More... | |
virtual int | getBlockSize () const =0 |
Get the blocksize to be used by the iterative solver in solving this linear problem. More... | |
virtual void | setBlockSize (int blockSize)=0 |
Set the blocksize to be used by the iterative solver in solving this linear problem. More... | |
virtual bool | isInitialized ()=0 |
States whether the solver has been initialized or not. More... | |
State methods | |
virtual void | initializeCG (CGIterationState< ScalarType, MV > &newstate)=0 |
Initialize the solver to an iterate, providing a complete state. More... | |
virtual CGIterationState < ScalarType, MV > | getState () const =0 |
Get the current state of the linear solver. More... | |
Definition at line 111 of file BelosCGIteration.hpp.
|
pure virtual |
Initialize the solver to an iterate, providing a complete state.
The CGIteration 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. Implemented in Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, and Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >.
|
pure virtual |
Get the current state of the linear solver.
The data is only valid if isInitialized() == true
.
Implemented in Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, and Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >.
|
pure virtual |
Sets whether or not to store the diagonal for condition estimation.
Implemented in Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, and Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >.
|
pure virtual |
Gets the diagonal for condition estimation.
Implemented in Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, and Belos::CGSingleRedIter< ScalarType, MV, OP >.
|
pure virtual |
Gets the off-diagonal for condition estimation.
Implemented in Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, and Belos::CGSingleRedIter< ScalarType, MV, OP >.