Belos Package Browser (Single Doxygen Collection)
Development
|
Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation. More...
#include <BelosGCRODRSolMgr.hpp>
Private Types | |
typedef MultiVecTraits < ScalarType, MV > | MVT |
typedef OperatorTraits < ScalarType, MV, OP > | OPT |
typedef Teuchos::ScalarTraits < ScalarType > | SCT |
typedef Teuchos::ScalarTraits < ScalarType >::magnitudeType | MagnitudeType |
typedef Teuchos::ScalarTraits < MagnitudeType > | MT |
typedef OrthoManagerFactory < ScalarType, MV, OP > | ortho_factory_type |
Private Member Functions | |
void | init () |
void | initializeStateStorage () |
void | buildRecycleSpace2 (Teuchos::RCP< GCRODRIter< ScalarType, MV, OP > > gcrodr_iter) |
int | getHarmonicVecs1 (int m, const Teuchos::SerialDenseMatrix< int, ScalarType > &HH, Teuchos::SerialDenseMatrix< int, ScalarType > &PP) |
int | getHarmonicVecs2 (int keff, int m, const Teuchos::SerialDenseMatrix< int, ScalarType > &HH, const Teuchos::RCP< const MV > &VV, Teuchos::SerialDenseMatrix< int, ScalarType > &PP) |
void | sort (std::vector< MagnitudeType > &dlist, int n, std::vector< int > &iperm) |
Static Private Attributes | |
static constexpr double | orthoKappa_default_ = 0.0 |
static constexpr int | maxRestarts_default_ = 100 |
static constexpr int | maxIters_default_ = 1000 |
static constexpr int | numBlocks_default_ = 50 |
static constexpr int | blockSize_default_ = 1 |
static constexpr int | recycledBlocks_default_ = 5 |
static constexpr int | verbosity_default_ = Belos::Errors |
static constexpr int | outputStyle_default_ = Belos::General |
static constexpr int | outputFreq_default_ = -1 |
static constexpr const char * | impResScale_default_ = "Norm of Preconditioned Initial Residual" |
static constexpr const char * | expResScale_default_ = "Norm of Initial Residual" |
static constexpr const char * | label_default_ = "Belos" |
static constexpr const char * | orthoType_default_ = "ICGS" |
Constructors/Destructor | |
GCRODRSolMgr () | |
Empty constructor for GCRODRSolMgr. This constructor takes no arguments and sets the default values for the solver. The linear problem must be passed in using setProblem() before solve() is called on this object. The solver values can be changed using setParameters(). More... | |
GCRODRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for GCRODRSolMgr. More... | |
virtual | ~GCRODRSolMgr () |
Destructor. More... | |
Teuchos::RCP< SolverManager < ScalarType, MV, OP > > | clone () const override |
clone for Inverted Injection (DII) More... | |
Accessor methods | |
const LinearProblem < ScalarType, MV, OP > & | getProblem () const override |
Get current linear problem being solved for in this object. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const override |
Get a parameter list containing the valid parameters for this object. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getCurrentParameters () const override |
Get a parameter list containing the current parameters for this object. More... | |
Teuchos::Array< Teuchos::RCP < Teuchos::Time > > | getTimers () const |
Return the timers for this object. More... | |
MagnitudeType | achievedTol () const override |
Tolerance achieved by the last solve() invocation. More... | |
int | getNumIters () const override |
Get the iteration count for the most recent call to solve() . More... | |
bool | isLOADetected () const override |
Return whether a loss of accuracy was detected by this solver during the most current solve. More... | |
Set methods | |
void | setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem) override |
Set the linear problem that needs to be solved. More... | |
void | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶ms) override |
Set the parameters the solver manager should use to solve the linear problem. More... | |
Reset methods | |
void | reset (const ResetType type) override |
Performs a reset of the solver manager specified by the ResetType . This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy. More... | |
Solver application methods | |
ReturnType | solve () override |
Attempt to solve the linear system. More... | |
Implementation of Teuchos::Describable | |
std::string | description () const override |
Return a one-line description of this object. More... | |
Additional Inherited Members | |
Public Member Functions inherited from Belos::Details::SolverManagerRequiresLapack< ScalarType, MV, OP, true > | |
SolverManagerRequiresLapack () | |
virtual | ~SolverManagerRequiresLapack () |
Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP > | |
SolverManager () | |
Empty constructor. More... | |
virtual | ~SolverManager () |
Destructor. More... | |
virtual void | setUserConvStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &=StatusTestCombo< ScalarType, MV, OP >::SEQ) |
Set user-defined convergence status test. More... | |
virtual void | setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &) |
Set user-defined debug status test. More... | |
Public Member Functions inherited from Teuchos::Describable | |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
virtual void | describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
Static Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation.
This contains the actual working implementation of GCRODR.
Definition at line 180 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 223 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 224 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 225 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 226 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 227 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 228 of file BelosGCRODRSolMgr.hpp.
Belos::GCRODRSolMgr< ScalarType, MV, OP, true >::GCRODRSolMgr | ( | ) |
Empty constructor for GCRODRSolMgr. This constructor takes no arguments and sets the default values for the solver. The linear problem must be passed in using setProblem() before solve() is called on this object. The solver values can be changed using setParameters().
Definition at line 550 of file BelosGCRODRSolMgr.hpp.
Belos::GCRODRSolMgr< ScalarType, MV, OP, true >::GCRODRSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for GCRODRSolMgr.
This constructor accepts the LinearProblem to be solved in addition to a parameter list of options for the solver manager. Some of the more important options include the following:
int
specifying the number of blocks allocated for the Krylov basis. Default: 50.int
specifying the number of blocks allocated for the Krylov basis. Default: 5.int
specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 5000.int
specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 100.std::string
specifying the desired orthogonalization. Currently supported values: "DGKS", "ICGS", "IMGS", and "TSQR" (if Belos was built with TSQR support). Default: "ICGS".MagnitudeType
specifying the level that residual norms must reach to decide convergence. Default: 1e-8.Other supported options:
MagnitudeType
corresponding to the "depTol" parameter of DGKS orthogonalization. Ignored unless DGKS orthogonalization is used. DGKS decides the default value. Definition at line 561 of file BelosGCRODRSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 297 of file BelosGCRODRSolMgr.hpp.
|
inlineoverridevirtual |
clone for Inverted Injection (DII)
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 300 of file BelosGCRODRSolMgr.hpp.
|
inlineoverridevirtual |
Get current linear problem being solved for in this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 310 of file BelosGCRODRSolMgr.hpp.
|
overridevirtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 1134 of file BelosGCRODRSolMgr.hpp.
|
inlineoverridevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 320 of file BelosGCRODRSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 329 of file BelosGCRODRSolMgr.hpp.
|
inlineoverridevirtual |
Tolerance achieved by the last solve()
invocation.
This is the maximum over all right-hand sides' achieved convergence tolerances, and is set whether or not the solve actually managed to achieve the desired convergence tolerance.
Reimplemented from Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 338 of file BelosGCRODRSolMgr.hpp.
|
inlineoverridevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 343 of file BelosGCRODRSolMgr.hpp.
|
inlineoverridevirtual |
Return whether a loss of accuracy was detected by this solver during the most current solve.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 349 of file BelosGCRODRSolMgr.hpp.
|
inlineoverridevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 357 of file BelosGCRODRSolMgr.hpp.
|
overridevirtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 624 of file BelosGCRODRSolMgr.hpp.
|
inlineoverridevirtual |
Performs a reset of the solver manager specified by the ResetType
. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 372 of file BelosGCRODRSolMgr.hpp.
|
overridevirtual |
Attempt to solve the linear system.
This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.
This method calls GCRODRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown. A return from GCRODRIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 1332 of file BelosGCRODRSolMgr.hpp.
|
overridevirtual |
Return a one-line description of this object.
Reimplemented from Teuchos::Describable.
Definition at line 2418 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 589 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 1203 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 1909 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 2087 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 2203 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 2353 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 457 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 460 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 463 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 464 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 467 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 468 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 469 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 470 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 470 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 471 of file BelosGCRODRSolMgr.hpp.
|
private |
Orthogonalization manager.
It is created by the OrthoManagerFactory instance, and may be changed if the parameters to this solver manager are changed.
Definition at line 476 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 479 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 482 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 483 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 484 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 485 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 486 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 487 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 488 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 489 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 490 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 491 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 492 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 493 of file BelosGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 494 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 497 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 497 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 497 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 498 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 498 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 498 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 499 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 499 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 499 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 500 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 501 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 501 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 508 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 508 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 510 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 513 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 516 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 519 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 519 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 522 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 522 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 525 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 526 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 527 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 528 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 529 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 530 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 531 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 532 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 533 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 537 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 538 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 541 of file BelosGCRODRSolMgr.hpp.
|
private |
Definition at line 544 of file BelosGCRODRSolMgr.hpp.