|
Belos Package Browser (Single Doxygen Collection)
Development
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Belos Package Browser (Single Doxygen Collection)
Development
|
Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation. More...
#include <BelosBlockCGIter.hpp>
Public Types | |
| typedef MultiVecTraits < ScalarType, MV > | MVT |
| typedef OperatorTraits < ScalarType, MV, OP > | OPT |
| typedef Teuchos::ScalarTraits < ScalarType > | SCT |
| typedef SCT::magnitudeType | MagnitudeType |
Private Member Functions | |
| void | setStateSize () |
| Method for initalizing the state storage needed by block CG. More... | |
Private Attributes | |
| const Teuchos::RCP < LinearProblem< ScalarType, MV, OP > > | lp_ |
| const Teuchos::RCP < OutputManager< ScalarType > > | om_ |
| const Teuchos::RCP< StatusTest < ScalarType, MV, OP > > | stest_ |
| const Teuchos::RCP < OrthoManager< ScalarType, MV > > | ortho_ |
| int | blockSize_ |
| bool | initialized_ |
| bool | stateStorageInitialized_ |
| int | iter_ |
| Teuchos::RCP< MV > | R_ |
| Teuchos::RCP< MV > | Z_ |
| Teuchos::RCP< MV > | P_ |
| Teuchos::RCP< MV > | AP_ |
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. More... | |
| virtual | ~BlockCGIter () |
| Destructor. More... | |
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). 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 > *) 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 block size to be used by the iterative solver in solving this linear problem. More... | |
| void | setBlockSize (int blockSize) |
| Set the block size 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) |
| Sets whether or not to store the diagonal for condition estimation. More... | |
| Teuchos::ArrayView< MagnitudeType > | getDiag () |
| Gets the diagonal for condition estimation (NOT_IMPLEMENTED) More... | |
| Teuchos::ArrayView< MagnitudeType > | getOffDiag () |
| Gets the off-diagonal for condition estimation (NOT_IMPLEMENTED) More... | |
Additional Inherited Members | |
 Public Member Functions inherited from Belos::CGIteration< ScalarType, MV, OP > | |
| 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... | |
Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation.
This is the (non-stub) actual implementation of BlockCGIter.
Definition at line 166 of file BelosBlockCGIter.hpp.
| typedef MultiVecTraits<ScalarType,MV> Belos::BlockCGIter< ScalarType, MV, OP, true >::MVT |
Definition at line 173 of file BelosBlockCGIter.hpp.
| typedef OperatorTraits<ScalarType,MV,OP> Belos::BlockCGIter< ScalarType, MV, OP, true >::OPT |
Definition at line 174 of file BelosBlockCGIter.hpp.
| typedef Teuchos::ScalarTraits<ScalarType> Belos::BlockCGIter< ScalarType, MV, OP, true >::SCT |
Definition at line 175 of file BelosBlockCGIter.hpp.
| typedef SCT::magnitudeType Belos::BlockCGIter< ScalarType, MV, OP, true >::MagnitudeType |
Definition at line 176 of file BelosBlockCGIter.hpp.
| Belos::BlockCGIter< ScalarType, MV, OP, true >::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 365 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Destructor.
Definition at line 193 of file BelosBlockCGIter.hpp.
|
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 504 of file BelosBlockCGIter.hpp.
|
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 440 of file BelosBlockCGIter.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 233 of file BelosBlockCGIter.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 245 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 261 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 264 of file BelosBlockCGIter.hpp.
|
inline |
Get the norms of the residuals native to the solver.
Definition at line 268 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 273 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 281 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Get the block size to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 284 of file BelosBlockCGIter.hpp.
|
virtual |
Set the block size to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 419 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 290 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Sets whether or not to store the diagonal for condition estimation.
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 293 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Gets the diagonal for condition estimation (NOT_IMPLEMENTED)
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 296 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Gets the off-diagonal for condition estimation (NOT_IMPLEMENTED)
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 302 of file BelosBlockCGIter.hpp.
|
private |
Method for initalizing the state storage needed by block CG.
Definition at line 385 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 319 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 320 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 321 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 322 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 328 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 336 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 341 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 344 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 350 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 353 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 356 of file BelosBlockCGIter.hpp.
|
private |
Definition at line 359 of file BelosBlockCGIter.hpp.
1.8.5