Belos Namespace Reference


Classes

class  BlockCGIter
 This class implements the block, preconditioned Conjugate Gradient (CG) iteration. More...
class  BlockCGSolMgrLinearProblemFailure
 BlockCGSolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  BlockCGSolMgrOrthoFailure
 BlockCGSolMgrOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the initial basis vectors. More...
class  BlockCGSolMgr
 The Belos::BlockCGSolMgr provides a powerful and fully-featured solver manager over the CG and BlockCG linear solver. More...
class  BlockFGmresIter
 This class implements the block flexible GMRES iteration, where a block Krylov subspace is constructed. The QR decomposition of block, upper Hessenberg matrix is performed each iteration to update the least squares system and give the current linear system residuals. More...
class  BlockGmresIter
 This class implements the block GMRES iteration, where a block Krylov subspace is constructed. The QR decomposition of block, upper Hessenberg matrix is performed each iteration to update the least squares system and give the current linear system residuals. More...
class  BlockGmresSolMgrLinearProblemFailure
 BlockGmresSolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  BlockGmresSolMgrOrthoFailure
 BlockGmresSolMgrOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the initial basis vectors. More...
class  BlockGmresSolMgr
 The Belos::BlockGmresSolMgr provides a powerful and fully-featured solver manager over the BlockGmres linear solver. More...
class  CGIter
 This class implements the preconditioned Conjugate Gradient (CG) iteration. More...
struct  CGIterationState
 Structure to contain pointers to CGIteration state variables. More...
class  CGIterationInitFailure
 CGIterationInitFailure is thrown when the CGIteration object is unable to generate an initial iterate in the CGIteration::initialize() routine. More...
class  CGIterateFailure
 CGIterateFailure is thrown when the CGIteration object is unable to compute the next iterate in the CGIteration::iterate() routine. More...
class  CGIterationOrthoFailure
 CGIterationOrthoFailure is thrown when the CGIteration object is unable to compute independent direction vectors in the CGIteration::iterate() routine. More...
class  CGIterationLAPACKFailure
 CGIterationLAPACKFailure is thrown when a nonzero return value is passed back from an LAPACK routine. More...
class  CGIteration
class  DGKSOrthoManager
 An implementation of the Belos::MatOrthoManager that performs orthogonalization using (potentially) multiple steps of classical Gram-Schmidt. More...
struct  GCRODRIterState
 Structure to contain pointers to GCRODRIter state variables. More...
class  GCRODRIterInitFailure
 GCRODRIterInitFailure is thrown when the GCRODRIter object is unable to generate an initial iterate in the GCRODRIter::initialize() routine. More...
class  GCRODRIterOrthoFailure
 GCRODRIterOrthoFailure is thrown when the GCRODRIter object is unable to compute independent direction vectors in the GCRODRIter::iterate() routine. More...
class  GCRODRIter
 This class implements the GCRODR iteration, where a single-stdvector Krylov subspace is constructed. The QR decomposition of block, upper Hessenberg matrix is performed each iteration to update the least squares system and give the current linear system residuals. More...
class  GCRODRSolMgrLinearProblemFailure
 GCRODRSolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  GCRODRSolMgrOrthoFailure
 GCRODRSolMgrOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the initial basis vectors. More...
class  GCRODRSolMgrLAPACKFailure
 GCRODRSolMgrLAPACKFailure is thrown when a nonzero value is retuned from an LAPACK call. More...
class  GCRODRSolMgrRecyclingFailure
 GCRODRSolMgrRecyclingFailure is thrown when any problem occurs in using/creating the recycling subspace. More...
class  GCRODRSolMgr
 The Belos::GCRODRSolMgr provides a powerful and fully-featured solver manager over the GCRODR linear solver. More...
struct  GmresIterationState
 Structure to contain pointers to GmresIteration state variables. More...
class  GmresIterationInitFailure
 GmresIterationInitFailure is thrown when the GmresIteration object is unable to generate an initial iterate in the GmresIteration::initialize() routine. More...
class  GmresIterationOrthoFailure
 GmresIterationOrthoFailure is thrown when the GmresIteration object is unable to compute independent direction vectors in the GmresIteration::iterate() routine. More...
class  GmresIterationLAPACKFailure
 GmresIterationLAPACKFailure is thrown when a nonzero return value is passed back from an LAPACK routine. More...
class  GmresIteration
class  GmresPolyOp
 Belos's class for applying the GMRES polynomial operator that is used by the hybrid-GMRES linear solver. More...
class  OperatorTraits< ScalarType, MV, GmresPolyOp< ScalarType, MV, OP > >
 Template specialization of Belos::OperatorTraits class using Belos::GmresPolyOp. More...
class  GmresPolySolMgrLinearProblemFailure
 GmresPolySolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  GmresPolySolMgrPolynomialFailure
 GmresPolySolMgrPolynomialFailure is thrown when their is a problem generating the GMRES polynomial for this linear problem. More...
class  GmresPolySolMgrOrthoFailure
 GmresPolySolMgrOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the initial basis vectors. More...
class  GmresPolySolMgr
 The Belos::GmresPolySolMgr provides a powerful and fully-featured solver manager over the hybrid block GMRES linear solver. More...
class  ICGSOrthoManager
 An implementation of the Belos::MatOrthoManager that performs orthogonalization using multiple steps of classical Gram-Schmidt. More...
class  IMGSOrthoManager
 An implementation of the Belos::MatOrthoManager that performs orthogonalization using multiple steps of modified Gram-Schmidt. More...
class  Iteration
class  LinearProblemError
 Exception thrown to signal error with the Belos::LinearProblem object. More...
class  LinearProblem
 The Belos::LinearProblem class is a wrapper that encapsulates the general information needed for solving a linear system of equations. More...
class  MatOrthoManager
 Belos's templated virtual class for providing routines for orthogonalization and orthonormzalition of multivectors using matrix-based inner products. More...
class  MultiVec
 Belos's templated pure virtual class for constructing multivectors that are used by the linear solver. More...
class  MultiVecTraits< ScalarType, MultiVec< ScalarType > >
struct  UndefinedMultiVecTraits
 This is the default struct used by MultiVecTraits<ScalarType, MV> class to produce a compile time error when the specialization does not exist for multivector type MV. More...
class  MultiVecTraits
 Virtual base class which defines basic traits for the multi-vector type. More...
class  Operator
 Belos's templated pure virtual class for constructing the operator that is used by the linear solver. More...
class  OperatorTraits< ScalarType, MultiVec< ScalarType >, Operator< ScalarType > >
 Template specialization of Belos::OperatorTraits class using Belos::Operator and Belos::MultiVec virtual base classes. More...
struct  UndefinedOperatorTraits
class  OperatorTraits
 Virtual base class which defines basic traits for the operator type. More...
class  OrthoError
 Exception thrown to signal error in an orthogonalization manager method. More...
class  OrthoManager
 Belos's templated virtual class for providing routines for orthogonalization and orthonormzalition of multivectors. More...
class  OutputManager
 Belos's basic output manager for sending information of select verbosity levels to the appropriate output stream. More...
struct  PCPGIterState
 Structure to contain pointers to PCPGIter state variables. More...
class  PCPGIterInitFailure
 PCPGIterInitFailure is thrown when the PCPGIter object is unable to generate an initial iterate in the PCPGIter::initialize() routine. More...
class  PCPGIterateFailure
 PCPGIterateFailure is thrown when the PCPGIter object breaks down. More...
class  PCPGIterOrthoFailure
 PCPGIterOrthoFailure is thrown when the PCPGIter object is unable to compute independent direction vectors in the PCPGIter::iterate() routine. More...
class  PCPGIterLAPACKFailure
 PCPGIterLAPACKFailure is thrown when a nonzero return value is passed back from an LAPACK routine. More...
class  PCPGIter
 This class implements the PCPG iteration, where a single-stdvector Krylov subspace is constructed. The documentation refers to blocks, but note that at this point, all blocks have unit dimension. More...
class  PCPGSolMgrLinearProblemFailure
 PCPGSolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  PCPGSolMgrOrthoFailure
 PCPGSolMgrOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the initial basis vectors. More...
class  PCPGSolMgrLAPACKFailure
 PCPGSolMgrLAPACKFailure is thrown when a nonzero value is retuned from an LAPACK call. More...
class  PCPGSolMgrRecyclingFailure
 PCPGSolMgrRecyclingFailure is thrown when any problem occurs in using/creating the recycling subspace. More...
class  PCPGSolMgr
 The Belos::PCPGSolMgr manages the PCPG linear solver. Three Hypotheses: First users must ensure that for each linear system has the same coefficient matrix! Second the seed space is invariant during an individual linear system solve. Third, due to finite precision arithmetic, the off-diaognal "P'AP" terms grow. More...
class  PseudoBlockCGIter
 This class implements the pseudo-block CG iteration, where the basic CG algorithm is performed on all of the linear systems simultaneously. More...
class  PseudoBlockCGSolMgrLinearProblemFailure
 PseudoBlockCGSolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  PseudoBlockCGSolMgrOrthoFailure
 PseudoBlockCGSolMgrOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the initial basis vectors. More...
class  PseudoBlockCGSolMgr
 The Belos::PseudoBlockCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration. More...
struct  PseudoBlockGmresIterState
 Structure to contain pointers to PseudoBlockGmresIter state variables. More...
class  PseudoBlockGmresIterInitFailure
 PseudoBlockGmresIterInitFailure is thrown when the PseudoBlockGmresIter object is unable to generate an initial iterate in the PseudoBlockGmresIter::initialize() routine. More...
class  PseudoBlockGmresIterOrthoFailure
 PseudoBlockGmresIterOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the new basis vectors. More...
class  PseudoBlockGmresIter
 This class implements the pseudo-block GMRES iteration, where a block Krylov subspace is constructed for all of the linear systems simultaneously. The QR decomposition of each block, upper Hessenberg matrix is performed each iteration to update the least squares system and give the current linear system residuals. More...
class  PseudoBlockGmresSolMgrLinearProblemFailure
 PseudoBlockGmresSolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  PseudoBlockGmresSolMgrOrthoFailure
 PseudoBlockGmresSolMgrOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the initial basis vectors. More...
class  PseudoBlockGmresSolMgr
 The Belos::PseudoBlockGmresSolMgr provides a powerful and fully-featured solver manager over the pseudo-block GMRES iteration. More...
struct  RCGIterState
 Structure to contain pointers to RCGIter state variables. More...
class  RCGIterInitFailure
 RCGIterInitFailure is thrown when the RCGIter object is unable to generate an initial iterate in the RCGIter::initialize() routine. More...
class  RCGIterFailure
 RCGIterFailure is thrown when the RCGIter object is unable to compute the next iterate in the RCGIter::iterate() routine. More...
class  RCGIterOrthoFailure
 RCGIterOrthoFailure is thrown when the RCGIter object is unable to compute independent direction vectors in the RCGIter::iterate() routine. More...
class  RCGIterLAPACKFailure
 RCGIterLAPACKFailure is thrown when a nonzero return value is passed back from an LAPACK routine. More...
class  RCGIter
 This class implements the RCG iteration, where a single-stdvector Krylov subspace is constructed. More...
class  RCGSolMgrLinearProblemFailure
 RCGSolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  RCGSolMgrLAPACKFailure
 RCGSolMgrLAPACKFailure is thrown when a nonzero value is retuned from an LAPACK call. More...
class  RCGSolMgrRecyclingFailure
 RCGSolMgrRecyclingFailure is thrown when any problem occurs in using/creating the recycling subspace. More...
class  RCGSolMgr
 The Belos::RCGSolMgr provides a powerful and fully-featured solver manager over the RCG (Recycling Conjugate Gradient) linear solver. More...
class  SolverManager
 The Belos::SolverManager is a templated virtual base class that defines the basic interface that any solver manager will support. More...
class  StatusTestError
 Exception thrown to signal error in a status test during Belos::StatusTest::checkStatus(). More...
class  StatusTest
 A pure virtual class for defining the status tests for the Belos iterative solvers. More...
class  StatusTestCombo
 A class for extending the status testing capabilities of Belos via logical combinations. More...
class  StatusTestGeneralOutput
 A special StatusTest for printing other status tests. More...
class  StatusTestGenResNorm
 An implementation of StatusTestResNorm using a family of residual norms. More...
class  StatusTestImpResNorm
 An implementation of StatusTest using an implicit residual norm test with a check for loss of accuracy. More...
class  StatusTestMaxIters
 A Belos::StatusTest class for specifying a maximum number of iterations. More...
class  StatusTestOutput
 A virtual base class for StatusTest that print other status tests. More...
class  StatusTestOutputFactory
 A factory class for generating StatusTestOutput objects. More...
class  StatusTestResNorm
 An abstract class of StatusTest for stopping criteria using residual norms. More...
class  StatusTestResNormOutput
 A special StatusTest for printing other status tests in a simple format. More...
struct  TFQMRIterState
 Structure to contain pointers to TFQMRIter state variables. More...
class  TFQMRIterInitFailure
 TFQMRIterInitFailure is thrown when the TFQMRIter object is unable to generate an initial iterate in the TFQMRIter::initialize() routine. More...
class  TFQMRIterateFailure
 TFQMRIterateFailure is thrown when the TFQMRIter object is unable to compute the next iterate in the TFQMRIter::iterate() routine. More...
class  TFQMRIter
 This class implements the preconditioned transpose-free QMR algorithm for solving non-Hermitian linear systems of equations Ax = b, where b is the right-hand side std::vector and x is the corresponding solution. More...
class  TFQMRSolMgrLinearProblemFailure
 TFQMRSolMgrLinearProblemFailure is thrown when the linear problem is not setup (i.e. More...
class  TFQMRSolMgrOrthoFailure
 TFQMRSolMgrOrthoFailure is thrown when the orthogonalization manager is unable to generate orthonormal columns from the initial basis vectors. More...
class  TFQMRSolMgr
 The Belos::TFQMRSolMgr provides a powerful and fully-featured solver manager over the TFQMR linear solver. More...
class  BelosError
 An std::exception class parent to all Belos exceptions. More...
class  MPIFinalize

Enumerations

enum  ETrans { NOTRANS = 0, TRANS = 1, CONJTRANS = 2 }
 Enumerated list for describing the application of an operator. More...
enum  NormType { OneNorm, TwoNorm, InfNorm }
 Enumerated list for describing the multivector norm type. More...
enum  ScaleType {
  NormOfRHS, NormOfInitRes, NormOfPrecInitRes, None,
  UserProvided
}
 Enumerated list for describing the type of scaling used on the residual. More...
enum  OutputType { General, Brief }
 Enumerated list for describing the style of output used to display status test information. More...
enum  ReturnType { Converged, Unconverged }
enum  StatusType { Passed = 0x1, Failed = 0x2, Undefined = 0x4 }
enum  ResetType { Problem = 0x1, RecycleSubspace = 0x2 }
enum  ConjType { NO_CONJ, CONJ }
enum  MsgType {
  Errors = 0, Warnings = 0x1, IterationDetails = 0x2, OrthoDetails = 0x4,
  FinalSummary = 0x8, TimingDetails = 0x10, StatusTestDetails = 0x20, Debug = 0x40
}
 Enumerated list of available message types recognized by the linear solvers. More...

Functions

std::string Belos_Version ()
template<class ScalarType, class MV>
bool TestMultiVecTraits (const Teuchos::RCP< OutputManager< ScalarType > > &om, const Teuchos::RCP< const MV > &A)
 This is a function to test the correctness of a MultiVecTraits specialization and multivector implementation.
template<class ScalarType, class MV, class OP>
bool TestOperatorTraits (const Teuchos::RCP< OutputManager< ScalarType > > &om, const Teuchos::RCP< const MV > &A, const Teuchos::RCP< const OP > &M)
 This function tests the correctness of an operator implementation with respect to an OperatorTraits specialization.
const char * toString (const StatusType status)


Enumeration Type Documentation

enum Belos::ETrans

Enumerated list for describing the application of an operator.

Enumerator:
NOTRANS  The operator should not be transposed during this application
TRANS  The operator should be transposed during this application
CONJTRANS  The operator should be transposed and conjugated during this application

Definition at line 59 of file BelosTypes.hpp.

enum Belos::NormType

Enumerated list for describing the multivector norm type.

Enumerator:
OneNorm  Compute the one-norm $\sum_{i=1}^{n}(|x_i w_i|)$ for each std::vector.
TwoNorm  Compute the two-norm $\sqrt(\sum_{i=1}^{n}((x_i w_i)^2))$ for each std::vector.
InfNorm  Compute the infinity-norm $\max_{i=1}^{n}\{|x_i w_i|\}$ for each std::vector.

Definition at line 68 of file BelosTypes.hpp.

enum Belos::ScaleType

Enumerated list for describing the type of scaling used on the residual.

Enumerator:
NormOfRHS  Use the norm of the right-hand-side.
NormOfInitRes  Use the initial residual vector.
NormOfPrecInitRes  Use the preconditioned initial residual vector.
None  Use unscaled residual.
UserProvided  User provides an explicit value that the norm of the residual will be divided by.

Definition at line 77 of file BelosTypes.hpp.

enum Belos::OutputType

Enumerated list for describing the style of output used to display status test information.

Enumerator:
General  Extensive output of status test information.
Brief  Simple output of current residual information.

Definition at line 89 of file BelosTypes.hpp.

enum Belos::ReturnType

When the solve() method of any Belos::SolverManager is called a variable of type Belos::ReturnType is returned indicating whether the solver manager sucessfully computed solutions to the linear system.

Enumerator:
Converged  Convergence was reached for all linear systems.
Unconverged  Convergence was not reached for some or all linear systems.

Definition at line 100 of file BelosTypes.hpp.

enum Belos::StatusType

When the CheckStatus and GetStatus methods of Belos::StatusTest objects are called a variable of type Belos::StatusType is returned.

Enumerator:
Passed  Some event occured, the iteration needs to stop.
Failed  No event has occurred requiring the iteration to stop.
Undefined  Status test has not been checked yet.

Definition at line 110 of file BelosTypes.hpp.

enum Belos::ResetType

Enumerator:
Problem  Reset the linear problem inside the solver.
RecycleSubspace  Destroy any existing subspace inside the solver.

Definition at line 115 of file BelosTypes.hpp.

enum Belos::ConjType

When the MvTransMv and MvDot methods of Belos::MultiVec are called, the require the knowledge of whether the conjugate of the transpose should be computed.

Enumerator:
NO_CONJ  Not conjugated
CONJ  Conjugated

Definition at line 144 of file BelosTypes.hpp.

enum Belos::MsgType

Enumerated list of available message types recognized by the linear solvers.

Enumerator:
Errors  Errors [ always printed ]
Warnings  Internal warnings
IterationDetails  Approximate/exact residuals
OrthoDetails  Orthogonalization/orthonormalization details
FinalSummary  Final computational summary
TimingDetails  Timing details
StatusTestDetails  Status test details
Debug  Debugging information

Definition at line 153 of file BelosTypes.hpp.


Function Documentation

std::string Belos::Belos_Version (  ) 

Definition at line 37 of file BelosVersion.cpp.

template<class ScalarType, class MV>
bool Belos::TestMultiVecTraits ( const Teuchos::RCP< OutputManager< ScalarType > > &  om,
const Teuchos::RCP< const MV > &  A 
)

This is a function to test the correctness of a MultiVecTraits specialization and multivector implementation.

Returns:
Status of the test: true is success, false is error

Definition at line 59 of file BelosMVOPTester.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::TestOperatorTraits ( const Teuchos::RCP< OutputManager< ScalarType > > &  om,
const Teuchos::RCP< const MV > &  A,
const Teuchos::RCP< const OP > &  M 
)

This function tests the correctness of an operator implementation with respect to an OperatorTraits specialization.

Returns:
Status of the test: true is successful, false otherwise.

Definition at line 1386 of file BelosMVOPTester.hpp.

const char* Belos::toString ( const StatusType  status  )  [inline]

Return a std::string name for a StatusType object.

Definition at line 123 of file BelosTypes.hpp.


Generated on Tue Jul 13 09:27:09 2010 for Belos Package Browser (Single Doxygen Collection) by  doxygen 1.4.7