BelosTypes.hpp File Reference

Collection of the enumerated lists used in Belos. More...

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Namespaces

namespace  Belos

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

const char * toString (const StatusType status)


Detailed Description

Collection of the enumerated lists used in Belos.

Definition in file BelosTypes.hpp.


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

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 doxygen 1.3.9.1