|
Belos
Version of the Day
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Belos
Version of the Day
|
This class implements the stochastic pseudo-block CG iteration, where the basic stochastic CG algorithm is performed on all of the linear systems simultaneously. The implementation is a pseudo-block generalization of the stochastic CG algorithm of Parker and Fox, SISC 2012. More...
#include <BelosPseudoBlockStochasticCGIter.hpp>
Public Types | |
| typedef MultiVecTraits < ScalarType, MV > | MVT |
| typedef OperatorTraits < ScalarType, MV, OP > | OPT |
| typedef Teuchos::ScalarTraits < ScalarType > | SCT |
| typedef SCT::magnitudeType | MagnitudeType |
Public Member Functions | |
Constructors/Destructor | |
| PseudoBlockStochasticCGIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, Teuchos::ParameterList ¶ms) | |
| PseudoBlockStochasticCGIter constructor with linear problem, solver utilities, and parameter list of solver options. More... | |
| virtual | ~PseudoBlockStochasticCGIter () |
| Destructor. More... | |
Solver methods | |
| void | iterate () |
| This method performs stochastic CG iterations on each linear system until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More... | |
| void | initializeCG (StochasticCGIterationState< ScalarType, MV > &newstate) |
| Initialize the solver to an iterate, providing a complete state. More... | |
| void | initialize () |
| Initialize the solver with the initial vectors from the linear problem or random data. More... | |
| StochasticCGIterationState < ScalarType, MV > | getState () const |
| Get the current state of the linear solver. More... | |
Status methods | |
| int | getNumIters () const |
| Get the current iteration count. More... | |
| void | resetNumIters (int iter=0) |
| Reset the iteration count. More... | |
| Teuchos::RCP< const MV > | getNativeResiduals (std::vector< MagnitudeType > *) const |
| Get the norms of the residuals native to the solver. More... | |
| Teuchos::RCP< MV > | getCurrentUpdate () const |
| Get the current update to the linear system. More... | |
| Teuchos::RCP< MV > | getStochasticVector () const |
| Get the stochastic vector. More... | |
Accessor methods | |
| const LinearProblem < ScalarType, MV, OP > & | getProblem () const |
| Get a constant reference to the linear problem. More... | |
| int | getBlockSize () const |
| Get the blocksize to be used by the iterative solver in solving this linear problem. More... | |
| void | setBlockSize (int blockSize) |
| Set the blocksize. More... | |
| bool | isInitialized () |
| States whether the solver has been initialized or not. More... | |
State methods | |
 Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP > | |
| Iteration () | |
| Default Constructor. More... | |
| virtual | ~Iteration () |
| Destructor. More... | |
| virtual Teuchos::RCP< const MV > | getNativeResiduals (std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > *norms) const =0 |
| Get the residuals native to the solver. More... | |
This class implements the stochastic pseudo-block CG iteration, where the basic stochastic CG algorithm is performed on all of the linear systems simultaneously. The implementation is a pseudo-block generalization of the stochastic CG algorithm of Parker and Fox, SISC 2012.
THIS CODE IS CURRENTLY EXPERIMENTAL. CAVEAT EMPTOR.
Definition at line 53 of file BelosPseudoBlockStochasticCGIter.hpp.
| typedef MultiVecTraits<ScalarType,MV> Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >::MVT |
Definition at line 60 of file BelosPseudoBlockStochasticCGIter.hpp.
| typedef OperatorTraits<ScalarType,MV,OP> Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >::OPT |
Definition at line 61 of file BelosPseudoBlockStochasticCGIter.hpp.
| typedef Teuchos::ScalarTraits<ScalarType> Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >::SCT |
Definition at line 62 of file BelosPseudoBlockStochasticCGIter.hpp.
| typedef SCT::magnitudeType Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >::MagnitudeType |
Definition at line 63 of file BelosPseudoBlockStochasticCGIter.hpp.
| Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >::PseudoBlockStochasticCGIter | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
| const Teuchos::RCP< OutputManager< ScalarType > > & | printer, | ||
| const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | tester, | ||
| Teuchos::ParameterList & | params | ||
| ) |
PseudoBlockStochasticCGIter constructor with linear problem, solver utilities, and parameter list of solver options.
This constructor takes pointers required by the linear solver, in addition to a parameter list of options for the linear solver.
Definition at line 291 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Destructor.
Definition at line 79 of file BelosPseudoBlockStochasticCGIter.hpp.
|
virtual |
This method performs stochastic CG iterations on each linear system until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).
iterate() will first determine whether the solver is initialized; if not, it will call initialize() using default arguments. After initialization, the solver performs stochastic CG iterations until the status test evaluates as Passed, at which point the method returns to the caller.
The status test is queried at the beginning of the iteration.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 391 of file BelosPseudoBlockStochasticCGIter.hpp.
|
virtual |
Initialize the solver to an iterate, providing a complete state.
The PseudoBlockStochasticCGIter contains a certain amount of state, consisting of the current direction vectors and residuals.
initialize() gives the user the opportunity to manually set these, although this must be done with caution, abiding by the rules given below.
true (see post-conditions of isInitialize())The user has the option of specifying any component of the state using initialize(). However, these arguments are assumed to match the post-conditions specified under isInitialized(). Any necessary component of the state not given to initialize() will be generated.
newstate which directly points to the multivectors in the solver, the data is not copied. Implements Belos::StochasticCGIteration< ScalarType, MV, OP >.
Definition at line 309 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Initialize the solver with the initial vectors from the linear problem or random data.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 126 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Get the current state of the linear solver.
The data is only valid if isInitialized() == true.
Implements Belos::StochasticCGIteration< ScalarType, MV, OP >.
Definition at line 139 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 156 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 159 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inline |
Get the norms of the residuals native to the solver.
Definition at line 163 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 168 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inline |
Get the stochastic vector.
Definition at line 171 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 179 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Get the blocksize to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 182 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
Set the blocksize.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 185 of file BelosPseudoBlockStochasticCGIter.hpp.
|
inlinevirtual |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 191 of file BelosPseudoBlockStochasticCGIter.hpp.
1.8.5