#include <BelosBlockCGIter.hpp>
Inheritance diagram for Belos::BlockCGIter< ScalarType, MV, OP >:
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 | |
| BlockCGIter (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< MatOrthoManager< ScalarType, MV, OP > > &ortho, Teuchos::ParameterList ¶ms) | |
| BlockCGIter constructor with linear problem, solver utilities, and parameter list of solver options. | |
| virtual | ~BlockCGIter () |
| Destructor. | |
Solver methods | |
| void | iterate () |
| This method performs BlockCG iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). | |
| void | initializeCG (CGIterationState< ScalarType, MV > newstate) |
| Initialize the solver to an iterate, providing a complete state. | |
| void | initialize () |
| Initialize the solver with the initial vectors from the linear problem or random data. | |
| CGIterationState< ScalarType, MV > | getState () const |
| Get the current state of the linear solver. | |
Status methods | |
| int | getNumIters () const |
| Get the current iteration count. | |
| void | resetNumIters (int iter=0) |
| Reset the iteration count. | |
| Teuchos::RCP< const MV > | getNativeResiduals (std::vector< MagnitudeType > *norms) const |
| Get the norms of the residuals native to the solver. | |
| Teuchos::RCP< MV > | getCurrentUpdate () const |
| Get the current update to the linear system. | |
Accessor methods | |
| const LinearProblem< ScalarType, MV, OP > & | getProblem () const |
| Get a constant reference to the linear problem. | |
| int | getBlockSize () const |
| Get the blocksize to be used by the iterative solver in solving this linear problem. | |
| void | setBlockSize (int blockSize) |
| Set the blocksize to be used by the iterative solver in solving this linear problem. | |
| bool | isInitialized () |
| States whether the solver has been initialized or not. | |
Definition at line 66 of file BelosBlockCGIter.hpp.
| typedef MultiVecTraits<ScalarType,MV> Belos::BlockCGIter< ScalarType, MV, OP >::MVT |
Definition at line 73 of file BelosBlockCGIter.hpp.
| typedef OperatorTraits<ScalarType,MV,OP> Belos::BlockCGIter< ScalarType, MV, OP >::OPT |
Definition at line 74 of file BelosBlockCGIter.hpp.
| typedef Teuchos::ScalarTraits<ScalarType> Belos::BlockCGIter< ScalarType, MV, OP >::SCT |
Definition at line 75 of file BelosBlockCGIter.hpp.
| typedef SCT::magnitudeType Belos::BlockCGIter< ScalarType, MV, OP >::MagnitudeType |
Definition at line 76 of file BelosBlockCGIter.hpp.
| Belos::BlockCGIter< ScalarType, MV, OP >::BlockCGIter | ( | 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< MatOrthoManager< ScalarType, MV, OP > > & | ortho, | |||
| Teuchos::ParameterList & | params | |||
| ) |
BlockCGIter 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 252 of file BelosBlockCGIter.hpp.
| virtual Belos::BlockCGIter< ScalarType, MV, OP >::~BlockCGIter | ( | ) | [inline, virtual] |
| void Belos::BlockCGIter< ScalarType, MV, OP >::iterate | ( | ) | [virtual] |
This method performs BlockCG 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 BlockCG 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 389 of file BelosBlockCGIter.hpp.
| void Belos::BlockCGIter< ScalarType, MV, OP >::initializeCG | ( | CGIterationState< ScalarType, MV > | newstate | ) | [virtual] |
Initialize the solver to an iterate, providing a complete state.
The BlockCGIter 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 335 of file BelosBlockCGIter.hpp.
| void Belos::BlockCGIter< ScalarType, MV, OP >::initialize | ( | ) | [inline, virtual] |
Initialize the solver with the initial vectors from the linear problem or random data.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 133 of file BelosBlockCGIter.hpp.
| CGIterationState<ScalarType,MV> Belos::BlockCGIter< ScalarType, MV, OP >::getState | ( | ) | const [inline, virtual] |
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 145 of file BelosBlockCGIter.hpp.
| int Belos::BlockCGIter< ScalarType, MV, OP >::getNumIters | ( | ) | const [inline, virtual] |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 161 of file BelosBlockCGIter.hpp.
| void Belos::BlockCGIter< ScalarType, MV, OP >::resetNumIters | ( | int | iter = 0 |
) | [inline, virtual] |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 164 of file BelosBlockCGIter.hpp.
| Teuchos::RCP<const MV> Belos::BlockCGIter< ScalarType, MV, OP >::getNativeResiduals | ( | std::vector< MagnitudeType > * | norms | ) | const [inline] |
Get the norms of the residuals native to the solver.
Definition at line 168 of file BelosBlockCGIter.hpp.
| Teuchos::RCP<MV> Belos::BlockCGIter< ScalarType, MV, OP >::getCurrentUpdate | ( | ) | const [inline, virtual] |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 173 of file BelosBlockCGIter.hpp.
| const LinearProblem<ScalarType,MV,OP>& Belos::BlockCGIter< ScalarType, MV, OP >::getProblem | ( | ) | const [inline, virtual] |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 181 of file BelosBlockCGIter.hpp.
| int Belos::BlockCGIter< ScalarType, MV, OP >::getBlockSize | ( | ) | const [inline, virtual] |
Get the blocksize to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 184 of file BelosBlockCGIter.hpp.
| void Belos::BlockCGIter< ScalarType, MV, OP >::setBlockSize | ( | int | blockSize | ) | [virtual] |
Set the blocksize to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 309 of file BelosBlockCGIter.hpp.
| bool Belos::BlockCGIter< ScalarType, MV, OP >::isInitialized | ( | ) | [inline, virtual] |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 190 of file BelosBlockCGIter.hpp.
1.4.7