Belos Package Browser (Single Doxygen Collection)
Development
|
This class implements the RCG iteration, where a single-std::vector Krylov subspace is constructed. More...
#include <BelosRCGIter.hpp>
Public Types | |
typedef MultiVecTraits < ScalarType, MV > | MVT |
typedef OperatorTraits < ScalarType, MV, OP > | OPT |
typedef Teuchos::ScalarTraits < ScalarType > | SCT |
typedef SCT::magnitudeType | MagnitudeType |
Private Attributes | |
const Teuchos::RCP < LinearProblem< ScalarType, MV, OP > > | lp_ |
const Teuchos::RCP < OutputManager< ScalarType > > | om_ |
const Teuchos::RCP< StatusTest < ScalarType, MV, OP > > | stest_ |
int | numBlocks_ |
int | recycleBlocks_ |
bool | initialized_ |
int | curDim_ |
int | iter_ |
Teuchos::RCP< MV > | P_ |
Teuchos::RCP< MV > | Ap_ |
Teuchos::RCP< MV > | r_ |
Teuchos::RCP< MV > | z_ |
bool | existU_ |
Teuchos::RCP< MV > | U_ |
Teuchos::RCP< MV > | AU_ |
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > > | Alpha_ |
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > > | Beta_ |
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > > | D_ |
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > > | Delta_ |
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > > | LUUTAU_ |
Teuchos::RCP< std::vector< int > > | ipiv_ |
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > > | rTz_old_ |
Constructors/Destructor | |
RCGIter (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) | |
RCGIter constructor with linear problem, solver utilities, and parameter list of solver options. More... | |
virtual | ~RCGIter () |
Destructor. More... | |
Solver methods | |
void | iterate () |
This method performs RCG iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More... | |
void | initialize (RCGIterState< 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... | |
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... | |
int | getCurSubspaceDim () const |
Get the dimension of the search subspace used to generate the current solution to the linear problem. More... | |
int | getMaxSubspaceDim () const |
Get the maximum dimension allocated for the search subspace. More... | |
Accessor methods | |
const LinearProblem < ScalarType, MV, OP > & | getProblem () const |
Get a constant reference to the linear problem. More... | |
int | getNumBlocks () const |
Get the maximum number of blocks used by the iterative solver in solving this linear problem. More... | |
void | setNumBlocks (int numBlocks) |
Set the maximum number of blocks used by the iterative solver. More... | |
int | getRecycledBlocks () const |
Get the maximum number of recycled blocks used by the iterative solver in solving this linear problem. More... | |
void | setRecycledBlocks (int recycleBlocks) |
Set the maximum number of recycled blocks used by the iterative solver. More... | |
int | getBlockSize () const |
Get the blocksize to be used by the iterative solver in solving this linear problem. More... | |
void | setBlockSize (int blockSize) |
Set the blocksize. More... | |
void | setSize (int recycleBlocks, int numBlocks) |
Set the maximum number of blocks used by the iterative solver and the number of recycled vectors. More... | |
bool | isInitialized () |
States whether the solver has been initialized or not. More... | |
This class implements the RCG iteration, where a single-std::vector Krylov subspace is constructed.
Definition at line 145 of file BelosRCGIter.hpp.
typedef MultiVecTraits<ScalarType,MV> Belos::RCGIter< ScalarType, MV, OP >::MVT |
Definition at line 152 of file BelosRCGIter.hpp.
typedef OperatorTraits<ScalarType,MV,OP> Belos::RCGIter< ScalarType, MV, OP >::OPT |
Definition at line 153 of file BelosRCGIter.hpp.
typedef Teuchos::ScalarTraits<ScalarType> Belos::RCGIter< ScalarType, MV, OP >::SCT |
Definition at line 154 of file BelosRCGIter.hpp.
typedef SCT::magnitudeType Belos::RCGIter< ScalarType, MV, OP >::MagnitudeType |
Definition at line 155 of file BelosRCGIter.hpp.
Belos::RCGIter< ScalarType, MV, OP >::RCGIter | ( | 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 | ||
) |
RCGIter 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. These options include the following:
int
specifying the maximum number of blocks allocated for the solver basis. Default: 25bool
specifying whether the timers should be restarted each time iterate() is called. Default: false Definition at line 361 of file BelosRCGIter.hpp.
|
inlinevirtual |
Destructor.
Definition at line 173 of file BelosRCGIter.hpp.
|
virtual |
This method performs RCG 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 RCG 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 490 of file BelosRCGIter.hpp.
void Belos::RCGIter< ScalarType, MV, OP >::initialize | ( | RCGIterState< ScalarType, MV > & | newstate | ) |
Initialize the solver to an iterate, providing a complete state.
The RCGIter 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. Definition at line 406 of file BelosRCGIter.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 213 of file BelosRCGIter.hpp.
|
inlinevirtual |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 225 of file BelosRCGIter.hpp.
|
inlinevirtual |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 228 of file BelosRCGIter.hpp.
|
inline |
Get the norms of the residuals native to the solver.
Definition at line 232 of file BelosRCGIter.hpp.
|
inlinevirtual |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 240 of file BelosRCGIter.hpp.
|
inline |
Get the dimension of the search subspace used to generate the current solution to the linear problem.
Definition at line 243 of file BelosRCGIter.hpp.
|
inline |
Get the maximum dimension allocated for the search subspace.
Definition at line 249 of file BelosRCGIter.hpp.
|
inlinevirtual |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 258 of file BelosRCGIter.hpp.
|
inline |
Get the maximum number of blocks used by the iterative solver in solving this linear problem.
Definition at line 261 of file BelosRCGIter.hpp.
|
inline |
Set the maximum number of blocks used by the iterative solver.
Definition at line 264 of file BelosRCGIter.hpp.
|
inline |
Get the maximum number of recycled blocks used by the iterative solver in solving this linear problem.
Definition at line 267 of file BelosRCGIter.hpp.
|
inline |
Set the maximum number of recycled blocks used by the iterative solver.
Definition at line 270 of file BelosRCGIter.hpp.
|
inlinevirtual |
Get the blocksize to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 273 of file BelosRCGIter.hpp.
|
inlinevirtual |
Set the blocksize.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 276 of file BelosRCGIter.hpp.
void Belos::RCGIter< ScalarType, MV, OP >::setSize | ( | int | recycleBlocks, |
int | numBlocks | ||
) |
Set the maximum number of blocks used by the iterative solver and the number of recycled vectors.
Definition at line 391 of file BelosRCGIter.hpp.
|
inlinevirtual |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 285 of file BelosRCGIter.hpp.
|
private |
Definition at line 298 of file BelosRCGIter.hpp.
|
private |
Definition at line 299 of file BelosRCGIter.hpp.
|
private |
Definition at line 300 of file BelosRCGIter.hpp.
|
private |
Definition at line 306 of file BelosRCGIter.hpp.
|
private |
Definition at line 309 of file BelosRCGIter.hpp.
|
private |
Definition at line 317 of file BelosRCGIter.hpp.
|
private |
Definition at line 320 of file BelosRCGIter.hpp.
|
private |
Definition at line 320 of file BelosRCGIter.hpp.
|
private |
Definition at line 326 of file BelosRCGIter.hpp.
|
private |
Definition at line 329 of file BelosRCGIter.hpp.
|
private |
Definition at line 332 of file BelosRCGIter.hpp.
|
private |
Definition at line 335 of file BelosRCGIter.hpp.
|
private |
Definition at line 338 of file BelosRCGIter.hpp.
|
private |
Definition at line 340 of file BelosRCGIter.hpp.
|
private |
Definition at line 340 of file BelosRCGIter.hpp.
|
private |
Definition at line 343 of file BelosRCGIter.hpp.
|
private |
Definition at line 343 of file BelosRCGIter.hpp.
|
private |
Definition at line 343 of file BelosRCGIter.hpp.
|
private |
Definition at line 346 of file BelosRCGIter.hpp.
|
private |
Definition at line 349 of file BelosRCGIter.hpp.
|
private |
Definition at line 352 of file BelosRCGIter.hpp.
|
private |
Definition at line 355 of file BelosRCGIter.hpp.