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 |
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< StatusTestGenResNorm< ScalarType, MV, OP > > | convTest_ |
Teuchos::RCP< StatusTestOutput< ScalarType, MV, OP > > | outputTest_ |
Teuchos::RCP< MatOrthoManager< ScalarType, MV, OP > > | ortho_ |
Teuchos::RCP< Teuchos::ParameterList > | params_ |
Teuchos::RCP< const Teuchos::ParameterList > | validParams_ |
List of valid parameters and their default values. More... | |
MagnitudeType | convtol_ |
MagnitudeType | achievedTol_ |
int | maxIters_ |
int | numIters_ |
int | verbosity_ |
int | outputStyle_ |
int | outputFreq_ |
int | defQuorum_ |
bool | assertPositiveDefiniteness_ |
bool | showMaxResNormOnly_ |
std::string | resScale_ |
bool | genCondEst_ |
ScalarType | condEstimate_ |
std::string | label_ |
Teuchos::RCP< Teuchos::Time > | timerSolve_ |
bool | isSet_ |
PseudoBlockCGSolMgr Exceptions | |
static const MagnitudeType | convtol_default_ = 1e-8 |
static const int | maxIters_default_ = 1000 |
static const bool | assertPositiveDefiniteness_default_ = true |
static const bool | showMaxResNormOnly_default_ = false |
static const int | verbosity_default_ = Belos::Errors |
static const int | outputStyle_default_ = Belos::General |
static const int | outputFreq_default_ = -1 |
static const int | defQuorum_default_ = 1 |
static const std::string | resScale_default_ = "Norm of Initial Residual" |
static const std::string | label_default_ = "Belos" |
static const Teuchos::RCP< std::ostream > | outputStream_default_ = Teuchos::rcp(&std::cout,false) |
static const bool | genCondEst_default_ = false |
void | compute_condnum_tridiag_sym (Teuchos::ArrayView< MagnitudeType > diag, Teuchos::ArrayView< MagnitudeType > offdiag, 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... | |
Accessor methods | |
const LinearProblem< ScalarType, MV, OP > & | getProblem () const |
Return a reference to the linear problem being solved by this solver manager. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Get a parameter list containing the valid parameters for this object. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getCurrentParameters () const |
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 |
Tolerance achieved by the last solve() invocation. More... | |
int | getNumIters () const |
Get the iteration count for the most recent call to solve() . More... | |
bool | isLOADetected () const |
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::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) |
Set the linear problem that needs to be solved. More... | |
void | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶ms) |
Set the parameters the solver manager should use to solve the linear problem. More... | |
Reset methods | |
void | reset (const ResetType type) |
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 () |
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 |
Method to return description of the block CG solver manager. More... | |
Additional Inherited Members | |
![]() | |
SolverManagerRequiresLapack () | |
virtual | ~SolverManagerRequiresLapack () |
![]() | |
SolverManager () | |
Empty constructor. More... | |
virtual | ~SolverManager () |
Destructor. More... | |
virtual void | setUserConvStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &userConvStatusTest, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &comboType=StatusTestCombo< ScalarType, MV, OP >::SEQ) |
Set user-defined convergence status test. More... | |
virtual void | setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &debugStatusTest) |
Set user-defined debug status test. More... | |
![]() | |
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 const EVerbosityLevel | verbLevel_default |
Definition at line 139 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 143 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 144 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 145 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 146 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 147 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 399 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 420 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 180 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 186 of file BelosPseudoBlockCGSolMgr.hpp.
|
virtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 713 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 196 of file BelosPseudoBlockCGSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 203 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
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 218 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 223 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
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 230 of file BelosPseudoBlockCGSolMgr.hpp.
|
inline |
Gets the estimated condition number.
Definition at line 235 of file BelosPseudoBlockCGSolMgr.hpp.
|
inline |
Return the residual status test.
Definition at line 239 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 247 of file BelosPseudoBlockCGSolMgr.hpp.
|
virtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 454 of file BelosPseudoBlockCGSolMgr.hpp.
|
inlinevirtual |
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.
|
virtual |
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 772 of file BelosPseudoBlockCGSolMgr.hpp.
|
virtual |
Method to return description of the block CG solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 1006 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 1019 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 303 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 306 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 307 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 310 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 316 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 319 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 326 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.
|
staticprivate |
Definition at line 338 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 339 of file BelosPseudoBlockCGSolMgr.hpp.
|
staticprivate |
Definition at line 340 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 344 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 345 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 345 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 345 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 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 349 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 352 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 353 of file BelosPseudoBlockCGSolMgr.hpp.
|
private |
Definition at line 356 of file BelosPseudoBlockCGSolMgr.hpp.