Belos Package Browser (Single Doxygen Collection)
Development
|
#include <BelosBlockCGSolMgr.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_ |
The linear problem to solve. More... | |
Teuchos::RCP< OutputManager < ScalarType > > | printer_ |
Output manager, that handles printing of different kinds of messages. More... | |
Teuchos::RCP< std::ostream > | outputStream_ |
Output stream to which the output manager prints. More... | |
Teuchos::RCP< StatusTest < ScalarType, MV, OP > > | sTest_ |
Aggregate stopping criterion. More... | |
Teuchos::RCP < StatusTestMaxIters < ScalarType, MV, OP > > | maxIterTest_ |
Maximum iteration count stopping criterion. More... | |
Teuchos::RCP < StatusTestGenResNorm < ScalarType, MV, OP > > | convTest_ |
Convergence stopping criterion. More... | |
Teuchos::RCP< StatusTestOutput < ScalarType, MV, OP > > | outputTest_ |
Output "status test" that controls all the other status tests. More... | |
Teuchos::RCP< MatOrthoManager < ScalarType, MV, OP > > | ortho_ |
Orthogonalization manager. More... | |
Teuchos::RCP < Teuchos::ParameterList > | params_ |
Current parameter list. More... | |
MagnitudeType | convtol_ |
Convergence tolerance (read from parameter list). More... | |
MagnitudeType | orthoKappa_ |
Orthogonalization parameter (read from parameter list). More... | |
MagnitudeType | achievedTol_ |
Tolerance achieved by the last solve() invocation. More... | |
int | maxIters_ |
Maximum iteration count (read from parameter list). More... | |
int | numIters_ |
Number of iterations taken by the last solve() invocation. More... | |
int | blockSize_ |
Current solver values. More... | |
int | verbosity_ |
int | outputStyle_ |
int | outputFreq_ |
bool | adaptiveBlockSize_ |
bool | showMaxResNormOnly_ |
bool | useSingleReduction_ |
std::string | orthoType_ |
std::string | resScale_ |
bool | foldConvergenceDetectionIntoAllreduce_ |
std::string | label_ |
Prefix label for all the timers. More... | |
Teuchos::RCP< Teuchos::Time > | timerSolve_ |
Solve timer. More... | |
bool | isSet_ |
Whether or not the parameters have been set (via setParameters() ). More... | |
Static Private Attributes | |
static constexpr int | maxIters_default_ = 1000 |
static constexpr bool | adaptiveBlockSize_default_ = true |
static constexpr bool | showMaxResNormOnly_default_ = false |
static constexpr bool | useSingleReduction_default_ = false |
static constexpr int | blockSize_default_ = 1 |
static constexpr int | verbosity_default_ = Belos::Errors |
static constexpr int | outputStyle_default_ = Belos::General |
static constexpr int | outputFreq_default_ = -1 |
static constexpr const char * | resNorm_default_ = "TwoNorm" |
static constexpr bool | foldConvergenceDetectionIntoAllreduce_default_ = false |
static constexpr const char * | resScale_default_ = "Norm of Initial Residual" |
static constexpr const char * | label_default_ = "Belos" |
static constexpr const char * | orthoType_default_ = "DGKS" |
static constexpr std::ostream * | outputStream_default_ = &std::cout |
Constructors/Destructor | |
BlockCGSolMgr () | |
Empty constructor for BlockCGSolMgr. 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... | |
BlockCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for BlockCGSolMgr. More... | |
virtual | ~BlockCGSolMgr () |
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 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 block CG solver manager. 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 |
Definition at line 145 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 169 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 170 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 171 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 172 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 173 of file BelosBlockCGSolMgr.hpp.
Belos::BlockCGSolMgr< ScalarType, MV, OP, true >::BlockCGSolMgr | ( | ) |
Empty constructor for BlockCGSolMgr. 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 422 of file BelosBlockCGSolMgr.hpp.
Belos::BlockCGSolMgr< ScalarType, MV, OP, true >::BlockCGSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for BlockCGSolMgr.
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 block size to be used by the underlying block conjugate-gradient solver. Default: 1bool
specifying whether the block size can be modified throughout the solve. Default: truebool
specifying whether the iteration should apply a single reduction (only for block size of 1). Default: falseint
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.std::string
specifying the desired orthogonalization: DGKS ,ICGS, and IMGS. Default: "DGKS"MagnitudeType
used by DGKS orthogonalization to determine whether another step of classical Gram-Schmidt is necessary. Default: -1 (use DGKS default)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" pl | [in] ParameterList with construction information
|
Definition at line 447 of file BelosBlockCGSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 227 of file BelosBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
clone for Inverted Injection (DII)
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 230 of file BelosBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 238 of file BelosBlockCGSolMgr.hpp.
|
overridevirtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 790 of file BelosBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 248 of file BelosBlockCGSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 255 of file BelosBlockCGSolMgr.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 264 of file BelosBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 269 of file BelosBlockCGSolMgr.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 275 of file BelosBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 283 of file BelosBlockCGSolMgr.hpp.
|
overridevirtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 483 of file BelosBlockCGSolMgr.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 296 of file BelosBlockCGSolMgr.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 BlockCGIter::iterate() or CGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from BlockCGIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 847 of file BelosBlockCGSolMgr.hpp.
|
overridevirtual |
Method to return description of the block CG solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 1143 of file BelosBlockCGSolMgr.hpp.
|
private |
The linear problem to solve.
Definition at line 334 of file BelosBlockCGSolMgr.hpp.
|
private |
Output manager, that handles printing of different kinds of messages.
Definition at line 337 of file BelosBlockCGSolMgr.hpp.
|
private |
Output stream to which the output manager prints.
Definition at line 339 of file BelosBlockCGSolMgr.hpp.
|
private |
Aggregate stopping criterion.
This is an OR combination of the maximum iteration count test (maxIterTest_
) and convergence test (convTest_
).
Definition at line 345 of file BelosBlockCGSolMgr.hpp.
|
private |
Maximum iteration count stopping criterion.
Definition at line 348 of file BelosBlockCGSolMgr.hpp.
|
private |
Convergence stopping criterion.
Definition at line 351 of file BelosBlockCGSolMgr.hpp.
|
private |
Output "status test" that controls all the other status tests.
Definition at line 354 of file BelosBlockCGSolMgr.hpp.
|
private |
Orthogonalization manager.
Definition at line 357 of file BelosBlockCGSolMgr.hpp.
|
private |
Current parameter list.
Definition at line 360 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 365 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 366 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 367 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 368 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 369 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 370 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 371 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 372 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 373 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 374 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 375 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 376 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 377 of file BelosBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 378 of file BelosBlockCGSolMgr.hpp.
|
private |
Convergence tolerance (read from parameter list).
Definition at line 385 of file BelosBlockCGSolMgr.hpp.
|
private |
Orthogonalization parameter (read from parameter list).
Definition at line 388 of file BelosBlockCGSolMgr.hpp.
|
private |
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.
Definition at line 395 of file BelosBlockCGSolMgr.hpp.
|
private |
Maximum iteration count (read from parameter list).
Definition at line 398 of file BelosBlockCGSolMgr.hpp.
|
private |
Number of iterations taken by the last solve()
invocation.
Definition at line 401 of file BelosBlockCGSolMgr.hpp.
|
private |
Current solver values.
Definition at line 404 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 404 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 404 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 404 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 405 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 405 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 405 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 406 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 406 of file BelosBlockCGSolMgr.hpp.
|
private |
Definition at line 407 of file BelosBlockCGSolMgr.hpp.
|
private |
Prefix label for all the timers.
Definition at line 410 of file BelosBlockCGSolMgr.hpp.
|
private |
Solve timer.
Definition at line 413 of file BelosBlockCGSolMgr.hpp.
|
private |
Whether or not the parameters have been set (via setParameters()
).
Definition at line 416 of file BelosBlockCGSolMgr.hpp.