Belos Namespace Reference

Classes

class Belos::BlockCG< ScalarType, MV, OP >

This class implements the preconditioned Conjugate Gradient algorithm for solving real symmetric positive definite linear systems of equations AX = B, where B is a matrix containing one or more right-hand sides. More...

class Belos::BlockGmres< ScalarType, MV, OP >

This class implements the Restarted Block GMRES algorithm for solving real nonsymmetric linear systems of equations AX = B, where B is a matrix containing one or more right-hand sides, and X is the matrix of corresponding solutions. More...

class Belos::CG< ScalarType, MV, OP >

This class implements the preconditioned Conjugate Gradient algorithm for solving real symmetric positive definite linear systems of equations Ax = b, where b is the right-hand side vector and x is the corresponding solution. More...

class Belos::EpetraMultiVec

class Belos::EpetraOp

class Belos::EpetraPrecOp

class Belos::MultiVecTraits< double, Epetra_MultiVector >

class Belos::OperatorTraits< double, Epetra_MultiVector, Epetra_Operator >

class Belos::EpetraOperator

This class provides and interface to the Epetra_Operator class, so Belos can be integrated into other codes as an abstract operator. More...

class Belos::IterativeSolver< ScalarType, MV, OP >

The Belos::IterativeSolver is a templated virtual base class that defines the basic interface that any linear solver will support. More...

class Belos::LinearProblem< ScalarType, MV, OP >

The Belos::LinearProblem class is a wrapper that encapsulates the general information needed for solving a linear system of equations. The general information is being held as either Belos::Operator or Belos::MultiVec objects. More...

class Belos::MultiVec< ScalarType >

Belos's templated pure virtual class for constructing multivectors that are used by the eigensolver. More...

class Belos::MultiVecTraits< ScalarType, MultiVec< ScalarType > >

struct Belos::UndefinedMultiVecTraits< ScalarType, MV >

class Belos::MultiVecTraits< ScalarType, MV >

class Belos::Operator< ScalarType >

Belos's templated pure virtual class for constructing the operator that is used by the linear solver. More...

class Belos::OperatorTraits< ScalarType, MultiVec< ScalarType >, Operator< ScalarType > >

Template specialization of Belos::OperatorTraits class using Belos::Operator and Belos::MultiVec virtual base classes. More...

struct Belos::UndefinedOperatorTraits< ScalarType, MV, OP >

class Belos::OperatorTraits< ScalarType, MV, OP >

class Belos::OutputManager< ScalarType >

Belos's basic output manager for sending information of select verbosity levels to the appropriate output stream. More...

class Belos::StatusTest< ScalarType, MV, OP >

A pure virtual class for defining the status tests for the Belos iterative solvers. More...

class Belos::StatusTestCombo< ScalarType, MV, OP >

A class for extending the status testing capabilities of Belos via logical combinations. More...

class Belos::StatusTestMaxIters< ScalarType, MV, OP >

A Belos::StatusTest class for specifying a maximum number of iterations. More...

class Belos::StatusTestMaxRestarts< ScalarType, MV, OP >

A Belos::StatusTest class for specifying a maximum number of restarts. More...

class Belos::StatusTestOutputter< ScalarType, MV, OP >

StatusTest implementation that does nothing but outputting. More...

class Belos::StatusTestResNorm< ScalarType, MV, OP >

An implementation of StatusTest using a family of residual norms. More...

class Belos::TFQMR< ScalarType, MV, OP >

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 vector and x is the corresponding solution. More...

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 ReturnType { Ok, Undefined, Error }

Any method in the Belos abstract interfaces may fail or not be defined. This information needs to be passed back to the algorithm or user. This will be used by the algorithm or user to decide what should be done. More...

enum StatusType {
  Unchecked = 2, Unconverged = 1, Converged = 0, Failed = -1,
  NaN = -2
}

enum ConjType { NO_CONJ, CONJ }

enum MsgType {
  Errors = 0, Warnings = 0x1, IterationDetails = 0x2, OrthoDetails = 0x4,
  FinalSummary = 0x8, TimingDetails = 0x10, Debug = 0x20
}

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

Functions

string Belos_Version ()

template<class ScalarType, class MV>

ReturnType TestMultiVecTraits (const Teuchos::RefCountPtr< OutputManager< ScalarType > > &om, const Teuchos::RefCountPtr< const MV > &A)

template<class ScalarType, class MV, class OP>

ReturnType TestOperatorTraits (const Teuchos::RefCountPtr< OutputManager< ScalarType > > &om, const Teuchos::RefCountPtr< const MV > &A, const Teuchos::RefCountPtr< const OP > &M)

const char * toString (const StatusType status)

Enumeration Type Documentation

enum ETrans

Enumerated list for describing the application of an operator.

Enumeration values:

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 44 of file BelosTypes.hpp.

enum NormType

Enumerated list for describing the multivector norm type.

Enumeration values:

OneNorm Compute the one-norm $\sum_{i=1}^{n}(|x_i w_i|)$ for each vector.

TwoNorm Compute the two-norm * $\sqrt(\sum_{i=1}^{n}((x_i w_i)^2)$ for each vector.

InfNorm Compute the infinity-norm $(\max_{i=1}^{n}\{|x_i w_i|\})$ for each vector.

Definition at line 53 of file BelosTypes.hpp.

enum ReturnType

Any method in the Belos abstract interfaces may fail or not be defined. This information needs to be passed back to the algorithm or user. This will be used by the algorithm or user to decide what should be done.

Enumeration values:

Ok Computation completed sucessfully

Undefined This operation is not defined

Error This operator returned an error

Definition at line 65 of file BelosTypes.hpp.

enum StatusType

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

Unchecked Initial state of status

Unconverged Convergence is not reached.

Converged Convergence is reached.

Failed Some failure occured. Should stop

NaN Result from test contains a NaN value. Should stop

Definition at line 76 of file BelosTypes.hpp.

enum 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.
Enumeration values:

NO_CONJ Not conjugated

CONJ Conjugated

Definition at line 113 of file BelosTypes.hpp.

enum MsgType

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

Enumeration values:

Errors Errors [ always printed ]

Warnings Internal warnings

IterationDetails Approximate/exact residuals

OrthoDetails Orthogonalization/orthonormalization details

FinalSummary Final computational summary

TimingDetails Timing details

Debug Debugging information

Definition at line 122 of file BelosTypes.hpp.

Function Documentation

string Belos::Belos_Version ( )

Definition at line 37 of file BelosVersion.cpp.

template<class ScalarType, class MV>

ReturnType TestMultiVecTraits ( const Teuchos::RefCountPtr< OutputManager< ScalarType > > & om,

const Teuchos::RefCountPtr< const MV > & A

)

Definition at line 56 of file BelosMVOPTester.hpp.

template<class ScalarType, class MV, class OP>

ReturnType TestOperatorTraits ( const Teuchos::RefCountPtr< OutputManager< ScalarType > > & om,

const Teuchos::RefCountPtr< const MV > & A,

const Teuchos::RefCountPtr< const OP > & M

)

Definition at line 1412 of file BelosMVOPTester.hpp.

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

Return a string name for a StatusType object.
Definition at line 88 of file BelosTypes.hpp.

Generated on Thu Sep 18 12:30:12 2008 for Belos by

1.3.9.1


Classes
class	Belos::BlockCG< ScalarType, MV, OP >
	This class implements the preconditioned Conjugate Gradient algorithm for solving real symmetric positive definite linear systems of equations AX = B, where B is a matrix containing one or more right-hand sides. More...
class	Belos::BlockGmres< ScalarType, MV, OP >
	This class implements the Restarted Block GMRES algorithm for solving real nonsymmetric linear systems of equations AX = B, where B is a matrix containing one or more right-hand sides, and X is the matrix of corresponding solutions. More...
class	Belos::CG< ScalarType, MV, OP >
	This class implements the preconditioned Conjugate Gradient algorithm for solving real symmetric positive definite linear systems of equations Ax = b, where b is the right-hand side vector and x is the corresponding solution. More...
class	Belos::EpetraMultiVec
class	Belos::EpetraOp
class	Belos::EpetraPrecOp
class	Belos::MultiVecTraits< double, Epetra_MultiVector >
class	Belos::OperatorTraits< double, Epetra_MultiVector, Epetra_Operator >
class	Belos::EpetraOperator
	This class provides and interface to the Epetra_Operator class, so Belos can be integrated into other codes as an abstract operator. More...
class	Belos::IterativeSolver< ScalarType, MV, OP >
	The Belos::IterativeSolver is a templated virtual base class that defines the basic interface that any linear solver will support. More...
class	Belos::LinearProblem< ScalarType, MV, OP >
	The Belos::LinearProblem class is a wrapper that encapsulates the general information needed for solving a linear system of equations. The general information is being held as either Belos::Operator or Belos::MultiVec objects. More...
class	Belos::MultiVec< ScalarType >
	Belos's templated pure virtual class for constructing multivectors that are used by the eigensolver. More...
class	Belos::MultiVecTraits< ScalarType, MultiVec< ScalarType > >
struct	Belos::UndefinedMultiVecTraits< ScalarType, MV >
class	Belos::MultiVecTraits< ScalarType, MV >
class	Belos::Operator< ScalarType >
	Belos's templated pure virtual class for constructing the operator that is used by the linear solver. More...
class	Belos::OperatorTraits< ScalarType, MultiVec< ScalarType >, Operator< ScalarType > >
	Template specialization of Belos::OperatorTraits class using Belos::Operator and Belos::MultiVec virtual base classes. More...
struct	Belos::UndefinedOperatorTraits< ScalarType, MV, OP >
class	Belos::OperatorTraits< ScalarType, MV, OP >
class	Belos::OutputManager< ScalarType >
	Belos's basic output manager for sending information of select verbosity levels to the appropriate output stream. More...
class	Belos::StatusTest< ScalarType, MV, OP >
	A pure virtual class for defining the status tests for the Belos iterative solvers. More...
class	Belos::StatusTestCombo< ScalarType, MV, OP >
	A class for extending the status testing capabilities of Belos via logical combinations. More...
class	Belos::StatusTestMaxIters< ScalarType, MV, OP >
	A Belos::StatusTest class for specifying a maximum number of iterations. More...
class	Belos::StatusTestMaxRestarts< ScalarType, MV, OP >
	A Belos::StatusTest class for specifying a maximum number of restarts. More...
class	Belos::StatusTestOutputter< ScalarType, MV, OP >
	StatusTest implementation that does nothing but outputting. More...
class	Belos::StatusTestResNorm< ScalarType, MV, OP >
	An implementation of StatusTest using a family of residual norms. More...
class	Belos::TFQMR< ScalarType, MV, OP >
	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 vector and x is the corresponding solution. More...
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	ReturnType { Ok, Undefined, Error }
	Any method in the Belos abstract interfaces may fail or not be defined. This information needs to be passed back to the algorithm or user. This will be used by the algorithm or user to decide what should be done. More...
enum	StatusType { Unchecked = 2, Unconverged = 1, Converged = 0, Failed = -1, NaN = -2 }
enum	ConjType { NO_CONJ, CONJ }
enum	MsgType { Errors = 0, Warnings = 0x1, IterationDetails = 0x2, OrthoDetails = 0x4, FinalSummary = 0x8, TimingDetails = 0x10, Debug = 0x20 }
	Enumerated list of available message types recognized by the linear solvers. More...
Functions
string	Belos_Version ()
template<class ScalarType, class MV>
ReturnType	TestMultiVecTraits (const Teuchos::RefCountPtr< OutputManager< ScalarType > > &om, const Teuchos::RefCountPtr< const MV > &A)
template<class ScalarType, class MV, class OP>
ReturnType	TestOperatorTraits (const Teuchos::RefCountPtr< OutputManager< ScalarType > > &om, const Teuchos::RefCountPtr< const MV > &A, const Teuchos::RefCountPtr< const OP > &M)
const char *	toString (const StatusType status)