Belos Package Browser (Single Doxygen Collection)
Development
|
A solver manager for the Block GCRO-DR (Block Recycling GMRES) linear solver. More...
#include <BelosBlockGCRODRSolMgr.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 |
typedef Teuchos::ScalarTraits < MagnitudeType > | SMT |
typedef OrthoManagerFactory < ScalarType, MV, OP > | ortho_factory_type |
typedef Teuchos::SerialDenseMatrix < int, ScalarType > | SDM |
typedef Teuchos::SerialDenseVector < int, ScalarType > | SDV |
Private Member Functions | |
void | init () |
void | initializeStateStorage () |
void | buildRecycleSpaceKryl (int &keff, Teuchos::RCP< BlockGmresIter< ScalarType, MV, OP > > block_gmres_iter) |
void | buildRecycleSpaceAugKryl (Teuchos::RCP< BlockGCRODRIter< ScalarType, MV, OP > > gcrodr_iter) |
int | getHarmonicVecsKryl (int m, const SDM &HH, SDM &PP) |
int | getHarmonicVecsAugKryl (int keff, int m, const SDM &HH, const Teuchos::RCP< const MV > &VV, SDM &PP) |
void | sort (std::vector< MagnitudeType > &dlist, int n, std::vector< int > &iperm) |
Static Private Attributes | |
static const bool | adaptiveBlockSize_default_ = true |
static const std::string | recycleMethod_default_ = "harmvecs" |
Constructors/Destructor | |
BlockGCRODRSolMgr () | |
Default constructor. More... | |
BlockGCRODRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for GCRODRSolMgr. More... | |
virtual | ~BlockGCRODRSolMgr () |
Destructor. More... | |
Implementation of the Teuchos::Describable interface | |
std::string | description () const |
A description of the Block GCRODR solver manager. More... | |
Accessor methods | |
const LinearProblem < ScalarType, MV, OP > & | getProblem () const |
Get current linear problem being solved for in this object. 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... | |
MagnitudeType | achievedTol () const |
Get the residual for the most recent call to solve(). More... | |
int | getNumIters () const |
Get the iteration count for the most recent call to solve() . More... | |
bool | isLOADetected () const |
Whether a loss of accuracy was detected during the most recent solve. More... | |
Set methods | |
void | setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem) |
Set the linear problem to solve on the next call to solve() . More... | |
void | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶ms) |
Set the parameters the solver 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 . More... | |
Solver application methods | |
ReturnType | solve () |
Solve the current linear problem. More... | |
Additional Inherited Members | |
Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP > | |
SolverManager () | |
Empty constructor. More... | |
virtual | ~SolverManager () |
Destructor. More... | |
virtual Teuchos::RCP < SolverManager< ScalarType, MV, OP > > | clone () const =0 |
clone the solver manager. 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 |
A solver manager for the Block GCRO-DR (Block Recycling GMRES) linear solver.
GCRO-DR (also called Recycling GMRES) is a variant of GMRES that can more efficiently solve sequences linear systems. It does so by "recycling" Krylov basis information from previous solves.
The original GCRO-DR algorithm can only solve one right-hand side at a time. Block GCRO-DR extends GCRO-DR so that it can solve multiple right-hand sides at a time; thus, it can solve sequences of block systems.
Definition at line 94 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 97 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 98 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 99 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 100 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 101 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 102 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 103 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 104 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 105 of file BelosBlockGCRODRSolMgr.hpp.
Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::BlockGCRODRSolMgr | ( | ) |
Default constructor.
This constructor sets up the solver with default parameters. 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 405 of file BelosBlockGCRODRSolMgr.hpp.
Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::BlockGCRODRSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for GCRODRSolMgr.
This constructor accepts the LinearProblem to be solved in addition to a parameter list of options for the solver manager. Some of the more important options include the following:
int
specifying the number of blocks allocated for the Krylov basis. Default: 50.int
specifying the number of right hand sides being solved at a time.int
specifying the number of blocks allocated for the Krylov basis. Default: 5.int
specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 5000.int
specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 100.std::string
specifying the desired orthogonalization. Currently supported values: "DGKS", "ICGS", "IMGS", and "TSQR" (if Belos was built with TSQR support). Default: "ICGS".MagnitudeType
specifying the level that residual norms must reach to decide convergence. Default: 1e-8.Other supported options:
MagnitudeType
corresponding to the "depTol" parameter of DGKS orthogonalization. Ignored unless DGKS orthogonalization is used. DGKS decides the default value. Definition at line 412 of file BelosBlockGCRODRSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 147 of file BelosBlockGCRODRSolMgr.hpp.
|
virtual |
A description of the Block GCRODR solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 508 of file BelosBlockGCRODRSolMgr.hpp.
|
inlinevirtual |
Get current linear problem being solved for in this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 163 of file BelosBlockGCRODRSolMgr.hpp.
|
virtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 523 of file BelosBlockGCRODRSolMgr.hpp.
|
inlinevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 171 of file BelosBlockGCRODRSolMgr.hpp.
|
inlinevirtual |
Get the residual for the most recent call to solve().
Reimplemented from Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 174 of file BelosBlockGCRODRSolMgr.hpp.
|
inlinevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 179 of file BelosBlockGCRODRSolMgr.hpp.
|
inlinevirtual |
Whether a loss of accuracy was detected during the most recent solve.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 182 of file BelosBlockGCRODRSolMgr.hpp.
|
inlinevirtual |
Set the linear problem to solve on the next call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 190 of file BelosBlockGCRODRSolMgr.hpp.
|
virtual |
Set the parameters the solver should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 610 of file BelosBlockGCRODRSolMgr.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 219 of file BelosBlockGCRODRSolMgr.hpp.
|
virtual |
Solve the current linear problem.
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 BlockGCRODRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown.
A return from BlockGCRODRIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 1768 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 431 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 1025 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 1177 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 1271 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 1573 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 1440 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 1708 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 292 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
The current linear problem to solve.
Definition at line 295 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 298 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 299 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 302 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 303 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 304 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 305 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 305 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 306 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Factory for creating MatOrthoManager subclass instances.
Definition at line 309 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Orthogonalization manager.
This is created by the OrthoManagerFactory instance. The pointer may be invalidated if this solver's parameters are changed.
Definition at line 316 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
This solver's current parameter list.
Definition at line 319 of file BelosBlockGCRODRSolMgr.hpp.
|
mutableprivate |
Default parameter list.
This is declared "mutable" so that it can be created on demand by getValidParameters()
. The SolverManager
interface forces getValidParameters()
to be a const method.
Using the "mutable" keyword is ugly, but the previous caching solution involved static method data in getValidParameters(). That solution made creating multiple instances of this solver in different threads not safe.
Definition at line 331 of file BelosBlockGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 334 of file BelosBlockGCRODRSolMgr.hpp.
|
staticprivate |
Definition at line 335 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 338 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 338 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 338 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 339 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 339 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 339 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 339 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 340 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 340 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 340 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 341 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 342 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 342 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 343 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 343 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 344 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 351 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 351 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 353 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 356 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 359 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 362 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 362 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 365 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 365 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 368 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 369 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 370 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 371 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 372 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 373 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 374 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 375 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Definition at line 376 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Timer for solve()
.
Definition at line 379 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Whether setParameters()
successfully finished setting parameters.
Definition at line 382 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Whether a loss of accuracy was detected during the solve.
Definition at line 385 of file BelosBlockGCRODRSolMgr.hpp.
|
private |
Whether we have generated or regenerated a recycle space yet this solve.
Definition at line 388 of file BelosBlockGCRODRSolMgr.hpp.