Belos
Version of the Day
|
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 |
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. 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 > *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 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... | |
State methods | |
![]() | |
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 161 of file BelosBlockCGIter.hpp.
typedef MultiVecTraits<ScalarType,MV> Belos::BlockCGIter< ScalarType, MV, OP, true >::MVT |
Definition at line 168 of file BelosBlockCGIter.hpp.
typedef OperatorTraits<ScalarType,MV,OP> Belos::BlockCGIter< ScalarType, MV, OP, true >::OPT |
Definition at line 169 of file BelosBlockCGIter.hpp.
typedef Teuchos::ScalarTraits<ScalarType> Belos::BlockCGIter< ScalarType, MV, OP, true >::SCT |
Definition at line 170 of file BelosBlockCGIter.hpp.
typedef SCT::magnitudeType Belos::BlockCGIter< ScalarType, MV, OP, true >::MagnitudeType |
Definition at line 171 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 346 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Destructor.
Definition at line 188 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 486 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 421 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 228 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 240 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 256 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 259 of file BelosBlockCGIter.hpp.
|
inline |
Get the norms of the residuals native to the solver.
Definition at line 263 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 268 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 276 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 279 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 400 of file BelosBlockCGIter.hpp.
|
inlinevirtual |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 285 of file BelosBlockCGIter.hpp.