Belos Package Browser (Single Doxygen Collection)
Development
|
#include <BelosRCGSolMgr.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 Member Functions | |
void | init () |
void | getHarmonicVecs (const Teuchos::SerialDenseMatrix< int, ScalarType > &F, const Teuchos::SerialDenseMatrix< int, ScalarType > &G, Teuchos::SerialDenseMatrix< int, ScalarType > &Y) |
void | sort (std::vector< ScalarType > &dlist, int n, std::vector< int > &iperm) |
void | initializeStateStorage () |
Static Private Attributes | |
static constexpr int | maxIters_default_ = 1000 |
static constexpr int | blockSize_default_ = 1 |
static constexpr int | numBlocks_default_ = 25 |
static constexpr int | recycleBlocks_default_ = 3 |
static constexpr bool | showMaxResNormOnly_default_ = false |
static constexpr int | verbosity_default_ = Belos::Errors |
static constexpr int | outputStyle_default_ = Belos::General |
static constexpr int | outputFreq_default_ = -1 |
static constexpr const char * | label_default_ = "Belos" |
static constexpr std::ostream * | outputStream_default_ = &std::cout |
Constructors/Destructor | |
RCGSolMgr () | |
Empty constructor for RCGSolMgr. 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... | |
RCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for RCGSolMgr. More... | |
virtual | ~RCGSolMgr () |
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 |
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 method | |
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. Belos::Problem forces a call to setProblem on the linear problem, and Belos::RecycleSubspace causes the solver manager to "forget" the recycle space generated by previous calls to the solver. In the latter case, the next call to solve() will act as if the solver has never been called before. 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 RCG solver manager. More... | |
Additional Inherited Members | |
Public Member Functions inherited from Belos::Details::SolverManagerRequiresRealLapack< ScalarType, MV, OP, true > | |
SolverManagerRequiresRealLapack () | |
virtual | ~SolverManagerRequiresRealLapack () |
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 |
Definition at line 182 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 185 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 186 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 187 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 188 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 189 of file BelosRCGSolMgr.hpp.
Belos::RCGSolMgr< ScalarType, MV, OP, true >::RCGSolMgr | ( | ) |
Empty constructor for RCGSolMgr. 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 475 of file BelosRCGSolMgr.hpp.
Belos::RCGSolMgr< ScalarType, MV, OP, true >::RCGSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for RCGSolMgr.
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 length of a cycle (and thus number of max number of search vectors kept). Default: 25int
specifying the number of vectors selected for recycling. Default: 3int
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)bool
specifying whether that only the maximum relative residual norm is printed if convergence information is printed. Default: falsestd::string
to use as a prefix for the timer labels. Default: "Belos" Definition at line 484 of file BelosRCGSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 228 of file BelosRCGSolMgr.hpp.
|
inlineoverridevirtual |
clone for Inverted Injection (DII)
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 231 of file BelosRCGSolMgr.hpp.
|
inlineoverridevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 239 of file BelosRCGSolMgr.hpp.
|
overridevirtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 734 of file BelosRCGSolMgr.hpp.
|
inlineoverridevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 247 of file BelosRCGSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 254 of file BelosRCGSolMgr.hpp.
|
inlineoverridevirtual |
Tolerance achieved by the last solve()
invocation.
This 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 262 of file BelosRCGSolMgr.hpp.
|
inlineoverridevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 267 of file BelosRCGSolMgr.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 272 of file BelosRCGSolMgr.hpp.
|
inlineoverridevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 280 of file BelosRCGSolMgr.hpp.
|
overridevirtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 553 of file BelosRCGSolMgr.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. Belos::Problem forces a call to setProblem on the linear problem, and Belos::RecycleSubspace causes the solver manager to "forget" the recycle space generated by previous calls to the solver. In the latter case, the next call to solve() will act as if the solver has never been called before.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 295 of file BelosRCGSolMgr.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 RCGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from RCGIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 1064 of file BelosRCGSolMgr.hpp.
|
overridevirtual |
Method to return description of the RCG solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 2004 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 502 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 1887 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 1939 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 777 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 351 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 354 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 355 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 358 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 359 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 360 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 361 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 364 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 367 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 368 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 369 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 370 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 371 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 372 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 373 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 374 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 375 of file BelosRCGSolMgr.hpp.
|
staticprivate |
Definition at line 376 of file BelosRCGSolMgr.hpp.
|
private |
Convergence tolerance (read from parameter list).
Definition at line 383 of file BelosRCGSolMgr.hpp.
|
private |
Tolerance achieved by the last solve()
invocation.
This is set whether or not the solve actually managed to achieve the desired convergence tolerance.
Definition at line 389 of file BelosRCGSolMgr.hpp.
|
private |
Maximum iteration count (read from parameter list).
Definition at line 392 of file BelosRCGSolMgr.hpp.
|
private |
Number of iterations taken by the last solve()
invocation.
Definition at line 395 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 397 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 397 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 398 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 399 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 399 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 399 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 405 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 408 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 411 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 414 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 417 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 420 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 423 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 423 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 426 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 429 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 430 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 431 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 434 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 437 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 440 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 443 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 446 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 449 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 452 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 452 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 452 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 455 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 455 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 455 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 456 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 456 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 456 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 457 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 457 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 458 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 459 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 459 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 460 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 460 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 461 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 465 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 466 of file BelosRCGSolMgr.hpp.
|
private |
Definition at line 469 of file BelosRCGSolMgr.hpp.