Belos Package Browser (Single Doxygen Collection)
Development
|
This class implements the preconditioned single-reduction Conjugate Gradient (CG) iteration. More...
#include <BelosCGSingleRedIter.hpp>
Public Types | |
typedef MultiVecTraits< ScalarType, MV > | MVT |
typedef OperatorTraits< ScalarType, MV, OP > | OPT |
typedef Teuchos::ScalarTraits< ScalarType > | SCT |
typedef SCT::magnitudeType | MagnitudeType |
Private Member Functions | |
void | setStateSize () |
Method for initalizing the state storage needed by CG. More... | |
Private Attributes | |
const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > | lp_ |
const Teuchos::RCP< OutputManager< ScalarType > > | om_ |
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > | stest_ |
bool | initialized_ |
bool | stateStorageInitialized_ |
int | iter_ |
Teuchos::RCP< MV > | R_ |
Teuchos::RCP< MV > | Z_ |
Teuchos::RCP< MV > | AZ_ |
Teuchos::RCP< MV > | S_ |
Teuchos::RCP< MV > | P_ |
Teuchos::RCP< MV > | AP_ |
Constructors/Destructor | |
CGSingleRedIter (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) | |
CGSingleRedIter constructor with linear problem, solver utilities, and parameter list of solver options. More... | |
virtual | ~CGSingleRedIter () |
Destructor. More... | |
Solver methods | |
void | iterate () |
This method performs CG iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More... | |
void | initializeCG (CGIterationState< 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... | |
CGIterationState< 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 > *norms) 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... | |
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 to be used by the iterative solver in solving this linear problem. More... | |
bool | isInitialized () |
States whether the solver has been initialized or not. More... | |
void | setDoCondEst (bool val) |
Sets whether or not to store the diagonal for condition estimation. More... | |
Teuchos::ArrayView< MagnitudeType > | getDiag () |
Gets the diagonal for condition estimation (NOT_IMPLEMENTED) More... | |
Teuchos::ArrayView< MagnitudeType > | getOffDiag () |
Gets the off-diagonal for condition estimation (NOT_IMPLEMENTED) More... | |
Additional Inherited Members | |
![]() | |
![]() | |
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 preconditioned single-reduction Conjugate Gradient (CG) iteration.
Definition at line 78 of file BelosCGSingleRedIter.hpp.
typedef MultiVecTraits<ScalarType,MV> Belos::CGSingleRedIter< ScalarType, MV, OP >::MVT |
Definition at line 85 of file BelosCGSingleRedIter.hpp.
typedef OperatorTraits<ScalarType,MV,OP> Belos::CGSingleRedIter< ScalarType, MV, OP >::OPT |
Definition at line 86 of file BelosCGSingleRedIter.hpp.
typedef Teuchos::ScalarTraits<ScalarType> Belos::CGSingleRedIter< ScalarType, MV, OP >::SCT |
Definition at line 87 of file BelosCGSingleRedIter.hpp.
typedef SCT::magnitudeType Belos::CGSingleRedIter< ScalarType, MV, OP >::MagnitudeType |
Definition at line 88 of file BelosCGSingleRedIter.hpp.
Belos::CGSingleRedIter< ScalarType, MV, OP >::CGSingleRedIter | ( | 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 | ||
) |
CGSingleRedIter constructor with linear problem, solver utilities, and parameter list of solver options.
This constructor takes pointers required by the linear solver iteration, in addition to a parameter list of options for the linear solver.
Definition at line 281 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Destructor.
Definition at line 104 of file BelosCGSingleRedIter.hpp.
|
virtual |
This method performs CG iterations 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 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 404 of file BelosCGSingleRedIter.hpp.
|
virtual |
Initialize the solver to an iterate, providing a complete state.
The CGSingleRedIter contains a certain amount of state, consisting of the current residual, preconditioned residual, and decent direction.
initialize() gives the user the opportunity to manually set these, although only the current unpreconditioned residual is required.
true
(see post-conditions of isInitialize())newstate
which directly points to the multivectors in the solver, the data is not copied. Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 339 of file BelosCGSingleRedIter.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 144 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Get the current state of the linear solver.
The data is only valid if isInitialized() == true
.
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 156 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 172 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 175 of file BelosCGSingleRedIter.hpp.
|
inline |
Get the norms of the residuals native to the solver.
Definition at line 179 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 184 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 192 of file BelosCGSingleRedIter.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 195 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Set the blocksize to be used by the iterative solver in solving this linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 198 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 204 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Sets whether or not to store the diagonal for condition estimation.
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 207 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Gets the diagonal for condition estimation (NOT_IMPLEMENTED)
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 210 of file BelosCGSingleRedIter.hpp.
|
inlinevirtual |
Gets the off-diagonal for condition estimation (NOT_IMPLEMENTED)
Implements Belos::CGIteration< ScalarType, MV, OP >.
Definition at line 216 of file BelosCGSingleRedIter.hpp.
|
private |
Method for initalizing the state storage needed by CG.
Definition at line 297 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 234 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 235 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 236 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 244 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 249 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 252 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 258 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 261 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 264 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 268 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 271 of file BelosCGSingleRedIter.hpp.
|
private |
Definition at line 274 of file BelosCGSingleRedIter.hpp.