Belos
Version of the Day
|
This class implements the preconditioned transpose-free QMR algorithm for solving non-Hermitian linear systems of equations Ax = b, where b is the right-hand side vector and x is the corresponding solution. More...
#include <BelosTFQMRIter.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 | |
Constructor/Destructor. | |
TFQMRIter (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) | |
Belos::TFQMRIter constructor. More... | |
virtual | ~TFQMRIter () |
Belos::TFQMRIter destructor. More... | |
Solver methods | |
void | iterate () |
This method performs block TFQMR iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More... | |
void | initializeTFQMR (const TFQMRIterState< 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... | |
TFQMRIterState< 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 blocksize to be used by the iterative solver in solving this linear problem. More... | |
void | setBlockSize (int blockSize) |
Set the blocksize. More... | |
bool | isInitialized () |
States whether the solver has been initialized or not. More... | |
![]() | |
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... | |
This class implements the preconditioned transpose-free QMR algorithm for solving non-Hermitian linear systems of equations Ax = b, where b is the right-hand side vector and x is the corresponding solution.
Definition at line 144 of file BelosTFQMRIter.hpp.
typedef MultiVecTraits<ScalarType,MV> Belos::TFQMRIter< ScalarType, MV, OP >::MVT |
Definition at line 149 of file BelosTFQMRIter.hpp.
typedef OperatorTraits<ScalarType,MV,OP> Belos::TFQMRIter< ScalarType, MV, OP >::OPT |
Definition at line 150 of file BelosTFQMRIter.hpp.
typedef Teuchos::ScalarTraits<ScalarType> Belos::TFQMRIter< ScalarType, MV, OP >::SCT |
Definition at line 151 of file BelosTFQMRIter.hpp.
typedef SCT::magnitudeType Belos::TFQMRIter< ScalarType, MV, OP >::MagnitudeType |
Definition at line 152 of file BelosTFQMRIter.hpp.
Belos::TFQMRIter< ScalarType, MV, OP >::TFQMRIter | ( | 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 | ||
) |
Belos::TFQMRIter constructor.
Definition at line 350 of file BelosTFQMRIter.hpp.
|
inlinevirtual |
Belos::TFQMRIter destructor.
Definition at line 164 of file BelosTFQMRIter.hpp.
|
virtual |
This method performs block TFQMR 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 TFQMR iterations until the status test evaluates as Passed, at which point the method returns to the caller.
The block TFQMR iteration proceeds as follows:
blockSize
vectors in the Krylov basis.The status test is queried at the beginning of the iteration.
Possible exceptions thrown include the TFQMRIterOrthoFailure.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 488 of file BelosTFQMRIter.hpp.
void Belos::TFQMRIter< ScalarType, MV, OP >::initializeTFQMR | ( | const TFQMRIterState< ScalarType, MV > & | newstate | ) |
Initialize the solver to an iterate, providing a complete state.
The BlockTFQMRIter 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.
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. Definition at line 423 of file BelosTFQMRIter.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 220 of file BelosTFQMRIter.hpp.
|
inline |
Get the current state of the linear solver.
The data is only valid if isInitialized() == true
.
Definition at line 233 of file BelosTFQMRIter.hpp.
|
inlinevirtual |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 252 of file BelosTFQMRIter.hpp.
|
inlinevirtual |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 255 of file BelosTFQMRIter.hpp.
Teuchos::RCP< const MV > Belos::TFQMRIter< ScalarType, MV, OP >::getNativeResiduals | ( | std::vector< MagnitudeType > * | norms | ) | const |
Get the norms of the residuals native to the solver.
Definition at line 374 of file BelosTFQMRIter.hpp.
|
inlinevirtual |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 265 of file BelosTFQMRIter.hpp.
|
inlinevirtual |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 274 of file BelosTFQMRIter.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 277 of file BelosTFQMRIter.hpp.
|
inlinevirtual |
Set the blocksize.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 280 of file BelosTFQMRIter.hpp.
|
inlinevirtual |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 286 of file BelosTFQMRIter.hpp.