Belos Package Browser (Single Doxygen Collection)
Development
|
Belos's class for applying the GMRES polynomial operator that is used by the hybrid-GMRES linear solver. More...
#include <BelosGmresPolyOp.hpp>
Constructor/Destructor | |
GmresPolyOp (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem_in, const Teuchos::RCP< Teuchos::ParameterList > ¶ms_in) | |
Basic contstructor. More... | |
GmresPolyOp (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem_in) | |
Create a simple polynomial of dimension 1. More... | |
virtual | ~GmresPolyOp () |
Destructor. More... | |
Parameter processing method | |
void | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶ms_in) |
Process the passed in parameters. More... | |
Polynomial creation method | |
void | generateArnoldiPoly () |
This routine takes the matrix, preconditioner, and vectors from the linear problem as well as the parameters to generate the Arnoldi polynomial. More... | |
void | generateGmresPoly () |
This routine takes the matrix, preconditioner, and vectors from the linear problem as well as the parameters to generate the Gmres polynomial. More... | |
Operator application method | |
typedef int | OT |
typedef MultiVecTraits < ScalarType, MV > | MVT |
typedef Teuchos::ScalarTraits < ScalarType > | SCT |
typedef Teuchos::ScalarTraits < ScalarType >::magnitudeType | MagnitudeType |
static constexpr int | maxDegree_default_ = 25 |
static constexpr int | verbosity_default_ = Belos::Errors |
static constexpr bool | randomRHS_default_ = true |
static constexpr const char * | label_default_ = "Belos" |
static constexpr const char * | polyType_default_ = "Arnoldi" |
static constexpr const char * | orthoType_default_ = "DGKS" |
static constexpr std::ostream * | outputStream_default_ = &std::cout |
Teuchos::RCP< LinearProblem < ScalarType, MV, OP > > | problem_ |
Teuchos::RCP < Teuchos::ParameterList > | params_ |
Teuchos::RCP< const OP > | LP_ |
Teuchos::RCP< const OP > | RP_ |
Teuchos::RCP< OutputManager < ScalarType > > | printer_ |
Teuchos::RCP< std::ostream > | outputStream_ |
Teuchos::RCP< MatOrthoManager < ScalarType, MV, OP > > | ortho_ |
MagnitudeType | polyTol_ |
int | maxDegree_ |
int | verbosity_ |
bool | randomRHS_ |
std::string | label_ |
std::string | polyType_ |
std::string | orthoType_ |
int | dim_ |
Teuchos::RCP< MV > | V_ |
Teuchos::RCP< MV > | wL_ |
Teuchos::RCP< MV > | wR_ |
Teuchos::SerialDenseMatrix< OT, ScalarType > | H_ |
Teuchos::SerialDenseMatrix< OT, ScalarType > | y_ |
Teuchos::SerialDenseVector< OT, ScalarType > | r0_ |
bool | autoDeg = false |
Teuchos::SerialDenseMatrix< OT, ScalarType > | pCoeff_ |
void | ApplyPoly (const MV &x, MV &y) const |
This routine takes the MV x and applies the polynomial operator phi(OP) to it resulting in the MV y , which is returned. More... | |
void | ApplyArnoldiPoly (const MV &x, MV &y) const |
void | ApplyGmresPoly (const MV &x, MV &y) const |
void | Apply (const MultiVec< ScalarType > &x, MultiVec< ScalarType > &y, ETrans=NOTRANS) const |
This routine casts the MultiVec to GmresPolyMv to retrieve the MV. Then the above apply method is called. More... | |
int | polyDegree () const |
GmresPolyOp () | |
Default constructor. More... | |
Belos's class for applying the GMRES polynomial operator that is used by the hybrid-GMRES linear solver.
This operator is used as the interface to the matrix polynomial (phi(A)
), solution (X
), and right-hand side (B
) of the linear system phi(A)X = B
. Furthermore, it is also the interface to left/right preconditioning of the linear system.
Definition at line 193 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 291 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 292 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 293 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 294 of file BelosGmresPolyOp.hpp.
|
inline |
Basic contstructor.
Definition at line 200 of file BelosGmresPolyOp.hpp.
|
inline |
Create a simple polynomial of dimension 1.
Definition at line 229 of file BelosGmresPolyOp.hpp.
|
inlinevirtual |
Destructor.
Definition at line 237 of file BelosGmresPolyOp.hpp.
|
inlineprivate |
Default constructor.
Definition at line 289 of file BelosGmresPolyOp.hpp.
void Belos::GmresPolyOp< ScalarType, MV, OP >::setParameters | ( | const Teuchos::RCP< Teuchos::ParameterList > & | params_in | ) |
Process the passed in parameters.
Definition at line 339 of file BelosGmresPolyOp.hpp.
void Belos::GmresPolyOp< ScalarType, MV, OP >::generateArnoldiPoly | ( | ) |
This routine takes the matrix, preconditioner, and vectors from the linear problem as well as the parameters to generate the Arnoldi polynomial.
Definition at line 493 of file BelosGmresPolyOp.hpp.
void Belos::GmresPolyOp< ScalarType, MV, OP >::generateGmresPoly | ( | ) |
This routine takes the matrix, preconditioner, and vectors from the linear problem as well as the parameters to generate the Gmres polynomial.
Definition at line 396 of file BelosGmresPolyOp.hpp.
void Belos::GmresPolyOp< ScalarType, MV, OP >::ApplyPoly | ( | const MV & | x, |
MV & | y | ||
) | const |
This routine takes the MV x
and applies the polynomial operator phi(OP)
to it resulting in the MV y
, which is returned.
\note It is expected that any problem with applying this operator to \c x will be
indicated by an std::exception being thrown.
Definition at line 627 of file BelosGmresPolyOp.hpp.
void Belos::GmresPolyOp< ScalarType, MV, OP >::ApplyArnoldiPoly | ( | const MV & | x, |
MV & | y | ||
) | const |
Definition at line 680 of file BelosGmresPolyOp.hpp.
void Belos::GmresPolyOp< ScalarType, MV, OP >::ApplyGmresPoly | ( | const MV & | x, |
MV & | y | ||
) | const |
Definition at line 642 of file BelosGmresPolyOp.hpp.
|
inlinevirtual |
This routine casts the MultiVec to GmresPolyMv to retrieve the MV. Then the above apply method is called.
Implements Belos::Operator< ScalarType >.
Definition at line 277 of file BelosGmresPolyOp.hpp.
|
inline |
Definition at line 284 of file BelosGmresPolyOp.hpp.
|
staticprivate |
Definition at line 297 of file BelosGmresPolyOp.hpp.
|
staticprivate |
Definition at line 298 of file BelosGmresPolyOp.hpp.
|
staticprivate |
Definition at line 299 of file BelosGmresPolyOp.hpp.
|
staticprivate |
Definition at line 300 of file BelosGmresPolyOp.hpp.
|
staticprivate |
Definition at line 301 of file BelosGmresPolyOp.hpp.
|
staticprivate |
Definition at line 302 of file BelosGmresPolyOp.hpp.
|
staticprivate |
Definition at line 303 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 306 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 307 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 308 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 308 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 311 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 312 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 315 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 318 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 319 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 320 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 321 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 322 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 323 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 324 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 325 of file BelosGmresPolyOp.hpp.
|
mutableprivate |
Definition at line 328 of file BelosGmresPolyOp.hpp.
|
mutableprivate |
Definition at line 328 of file BelosGmresPolyOp.hpp.
|
mutableprivate |
Definition at line 328 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 329 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 329 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 330 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 333 of file BelosGmresPolyOp.hpp.
|
private |
Definition at line 334 of file BelosGmresPolyOp.hpp.