43 #ifndef BELOS_SOLVERMANAGER_HPP 44 #define BELOS_SOLVERMANAGER_HPP 57 #include "Teuchos_Describable.hpp" 67 template <
class ScalarType,
class MV,
class OP>
71 template<
class ScalarType,
class MV,
class OP>
154 <<
" overridden for the class" << this->
description() <<
" yet!");
163 <<
" overridden for the class" << this->
description() <<
" yet!");
220 template<
class ScalarType,
227 template<
class ScalarType,
class MV,
class OP>
242 template<
class ScalarType,
class MV,
class OP>
254 "This solver is not implemented for complex ScalarType." );
258 "This solver is not implemented for complex ScalarType." );
262 "This solver is not implemented for complex ScalarType." );
266 "This solver is not implemented for complex ScalarType." );
270 "This solver is not implemented for complex ScalarType." );
274 "This solver is not implemented for complex ScalarType." );
278 "This solver is not implemented for complex ScalarType." );
282 "This solver is not implemented for complex ScalarType." );
286 "This solver is not implemented for complex ScalarType." );
294 template<
class ScalarType>
312 #ifdef HAVE_TEUCHOS_COMPLEX 316 const static bool value =
true;
320 class LapackSupportsScalar<std::complex<double> > {
322 const static bool value =
true;
324 #endif // HAVE_TEUCHOS_COMPLEX 330 template<
class ScalarType,
333 const bool lapackSupportsScalarType =
341 template<
class ScalarType,
class MV,
class OP>
355 template<
class ScalarType,
class MV,
class OP>
361 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 362 " types for which Teuchos::LAPACK does not have a valid implementation. " 369 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 370 " types for which Teuchos::LAPACK does not have a valid implementation. " 375 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 376 " types for which Teuchos::LAPACK does not have a valid implementation. " 381 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 382 " types for which Teuchos::LAPACK does not have a valid implementation. " 387 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 388 " types for which Teuchos::LAPACK does not have a valid implementation. " 393 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 394 " types for which Teuchos::LAPACK does not have a valid implementation. " 399 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 400 " types for which Teuchos::LAPACK does not have a valid implementation. " 405 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 406 " types for which Teuchos::LAPACK does not have a valid implementation. " 411 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 412 " types for which Teuchos::LAPACK does not have a valid implementation. " 417 (
true, std::logic_error,
"This solver is not implemented for ScalarType" 418 " types for which Teuchos::LAPACK does not have a valid implementation. " 427 template<
class ScalarType,
430 const bool supportsScalarType =
442 template<
class ScalarType,
class MV,
class OP>
457 template<
class ScalarType,
class MV,
class OP>
469 (
true, std::logic_error,
"This solver is not implemented for complex " 470 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 471 "does not have a valid implementation." 476 (
true, std::logic_error,
"This solver is not implemented for complex " 477 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 478 "does not have a valid implementation." 483 (
true, std::logic_error,
"This solver is not implemented for complex " 484 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 485 "does not have a valid implementation." 490 (
true, std::logic_error,
"This solver is not implemented for complex " 491 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 492 "does not have a valid implementation." 497 (
true, std::logic_error,
"This solver is not implemented for complex " 498 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 499 "does not have a valid implementation." 505 (
true, std::logic_error,
"This solver is not implemented for complex " 506 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 507 "does not have a valid implementation." 512 (
true, std::logic_error,
"This solver is not implemented for complex " 513 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 514 "does not have a valid implementation." 519 (
true, std::logic_error,
"This solver is not implemented for complex " 520 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 521 "does not have a valid implementation." 526 (
true, std::logic_error,
"This solver is not implemented for complex " 527 "ScalarType types, or for ScalarType types for which Teuchos::LAPACK " 528 "does not have a valid implementation."
Collection of types and exceptions used within the Belos solvers.
ComboType
The test can be either the AND of all the component tests, or the OR of all the component tests...
virtual Teuchos::RCP< const Teuchos::ParameterList > getCurrentParameters() const
Return the current parameters being used for this solver manager.
virtual void setProblem(const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &)
Set the linear problem that needs to be solved.
virtual void setProblem(const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)=0
Set the linear problem that needs to be solved.
virtual Teuchos::RCP< const Teuchos::ParameterList > getCurrentParameters() const =0
Return the current parameters being used for this solver manager.
virtual ~SolverManagerRequiresLapack()
virtual ReturnType solve()
Iterate until the status test tells us to stop.
virtual int getNumIters() const =0
Get the iteration count for the most recent call to solve().
virtual bool isLOADetected() const
Returns whether a loss of accuracy was detected in the solver.
virtual ReturnType solve()
Iterate until the status test tells us to stop.
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
Return the valid parameters for this solver manager.
SolverManager()
Empty constructor.
virtual ~RealSolverManager()
virtual Teuchos::ScalarTraits< ScalarType >::magnitudeType achievedTol() const
Tolerance achieved by the last solve() invocation.
virtual ~RealSolverManager()
virtual Teuchos::RCP< const Teuchos::ParameterList > getCurrentParameters() const
Return the current parameters being used for this solver manager.
Base class for Belos::SolverManager subclasses which normally can only compile with real ScalarType t...
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
virtual ReturnType solve()=0
Iterate until the status test tells us to stop.
virtual ~SolverManagerRequiresLapack()
virtual void setParameters(const Teuchos::RCP< Teuchos::ParameterList > ¶ms)
Set the parameters to use when solving the linear problem.
virtual void setProblem(const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)
Set the linear problem that needs to be solved.
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
Return the valid parameters for this solver manager.
Base class for Belos::SolverManager subclasses which normally can only compile for real ScalarType...
virtual void reset(const ResetType type)=0
Reset the solver manager.
virtual void setDebugStatusTest(const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &debugStatusTest)
Set user-defined debug status test.
virtual bool isLOADetected() const
Returns whether a loss of accuracy was detected in the solver.
virtual std::string description() const
virtual int getNumIters() const
Get the iteration count for the most recent call to solve().
A pure virtual class for defining the status tests for the Belos iterative solvers.
virtual ~SolverManagerRequiresRealLapack()
virtual void reset(const ResetType type)
Reset the solver manager.
Belos::StatusTest for logically combining several status tests.
virtual const LinearProblem< ScalarType, MV, OP > & getProblem() const
Return a reference to the linear problem being solved by this solver manager.
virtual const LinearProblem< ScalarType, MV, OP > & getProblem() const =0
Return a reference to the linear problem being solved by this solver manager.
virtual void setParameters(const Teuchos::RCP< Teuchos::ParameterList > ¶ms)
Set the parameters to use when solving the linear problem.
ResetType
How to reset the solver.
SolverManagerRequiresLapack()
#define TEUCHOS_TEST_FOR_EXCEPT_MSG(throw_exception_test, msg)
virtual void setUserConvStatusTest(const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &userConvStatusTest, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &comboType=StatusTestCombo< ScalarType, MV, OP >::SEQ)
Set user-defined convergence status test.
virtual void setProblem(const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)
Set the linear problem that needs to be solved.
SolverManagerRequiresRealLapack()
A linear system to solve, and its associated information.
virtual int getNumIters() const
Get the iteration count for the most recent call to solve().
Class which describes the linear problem to be solved by the iterative solver.
virtual void setParameters(const Teuchos::RCP< Teuchos::ParameterList > ¶ms)
Set the parameters to use when solving the linear problem.
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
Return the valid parameters for this solver manager.
virtual int getNumIters() const
Get the iteration count for the most recent call to solve().
Type traits class that says whether Teuchos::LAPACK has a valid implementation for the given ScalarTy...
ReturnType
Whether the Belos solve converged for all linear systems.
The Belos::SolverManager is a templated virtual base class that defines the basic interface that any ...
virtual void reset(const ResetType type)
Reset the solver manager.
virtual void reset(const ResetType type)
Reset the solver manager.
virtual const LinearProblem< ScalarType, MV, OP > & getProblem() const
Return a reference to the linear problem being solved by this solver manager.
virtual Teuchos::RCP< SolverManager< ScalarType, MV, OP > > clone() const =0
clone the solver manager.
virtual bool isLOADetected() const
Returns whether a loss of accuracy was detected in the solver.
virtual ~SolverManagerRequiresRealLapack()
virtual void setParameters(const Teuchos::RCP< Teuchos::ParameterList > ¶ms)=0
Set the parameters to use when solving the linear problem.
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const =0
Return the valid parameters for this solver manager.
SolverManagerRequiresLapack()
virtual bool isLOADetected() const =0
Returns whether a loss of accuracy was detected in the solver.
A class for extending the status testing capabilities of Belos via logical combinations.
SolverManagerRequiresRealLapack()
virtual ReturnType solve()
Iterate until the status test tells us to stop.
Base class for Belos::SolverManager subclasses which normally can only compile with ScalarType types ...
virtual Teuchos::RCP< const Teuchos::ParameterList > getCurrentParameters() const
Return the current parameters being used for this solver manager.
Belos header file which uses auto-configuration information to include necessary C++ headers...
virtual ~SolverManager()
Destructor.
virtual const LinearProblem< ScalarType, MV, OP > & getProblem() const
Return a reference to the linear problem being solved by this solver manager.