42 #ifndef BELOS_FIXEDPOINT_ITER_HPP 43 #define BELOS_FIXEDPOINT_ITER_HPP 59 #include "Teuchos_SerialDenseMatrix.hpp" 60 #include "Teuchos_SerialDenseVector.hpp" 61 #include "Teuchos_ScalarTraits.hpp" 62 #include "Teuchos_ParameterList.hpp" 63 #include "Teuchos_TimeMonitor.hpp" 76 template<
class ScalarType,
class MV,
class OP>
86 typedef Teuchos::ScalarTraits<ScalarType>
SCT;
100 Teuchos::ParameterList ¶ms );
213 const Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > lp_;
214 const Teuchos::RCP<OutputManager<ScalarType> > om_;
215 const Teuchos::RCP<StatusTest<ScalarType,MV,OP> > stest_;
233 bool stateStorageInitialized_;
252 template<
class ScalarType,
class MV,
class OP>
256 Teuchos::ParameterList ¶ms ):
262 stateStorageInitialized_(false),
270 template <
class ScalarType,
class MV,
class OP>
273 if (!stateStorageInitialized_) {
275 Teuchos::RCP<const MV> lhsMV = lp_->getLHS();
276 Teuchos::RCP<const MV> rhsMV = lp_->getRHS();
277 if (lhsMV == Teuchos::null && rhsMV == Teuchos::null) {
278 stateStorageInitialized_ =
false;
285 if (R_ == Teuchos::null) {
287 Teuchos::RCP<const MV> tmp = ( (rhsMV!=Teuchos::null)? rhsMV: lhsMV );
288 TEUCHOS_TEST_FOR_EXCEPTION(tmp == Teuchos::null,std::invalid_argument,
289 "Belos::FixedPointIter::setStateSize(): linear problem does not specify multivectors to clone from.");
295 stateStorageInitialized_ =
true;
302 template <
class ScalarType,
class MV,
class OP>
308 TEUCHOS_TEST_FOR_EXCEPTION(blockSize !=
MVT::GetNumberVecs(*lp_->getCurrRHSVec()), std::invalid_argument,
"Belos::FixedPointIter::setBlockSize size must match # RHS.");
310 TEUCHOS_TEST_FOR_EXCEPTION(blockSize <= 0, std::invalid_argument,
"Belos::FixedPointIter::setBlockSize was passed a non-positive argument.");
311 if (blockSize == numRHS_) {
316 if (blockSize!=numRHS_)
317 stateStorageInitialized_ =
false;
321 initialized_ =
false;
330 template <
class ScalarType,
class MV,
class OP>
334 if (!stateStorageInitialized_)
337 TEUCHOS_TEST_FOR_EXCEPTION(!stateStorageInitialized_,std::invalid_argument,
338 "Belos::FixedPointIter::initialize(): Cannot initialize state storage!");
342 std::string errstr(
"Belos::FixedPointIter::initialize(): Specified multivectors must have a consistent length and width.");
345 const ScalarType one = Teuchos::ScalarTraits<ScalarType>::one();
346 const ScalarType zero = Teuchos::ScalarTraits<ScalarType>::zero();
348 if (newstate.
R != Teuchos::null) {
350 std::invalid_argument, errstr );
353 std::invalid_argument, errstr );
355 std::invalid_argument, errstr );
358 if (newstate.
R != R_) {
365 TEUCHOS_TEST_FOR_EXCEPTION(newstate.
R == Teuchos::null,std::invalid_argument,
366 "Belos::FixedPointIter::initialize(): FixedPointIterationState does not have initial residual.");
369 TEUCHOS_TEST_FOR_EXCEPTION(!lp_->getRightPrec().is_null(),std::invalid_argument,
370 "Belos::FixedPointIter::initialize(): Does not work with right preconditioning");
379 template <
class ScalarType,
class MV,
class OP>
385 if (initialized_ ==
false) {
390 const ScalarType one = Teuchos::ScalarTraits<ScalarType>::one();
394 Teuchos::RCP<MV> cur_soln_vec = lp_->getCurrLHSVec();
395 Teuchos::RCP<const MV> rhs = lp_->getCurrRHSVec();
398 Teuchos::RCP<MV> tmp =
MVT::Clone( *R_, numRHS_ );
403 while (stest_->checkStatus(
this) !=
Passed) {
409 if ( lp_->getLeftPrec() != Teuchos::null ) {
410 lp_->applyLeftPrec( *R_, *Z_ );
419 lp_->updateSolution();
422 lp_->applyOp(*cur_soln_vec,*tmp);
Collection of types and exceptions used within the Belos solvers.
Belos's basic output manager for sending information of select verbosity levels to the appropriate ou...
Class which manages the output and verbosity of the Belos solvers.
MultiVecTraits< ScalarType, MV > MVT
void setBlockSize(int blockSize)
Set the blocksize to be used by the iterative solver in solving this linear problem.
Pure virtual base class for defining the status testing capabilities of Belos.
virtual ~FixedPointIter()
Destructor.
Teuchos::ScalarTraits< ScalarType > SCT
void initializeFixedPoint(FixedPointIterationState< ScalarType, MV > &newstate)
Initialize the solver to an iterate, providing a complete state.
Declaration of basic traits for the multivector type.
int getBlockSize() const
Get the blocksize to be used by the iterative solver in solving this linear problem.
void iterate()
This method performs Fixed Point iterations until the status test indicates the need to stop or an er...
A pure virtual class for defining the status tests for the Belos iterative solvers.
Class which defines basic traits for the operator type.
static int GetNumberVecs(const MV &mv)
Obtain the number of vectors in mv.
static void Assign(const MV &A, MV &mv)
mv := A
static void MvAddMv(const ScalarType alpha, const MV &A, const ScalarType beta, const MV &B, MV &mv)
Replace mv with .
Teuchos::RCP< const MV > getNativeResiduals(std::vector< MagnitudeType > *norms) const
Get the norms of the residuals native to the solver.
int getNumIters() const
Get the current iteration count.
Traits class which defines basic operations on multivectors.
FixedPointIterationState< ScalarType, MV > getState() const
Get the current state of the linear solver.
void resetNumIters(int iter=0)
Reset the iteration count.
static Teuchos::RCP< MV > Clone(const MV &mv, const int numvecs)
Creates a new empty MV containing numvecs columns.
bool isInitialized()
States whether the solver has been initialized or not.
A linear system to solve, and its associated information.
Class which describes the linear problem to be solved by the iterative solver.
FixedPointIter(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)
FixedPointIter constructor with linear problem, solver utilities, and parameter list of solver option...
Teuchos::RCP< const MV > R
The current residual.
const LinearProblem< ScalarType, MV, OP > & getProblem() const
Get a constant reference to the linear problem.
SCT::magnitudeType MagnitudeType
static ptrdiff_t GetGlobalLength(const MV &mv)
Return the number of rows in the given multivector mv.
Structure to contain pointers to FixedPointIteration state variables.
Teuchos::RCP< MV > getCurrentUpdate() const
Get the current update to the linear system.
void initialize()
Initialize the solver with the initial vectors from the linear problem or random data.
Class which defines basic traits for the operator type.
Teuchos::RCP< const MV > Z
The current preconditioned residual.
Pure virtual base class which augments the basic interface for a fixed point linear solver iteration...
Belos header file which uses auto-configuration information to include necessary C++ headers...
This class implements the preconditioned fixed point iteration.
OperatorTraits< ScalarType, MV, OP > OPT