Belos Package Browser (Single Doxygen Collection)
Development
|
The Belos::PseudoBlockTFQMRSolMgr provides a powerful and fully-featured solver manager over the pseudo-block TFQMR linear solver. More...
#include <BelosPseudoBlockTFQMRSolMgr.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 |
Private Attributes | |
Teuchos::RCP< LinearProblem < ScalarType, MV, OP > > | problem_ |
Teuchos::RCP< OutputManager < ScalarType > > | printer_ |
Teuchos::RCP< std::ostream > | outputStream_ |
Teuchos::RCP< StatusTest < ScalarType, MV, OP > > | sTest_ |
Teuchos::RCP < StatusTestMaxIters < ScalarType, MV, OP > > | maxIterTest_ |
Teuchos::RCP< StatusTest < ScalarType, MV, OP > > | convTest_ |
Teuchos::RCP < StatusTestGenResNorm < ScalarType, MV, OP > > | expConvTest_ |
Teuchos::RCP < StatusTestGenResNorm < ScalarType, MV, OP > > | impConvTest_ |
Teuchos::RCP< StatusTestOutput < ScalarType, MV, OP > > | outputTest_ |
Teuchos::RCP < Teuchos::ParameterList > | params_ |
MagnitudeType | convtol_ |
MagnitudeType | impTolScale_ |
MagnitudeType | achievedTol_ |
int | maxIters_ |
int | numIters_ |
int | verbosity_ |
int | outputStyle_ |
int | outputFreq_ |
int | defQuorum_ |
bool | expResTest_ |
std::string | impResScale_ |
std::string | expResScale_ |
std::string | label_ |
Teuchos::RCP< Teuchos::Time > | timerSolve_ |
bool | isSet_ |
bool | isSTSet_ |
Static Private Attributes | |
static constexpr int | maxIters_default_ = 1000 |
static constexpr bool | expResTest_default_ = false |
static constexpr int | verbosity_default_ = Belos::Errors |
static constexpr int | outputStyle_default_ = Belos::General |
static constexpr int | outputFreq_default_ = -1 |
static constexpr int | defQuorum_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 std::ostream * | outputStream_default_ = &std::cout |
PseudoBlockTFQMRSolMgr Exceptions | |
bool | checkStatusTest () |
Constructors/Destructor | |
PseudoBlockTFQMRSolMgr () | |
Empty constructor for PseudoBlockTFQMRSolMgr. 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... | |
PseudoBlockTFQMRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for PseudoBlockTFQMRSolMgr. More... | |
virtual | ~PseudoBlockTFQMRSolMgr () |
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 |
Return a reference to the linear problem being solved by this solver manager. 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 |
Whether loss of accuracy was detected during the last solve() invocation. 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 |
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. More... | |
Overridden from Teuchos::Describable | |
std::string | description () const override |
Method to return description of the pseudo-block TFQMR solver manager. More... | |
Additional Inherited Members | |
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 |
The Belos::PseudoBlockTFQMRSolMgr provides a powerful and fully-featured solver manager over the pseudo-block TFQMR linear solver.
Definition at line 104 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 107 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 108 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 109 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 110 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 111 of file BelosPseudoBlockTFQMRSolMgr.hpp.
Belos::PseudoBlockTFQMRSolMgr< ScalarType, MV, OP >::PseudoBlockTFQMRSolMgr | ( | ) |
Empty constructor for PseudoBlockTFQMRSolMgr. 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 303 of file BelosPseudoBlockTFQMRSolMgr.hpp.
Belos::PseudoBlockTFQMRSolMgr< ScalarType, MV, OP >::PseudoBlockTFQMRSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for PseudoBlockTFQMRSolMgr.
This constructor accepts the LinearProblem to be solved in addition to a parameter list of options for the solver manager. These options include the following:
int
specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 1000MagnitudeType
specifying the level that residual norms must reach to decide convergence. Default: 1e-8.int
specifying how often convergence information should be outputted. Default: -1 (never)std::string
to use as a prefix for the timer labels. Default: "Belos" Definition at line 325 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 145 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlineoverridevirtual |
clone for Inverted Injection (DII)
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 148 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlineoverridevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 156 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
overridevirtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 597 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlineoverridevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 166 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 173 of file BelosPseudoBlockTFQMRSolMgr.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 182 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlineoverridevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 187 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlineoverridevirtual |
Whether loss of accuracy was detected during the last solve()
invocation.
In solvers that can detect a loss of accuracy, this method would say whether the solver detected it in the most recent solve()
invocation. However, our TFQMR implementation does not currently detect a loss of accuracy, so this method always returns false.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 198 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlineoverridevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 205 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
overridevirtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 355 of file BelosPseudoBlockTFQMRSolMgr.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 218 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
overridevirtual |
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 PseudoBlockTFQMRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from PseudoBlockTFQMRIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 646 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
overridevirtual |
Method to return description of the pseudo-block TFQMR solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 923 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 538 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 257 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 260 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 261 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 264 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 265 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 266 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 267 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 267 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 268 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 271 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 274 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 275 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 276 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 277 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 278 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 279 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 280 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 281 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 282 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
staticprivate |
Definition at line 283 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 286 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 286 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 286 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 287 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 287 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 288 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 288 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 288 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 288 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 289 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 290 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 290 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 293 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 294 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 297 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
private |
Definition at line 297 of file BelosPseudoBlockTFQMRSolMgr.hpp.