Stokhos
Development
|
Public Types | |
typedef Sacado::MP::Vector < Storage > | ScalarType |
typedef MultiVecTraits < ScalarType, MV > | MVT |
typedef OperatorTraits < ScalarType, MV, OP > | OPT |
typedef Teuchos::ScalarTraits < ScalarType > | SCT |
typedef SCT::magnitudeType | MagnitudeType |
typedef Teuchos::ScalarTraits < typename Storage::value_type > | SVT |
Public Member Functions | |
void | setDoCondEst (bool val) |
Sets whether or not to store the diagonal for condition estimation. | |
Teuchos::ArrayView< MagnitudeType > | getDiag () |
Gets the diagonal for condition estimation. | |
Teuchos::ArrayView< MagnitudeType > | getOffDiag () |
Gets the off-diagonal for condition estimation. | |
Constructors/Destructor | |
PseudoBlockCGIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, Teuchos::ParameterList ¶ms) | |
PseudoBlockCGIter constructor with linear problem, solver utilities, and parameter list of solver options. More... | |
virtual | ~PseudoBlockCGIter () |
Destructor. | |
Solver methods | |
void | iterate () |
This method performs CG iterations on each linear system 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. | |
CGIterationState< ScalarType, MV > | getState () const |
Get the current state of the linear solver. More... | |
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 |
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. | |
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. | |
bool | isInitialized () |
States whether the solver has been initialized or not. | |
Belos::PseudoBlockCGIter< Sacado::MP::Vector< Storage >, MV, OP >::PseudoBlockCGIter | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< OutputManager< ScalarType > > & | printer, | ||
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | tester, | ||
Teuchos::ParameterList & | params | ||
) |
PseudoBlockCGIter constructor with linear problem, solver utilities, and parameter list of solver options.
This constructor takes pointers required by the linear solver, in addition to a parameter list of options for the linear solver.
|
inline |
Get the current update to the linear system.
|
inline |
Get the norms of the residuals native to the solver.
|
inline |
Get the current state of the linear solver.
The data is only valid if isInitialized() == true
.
void Belos::PseudoBlockCGIter< Sacado::MP::Vector< Storage >, MV, OP >::initializeCG | ( | CGIterationState< ScalarType, MV > & | newstate | ) |
Initialize the solver to an iterate, providing a complete state.
The PseudoBlockCGIter contains a certain amount of state, consisting of the current direction vectors and residuals.
initialize() gives the user the opportunity to manually set these, although this must be done with caution, abiding by the rules given below.
true
(see post-conditions of isInitialize())The user has the option of specifying any component of the state using initialize(). However, these arguments are assumed to match the post-conditions specified under isInitialized(). Any necessary component of the state not given to initialize() will be generated.
newstate
which directly points to the multivectors in the solver, the data is not copied. void Belos::PseudoBlockCGIter< Sacado::MP::Vector< Storage >, MV, OP >::iterate | ( | ) |
This method performs CG iterations on each linear system 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.