|
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 pseudo-block BiCGStab iteration, where the basic BiCGStab algorithm is performed on all of the linear systems simultaneously. More...
#include <BelosBiCGStabIter.hpp>
Public Types | |
| typedef MultiVecTraits < ScalarType, MV > | MVT |
| typedef OperatorTraits < ScalarType, MV, OP > | OPT |
| typedef Teuchos::ScalarTraits < ScalarType > | SCT |
| typedef SCT::magnitudeType | MagnitudeType |
| typedef Teuchos::ScalarTraits < MagnitudeType > | MT |
Public Member Functions | |
Constructors/Destructor | |
| BiCGStabIter (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) | |
| BiCGStabIter constructor with linear problem, solver utilities, and parameter list of solver options. More... | |
| virtual | ~BiCGStabIter () |
| Destructor. More... | |
Solver methods | |
| void | iterate () |
| This method performs BiCGStab 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 | initializeBiCGStab (BiCGStabIterationState< 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... | |
| BiCGStabIterationState < 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... | |
| bool | breakdownDetected () |
| Has breakdown been detected in any 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. More... | |
| bool | isInitialized () |
| States whether the solver has been initialized or not. More... | |
 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 pseudo-block BiCGStab iteration, where the basic BiCGStab algorithm is performed on all of the linear systems simultaneously.
Definition at line 81 of file BelosBiCGStabIter.hpp.
| typedef MultiVecTraits<ScalarType,MV> Belos::BiCGStabIter< ScalarType, MV, OP >::MVT |
Definition at line 88 of file BelosBiCGStabIter.hpp.
| typedef OperatorTraits<ScalarType,MV,OP> Belos::BiCGStabIter< ScalarType, MV, OP >::OPT |
Definition at line 89 of file BelosBiCGStabIter.hpp.
| typedef Teuchos::ScalarTraits<ScalarType> Belos::BiCGStabIter< ScalarType, MV, OP >::SCT |
Definition at line 90 of file BelosBiCGStabIter.hpp.
| typedef SCT::magnitudeType Belos::BiCGStabIter< ScalarType, MV, OP >::MagnitudeType |
Definition at line 91 of file BelosBiCGStabIter.hpp.
| typedef Teuchos::ScalarTraits<MagnitudeType> Belos::BiCGStabIter< ScalarType, MV, OP >::MT |
Definition at line 92 of file BelosBiCGStabIter.hpp.
| Belos::BiCGStabIter< ScalarType, MV, OP >::BiCGStabIter | ( | 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 | ||
| ) |
BiCGStabIter 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 281 of file BelosBiCGStabIter.hpp.
|
inlinevirtual |
Destructor.
Definition at line 108 of file BelosBiCGStabIter.hpp.
|
virtual |
This method performs BiCGStab 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 BiCGStab 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 429 of file BelosBiCGStabIter.hpp.
| void Belos::BiCGStabIter< ScalarType, MV, OP >::initializeBiCGStab | ( | BiCGStabIterationState< ScalarType, MV > & | newstate | ) |
Initialize the solver to an iterate, providing a complete state.
The BiCGStabIter 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. Definition at line 299 of file BelosBiCGStabIter.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 155 of file BelosBiCGStabIter.hpp.
|
inline |
Get the current state of the linear solver.
The data is only valid if isInitialized() == true.
Definition at line 168 of file BelosBiCGStabIter.hpp.
|
inlinevirtual |
Get the current iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 187 of file BelosBiCGStabIter.hpp.
|
inlinevirtual |
Reset the iteration count.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 190 of file BelosBiCGStabIter.hpp.
|
inline |
Get the norms of the residuals native to the solver.
Definition at line 195 of file BelosBiCGStabIter.hpp.
|
inlinevirtual |
Get the current update to the linear system.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 201 of file BelosBiCGStabIter.hpp.
|
inline |
Has breakdown been detected in any linear system.
Definition at line 204 of file BelosBiCGStabIter.hpp.
|
inlinevirtual |
Get a constant reference to the linear problem.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 212 of file BelosBiCGStabIter.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 215 of file BelosBiCGStabIter.hpp.
|
inlinevirtual |
Set the blocksize.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 218 of file BelosBiCGStabIter.hpp.
|
inlinevirtual |
States whether the solver has been initialized or not.
Implements Belos::Iteration< ScalarType, MV, OP >.
Definition at line 224 of file BelosBiCGStabIter.hpp.
1.8.5