Belos Package Browser (Single Doxygen Collection)
Development
|
#include <BelosPseudoBlockCGSolMgr.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 |
Static Private Attributes | |
static constexpr int | maxIters_default_ = 1000 |
static constexpr bool | assertPositiveDefiniteness_default_ = true |
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 int | defQuorum_default_ = 1 |
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 bool | genCondEst_default_ = false |
PseudoBlockCGSolMgr Exceptions | |
void | compute_condnum_tridiag_sym (Teuchos::ArrayView< MagnitudeType > diag, Teuchos::ArrayView< MagnitudeType > offdiag, Teuchos::ArrayRCP< MagnitudeType > &lambdas, ScalarType &lambda_min, ScalarType &lambda_max, ScalarType &ConditionNumber) |
Constructors/Destructor | |
PseudoBlockCGSolMgr () | |
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... | |
PseudoBlockCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for PseudoBlockCGSolMgr. More... | |
virtual | ~PseudoBlockCGSolMgr () |
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... | |
ScalarType | getConditionEstimate () const |
Gets the estimated condition number. More... | |
Teuchos::ArrayRCP< MagnitudeType > | getEigenEstimates () const |
Teuchos::RCP < StatusTestGenResNorm < ScalarType, MV, OP > > | getResidualStatusTest () const |
Return the residual status test. 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 133 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 137 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 138 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 139 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 140 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 141 of file BelosPseudoBlockCGSolMgr.hpp.
Belos::PseudoBlockCGSolMgr< ScalarType, MV, OP, true >::PseudoBlockCGSolMgr | ( | ) |
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 361 of file BelosPseudoBlockCGSolMgr.hpp.
Belos::PseudoBlockCGSolMgr< ScalarType, MV, OP, true >::PseudoBlockCGSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for PseudoBlockCGSolMgr.
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.MagnitudeType
specifying the level that residual norms must reach to decide convergence. pl | [in] ParameterList with construction information
|
Definition at line 383 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 174 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
clone for Inverted Injection (DII)
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 177 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 185 of file BelosPseudoBlockCGSolMgr.hpp.
|
overridevirtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 685 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 195 of file BelosPseudoBlockCGSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 202 of file BelosPseudoBlockCGSolMgr.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.
isLOADetected()
to check for a loss of accuracy during the last solve. Reimplemented from Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 217 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 222 of file BelosPseudoBlockCGSolMgr.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 229 of file BelosPseudoBlockCGSolMgr.hpp.
|
inline |
Gets the estimated condition number.
Definition at line 234 of file BelosPseudoBlockCGSolMgr.hpp.
|
inline |
Definition at line 235 of file BelosPseudoBlockCGSolMgr.hpp.
|
inline |
Return the residual status test.
Definition at line 239 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlineoverridevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 247 of file BelosPseudoBlockCGSolMgr.hpp.
|
overridevirtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 418 of file BelosPseudoBlockCGSolMgr.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 260 of file BelosPseudoBlockCGSolMgr.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 PseudoBlockCGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from PseudoBlockCGIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 746 of file BelosPseudoBlockCGSolMgr.hpp.
|
overridevirtual |
Method to return description of the block CG solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 1008 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 1021 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 304 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 307 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 308 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 311 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 312 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 313 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 314 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 317 of file BelosPseudoBlockCGSolMgr.hpp.
|
mutableprivate |
List of valid parameters and their default values.
This is declared "mutable" because the SolverManager interface requires that getValidParameters() be declared const, yet we want to create the valid parameter list only on demand.
Definition at line 324 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 327 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 328 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 329 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 330 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 331 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 332 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 333 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 334 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 335 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 336 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 337 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 340 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 340 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 341 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 341 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 342 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 342 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 342 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 342 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 343 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 343 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 344 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 345 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 346 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 347 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 348 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 351 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 352 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 355 of file BelosPseudoBlockCGSolMgr.hpp.