Belos Package Browser (Single Doxygen Collection)
Development
|
The Belos::BiCGStabSolMgr provides a powerful and fully-featured solver manager over the pseudo-block BiCGStab iteration. More...
#include <BelosBiCGStabSolMgr.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 < 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 | showMaxResNormOnly_ |
std::string | resScale_ |
std::string | label_ |
Teuchos::RCP< Teuchos::Time > | timerSolve_ |
bool | isSet_ |
Static Private Attributes | |
static constexpr int | maxIters_default_ = 1000 |
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 const char * | resScale_default_ = "Norm of Initial Residual" |
static constexpr const char * | label_default_ = "Belos" |
Constructors/Destructor | |
BiCGStabSolMgr () | |
Empty constructor for BiCGStabSolMgr. 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... | |
BiCGStabSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for BiCGStabSolMgr. More... | |
virtual | ~BiCGStabSolMgr () |
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 BiCGStab 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::BiCGStabSolMgr provides a powerful and fully-featured solver manager over the pseudo-block BiCGStab iteration.
Definition at line 97 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 100 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 101 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 102 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 103 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 104 of file BelosBiCGStabSolMgr.hpp.
Belos::BiCGStabSolMgr< ScalarType, MV, OP >::BiCGStabSolMgr | ( | ) |
Empty constructor for BiCGStabSolMgr. 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 293 of file BelosBiCGStabSolMgr.hpp.
Belos::BiCGStabSolMgr< ScalarType, MV, OP >::BiCGStabSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for BiCGStabSolMgr.
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. Definition at line 311 of file BelosBiCGStabSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 131 of file BelosBiCGStabSolMgr.hpp.
|
inlineoverridevirtual |
clone for Inverted Injection (DII)
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 134 of file BelosBiCGStabSolMgr.hpp.
|
inlineoverridevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 142 of file BelosBiCGStabSolMgr.hpp.
|
overridevirtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 556 of file BelosBiCGStabSolMgr.hpp.
|
inlineoverridevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 152 of file BelosBiCGStabSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 159 of file BelosBiCGStabSolMgr.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 174 of file BelosBiCGStabSolMgr.hpp.
|
inlineoverridevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 179 of file BelosBiCGStabSolMgr.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 186 of file BelosBiCGStabSolMgr.hpp.
|
inlineoverridevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 194 of file BelosBiCGStabSolMgr.hpp.
|
overridevirtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 340 of file BelosBiCGStabSolMgr.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 207 of file BelosBiCGStabSolMgr.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 BiCGStabIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from BiCGStabIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 611 of file BelosBiCGStabSolMgr.hpp.
|
overridevirtual |
Method to return description of the block BiCGStab solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 859 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 244 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 247 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 248 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 251 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 252 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 253 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 254 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 257 of file BelosBiCGStabSolMgr.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 264 of file BelosBiCGStabSolMgr.hpp.
|
staticprivate |
Definition at line 267 of file BelosBiCGStabSolMgr.hpp.
|
staticprivate |
Definition at line 268 of file BelosBiCGStabSolMgr.hpp.
|
staticprivate |
Definition at line 269 of file BelosBiCGStabSolMgr.hpp.
|
staticprivate |
Definition at line 270 of file BelosBiCGStabSolMgr.hpp.
|
staticprivate |
Definition at line 271 of file BelosBiCGStabSolMgr.hpp.
|
staticprivate |
Definition at line 272 of file BelosBiCGStabSolMgr.hpp.
|
staticprivate |
Definition at line 273 of file BelosBiCGStabSolMgr.hpp.
|
staticprivate |
Definition at line 274 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 277 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 277 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 278 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 278 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 279 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 279 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 279 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 279 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 280 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 281 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 284 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 285 of file BelosBiCGStabSolMgr.hpp.
|
private |
Definition at line 288 of file BelosBiCGStabSolMgr.hpp.