#include <Belos_PseudoBlockGmresIter_MP_Vector.hpp>
Inherits Iteration< Sacado::MP::Vector< Storage >, MV, OP >.
|
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 | numRHS_ |
|
int | numBlocks_ |
|
Mask< MagnitudeType > | lucky_breakdown_ |
|
std::vector< Teuchos::RCP< Teuchos::SerialDenseVector< int, ScalarType > > > | sn_ |
|
std::vector< Teuchos::RCP< Teuchos::SerialDenseVector< int, MagnitudeType > > > | cs_ |
|
Teuchos::RCP< MV > | U_vec_ |
|
Teuchos::RCP< MV > | AU_vec_ |
|
Teuchos::RCP< MV > | cur_block_rhs_ |
|
Teuchos::RCP< MV > | cur_block_sol_ |
|
bool | initialized_ |
|
int | curDim_ |
|
int | iter_ |
|
std::vector< Teuchos::RCP< MV > > | V_ |
|
std::vector< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > | H_ |
|
std::vector< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > | R_ |
|
std::vector< Teuchos::RCP< Teuchos::SerialDenseVector< int, ScalarType > > > | Z_ |
|
SVT::magnitudeType | breakDownTol_ |
|
|
| PseudoBlockGmresIter (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) |
| PseudoBlockGmresIter constructor with linear problem, solver utilities, and parameter list of solver options. More...
|
|
virtual | ~PseudoBlockGmresIter ()=default |
| Destructor. More...
|
|
|
void | iterate () |
| This method performs block Gmres 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 (const PseudoBlockGmresIterState< 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...
|
|
PseudoBlockGmresIterState< ScalarType, MV > | getState () const |
| Get the current state of the linear solver. More...
|
|
|
const LinearProblem< ScalarType, MV, OP > & | getProblem () const |
| Get a constant reference to the linear problem. 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...
|
|
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...
|
|
bool | isInitialized () |
| States whether the solver has been initialized or not. More...
|
|
template<class Storage, class MV, class OP>
class Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >
Definition at line 72 of file Belos_PseudoBlockGmresIter_MP_Vector.hpp.
◆ ScalarType
template<class Storage , class MV , class OP >
◆ MVT
template<class Storage , class MV , class OP >
◆ OPT
template<class Storage , class MV , class OP >
◆ SCT
template<class Storage , class MV , class OP >
◆ MagnitudeType
template<class Storage , class MV , class OP >
◆ SVT
template<class Storage , class MV , class OP >
◆ PseudoBlockGmresIter()
template<class Storage , class MV , class OP >
Belos::PseudoBlockGmresIter< Sacado::MP::Vector< Storage >, MV, OP >::PseudoBlockGmresIter |
( |
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 |
|
) |
| |
PseudoBlockGmresIter 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:
- "Block Size" - an
int
specifying the block size used by the algorithm. This can also be specified using the setBlockSize() method. Default: 1
- "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
◆ ~PseudoBlockGmresIter()
template<class Storage , class MV , class OP >
◆ iterate()
template<class Storage , class MV , class OP >
This method performs block Gmres 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 inintialized; if not, it will call initialize() using default arguments. After initialization, the solver performs block Gmres iterations until the status test evaluates as ::Passed, at which point the method returns to the caller.
The block Gmres iteration proceeds as follows:
- The operator problem->applyOp() is applied to the newest
blockSize
vectors in the Krylov basis.
- The resulting vectors are orthogonalized against the previous basis vectors, and made orthonormal.
- The Hessenberg matrix is updated.
- The least squares system is updated.
The status test is queried at the beginning of the iteration.
Possible exceptions thrown include the PseudoBlockGmresIterOrthoFailure.
◆ initialize() [1/2]
template<class Storage , class MV , class OP >
Initialize the solver to an iterate, providing a complete state.
The PseudoBlockGmresIter contains a certain amount of state, consisting of the current Krylov basis and the associated Hessenberg matrix.
initialize() gives the user the opportunity to manually set these, although this must be done with caution, abiding by the rules given below. All notions of orthogonality and orthonormality are derived from the inner product specified by the orthogonalization manager.
- Postcondition
- isInitialized() ==
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.
- Note
- For any pointer in
newstate
which directly points to the multivectors in the solver, the data is not copied.
◆ initialize() [2/2]
template<class Storage , class MV , class OP >
◆ getState()
template<class Storage , class MV , class OP >
◆ getNumIters()
template<class Storage , class MV , class OP >
◆ resetNumIters()
template<class Storage , class MV , class OP >
◆ getNativeResiduals()
template<class Storage , class MV , class OP >
Get the norms of the "native" residual vectors.
If norms != NULL, fill *norms with the native residual norms. There are numRHS_ of them. *norms will be resized if it has too few entries to hold the data.
For an explanation of "native" vs. "exact" (also known as "implicit" vs. "explicit") residuals, see the documentation of PseudoBlockGmresSolMgr::isLOADetected()
. In brief: "Native" residuals are cheaper to compute than "exact" residuals, but the two may differ, especially when using a left preconditioner.
- Returns
- Teuchos::null (always, regardless whether norms == NULL). We only return something in order to satisfy the Iteration interface.
PseudoBlockGmresSolMgr
knows that this method always returns null.
◆ getCurrentUpdate()
template<class Storage , class MV , class OP >
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, update the solution each iteration, so this method will return a zero vector indicating that the linear problem contains the current solution.
◆ updateLSQR()
template<class Storage , class MV , class OP >
Method for updating QR factorization of upper Hessenberg matrix.
- Note
- If
dim
>= getCurSubspaceDim()
and dim
< getMaxSubspaceDim()
, then the dim-th
equations of the least squares problem will be updated.
◆ getCurSubspaceDim()
template<class Storage , class MV , class OP >
◆ getMaxSubspaceDim()
template<class Storage , class MV , class OP >
◆ getProblem()
template<class Storage , class MV , class OP >
◆ getBlockSize()
template<class Storage , class MV , class OP >
◆ setBlockSize()
template<class Storage , class MV , class OP >
◆ getNumBlocks()
template<class Storage , class MV , class OP >
◆ setNumBlocks()
template<class Storage , class MV , class OP >
Set the maximum number of blocks used by the iterative solver.
◆ isInitialized()
template<class Storage , class MV , class OP >
◆ lp_
template<class Storage , class MV , class OP >
◆ om_
template<class Storage , class MV , class OP >
◆ stest_
template<class Storage , class MV , class OP >
◆ ortho_
template<class Storage , class MV , class OP >
◆ numRHS_
template<class Storage , class MV , class OP >
◆ numBlocks_
template<class Storage , class MV , class OP >
◆ lucky_breakdown_
template<class Storage , class MV , class OP >
◆ sn_
template<class Storage , class MV , class OP >
◆ cs_
template<class Storage , class MV , class OP >
◆ U_vec_
template<class Storage , class MV , class OP >
◆ AU_vec_
template<class Storage , class MV , class OP >
◆ cur_block_rhs_
template<class Storage , class MV , class OP >
◆ cur_block_sol_
template<class Storage , class MV , class OP >
◆ initialized_
template<class Storage , class MV , class OP >
◆ curDim_
template<class Storage , class MV , class OP >
◆ iter_
template<class Storage , class MV , class OP >
◆ V_
template<class Storage , class MV , class OP >
◆ H_
template<class Storage , class MV , class OP >
◆ R_
template<class Storage , class MV , class OP >
◆ Z_
template<class Storage , class MV , class OP >
◆ breakDownTol_
template<class Storage , class MV , class OP >
The documentation for this class was generated from the following file: