This class implements the RCG iteration, where a single-std::vector Krylov subspace is constructed.
More...
#include <BelosRCGIter.hpp>
|
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_ |
|
|
| 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...
|
|
|
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...
|
|
|
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...
|
|
template<class ScalarType, class MV, class OP>
class Belos::RCGIter< ScalarType, MV, OP >
This class implements the RCG iteration, where a single-std::vector Krylov subspace is constructed.
- Author
- Michael Parks and Heidi Thornquist
Definition at line 196 of file BelosRCGIter.hpp.
◆ MVT
template<class ScalarType , class MV , class OP >
◆ OPT
template<class ScalarType , class MV , class OP >
◆ SCT
template<class ScalarType , class MV , class OP >
◆ MagnitudeType
template<class ScalarType , class MV , class OP >
◆ RCGIter()
template<class ScalarType , class MV , class OP >
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:
- "Num Blocks" - an
int
specifying the maximum number of blocks allocated for the solver basis. Default: 25
- "Restart Timers" = a
bool
specifying whether the timers should be restarted each time iterate() is called. Default: false
Definition at line 412 of file BelosRCGIter.hpp.
◆ ~RCGIter()
template<class ScalarType , class MV , class OP >
◆ iterate()
template<class ScalarType , class MV , class OP >
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 541 of file BelosRCGIter.hpp.
◆ initialize() [1/2]
template<class ScalarType , class MV , class OP >
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.
- Postcondition
- isInitialized() ==
true
(see post-conditions of isInitialize())
- Note
- For any pointer in
newstate
which directly points to the multivectors in the solver, the data is not copied.
Definition at line 457 of file BelosRCGIter.hpp.
◆ initialize() [2/2]
template<class ScalarType , class MV , class OP >
◆ getNumIters()
template<class ScalarType , class MV , class OP >
◆ resetNumIters()
template<class ScalarType , class MV , class OP >
void Belos::RCGIter< ScalarType, MV, OP >::resetNumIters |
( |
int |
iter = 0 | ) |
|
|
inlinevirtual |
◆ getNativeResiduals()
template<class ScalarType , class MV , class OP >
Get the norms of the residuals native to the solver.
- Returns
- A std::vector of length blockSize containing the native residuals.
Definition at line 283 of file BelosRCGIter.hpp.
◆ getCurrentUpdate()
template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::RCGIter< ScalarType, MV, OP >::getCurrentUpdate |
( |
| ) |
const |
|
inlinevirtual |
Get the current update to the linear system.
- Note
- Some solvers, like GMRES, do not compute updates to the solution every iteration. This method forces its computation. Other solvers, like CG and RCG update the solution each iteration, so this method will return a zero std::vector indicating that the linear problem contains the current solution.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 291 of file BelosRCGIter.hpp.
◆ getCurSubspaceDim()
template<class ScalarType , class MV , class OP >
Get the dimension of the search subspace used to generate the current solution to the linear problem.
Definition at line 294 of file BelosRCGIter.hpp.
◆ getMaxSubspaceDim()
template<class ScalarType , class MV , class OP >
Get the maximum dimension allocated for the search subspace.
Definition at line 300 of file BelosRCGIter.hpp.
◆ getProblem()
template<class ScalarType , class MV , class OP >
◆ getNumBlocks()
template<class ScalarType , class MV , class OP >
Get the maximum number of blocks used by the iterative solver in solving this linear problem.
Definition at line 312 of file BelosRCGIter.hpp.
◆ setNumBlocks()
template<class ScalarType , class MV , class OP >
void Belos::RCGIter< ScalarType, MV, OP >::setNumBlocks |
( |
int |
numBlocks | ) |
|
|
inline |
Set the maximum number of blocks used by the iterative solver.
Definition at line 315 of file BelosRCGIter.hpp.
◆ getRecycledBlocks()
template<class ScalarType , class MV , class OP >
Get the maximum number of recycled blocks used by the iterative solver in solving this linear problem.
Definition at line 318 of file BelosRCGIter.hpp.
◆ setRecycledBlocks()
template<class ScalarType , class MV , class OP >
void Belos::RCGIter< ScalarType, MV, OP >::setRecycledBlocks |
( |
int |
recycleBlocks | ) |
|
|
inline |
Set the maximum number of recycled blocks used by the iterative solver.
Definition at line 321 of file BelosRCGIter.hpp.
◆ getBlockSize()
template<class ScalarType , class MV , class OP >
◆ setBlockSize()
template<class ScalarType , class MV , class OP >
void Belos::RCGIter< ScalarType, MV, OP >::setBlockSize |
( |
int |
blockSize | ) |
|
|
inlinevirtual |
◆ setSize()
template<class ScalarType , class MV , class OP >
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 442 of file BelosRCGIter.hpp.
◆ isInitialized()
template<class ScalarType , class MV , class OP >
◆ lp_
template<class ScalarType , class MV , class OP >
◆ om_
template<class ScalarType , class MV , class OP >
◆ stest_
template<class ScalarType , class MV , class OP >
◆ numBlocks_
template<class ScalarType , class MV , class OP >
◆ recycleBlocks_
template<class ScalarType , class MV , class OP >
◆ initialized_
template<class ScalarType , class MV , class OP >
◆ curDim_
template<class ScalarType , class MV , class OP >
◆ iter_
template<class ScalarType , class MV , class OP >
◆ P_
template<class ScalarType , class MV , class OP >
◆ Ap_
template<class ScalarType , class MV , class OP >
◆ r_
template<class ScalarType , class MV , class OP >
◆ z_
template<class ScalarType , class MV , class OP >
◆ existU_
template<class ScalarType , class MV , class OP >
◆ U_
template<class ScalarType , class MV , class OP >
◆ AU_
template<class ScalarType , class MV , class OP >
◆ Alpha_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::Alpha_ |
|
private |
◆ Beta_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::Beta_ |
|
private |
◆ D_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::D_ |
|
private |
◆ Delta_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::Delta_ |
|
private |
◆ LUUTAU_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::LUUTAU_ |
|
private |
◆ ipiv_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<std::vector<int> > Belos::RCGIter< ScalarType, MV, OP >::ipiv_ |
|
private |
◆ rTz_old_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::rTz_old_ |
|
private |
The documentation for this class was generated from the following file: