Belos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
Classes | Namespaces
BelosTypes.hpp File Reference

Collection of types and exceptions used within the Belos solvers. More...

#include "BelosConfigDefs.hpp"
#include "Teuchos_Assert.hpp"
Include dependency graph for BelosTypes.hpp:

Go to the source code of this file.

Classes

class  Belos::BelosError
 Parent class to all Belos exceptions. More...
 
struct  Belos::DefaultSolverParameters
 Default parameters common to most Belos solvers. More...
 

Namespaces

namespace  Belos
 

Belos Exceptions

enum  Belos::ETrans { Belos::NOTRANS = 0 , Belos::TRANS = 1 , Belos::CONJTRANS = 2 }
 Whether to apply the (conjugate) transpose of an operator. More...
 
enum  Belos::NormType { Belos::OneNorm , Belos::TwoNorm , Belos::InfNorm , Belos::PreconditionerNorm }
 The type of vector norm to compute. More...
 
enum  Belos::ScaleType {
  Belos::NormOfRHS , Belos::NormOfInitRes , Belos::NormOfPrecInitRes , Belos::None ,
  Belos::UserProvided , Belos::NormOfFullInitRes , Belos::NormOfFullPrecInitRes , Belos::NormOfFullScaledInitRes ,
  Belos::NormOfFullScaledPrecInitRes
}
 The type of scaling to use on the residual norm value. More...
 
enum  Belos::OutputType { Belos::General , Belos::Brief , Belos::User }
 Style of output used to display status test information. More...
 
enum  Belos::ReturnType { Belos::Converged , Belos::Unconverged }
 Whether the Belos solve converged for all linear systems. More...
 
enum  Belos::StatusType { Belos::Passed = 0x1 , Belos::Failed = 0x2 , Belos::Undefined = 0x4 }
 Whether the StatusTest wants iteration to stop. More...
 
enum  Belos::ResetType { Belos::Problem = 0x1 , Belos::RecycleSubspace = 0x2 }
 How to reset the solver. More...
 
enum  Belos::ConjType { Belos::NO_CONJ , Belos::CONJ }
 Whether or not to conjugate the transpose for block inner products. More...
 
enum  Belos::MsgType {
  Belos::Errors = 0 , Belos::Warnings = 0x1 , Belos::IterationDetails = 0x2 , Belos::OrthoDetails = 0x4 ,
  Belos::FinalSummary = 0x8 , Belos::TimingDetails = 0x10 , Belos::StatusTestDetails = 0x20 , Belos::Debug = 0x40
}
 Available message types recognized by the linear solvers. More...
 
std::string Belos::convertReturnTypeToString (const ReturnType result)
 Convert the given ReturnType enum value to its corresponding string.
 
std::string Belos::convertStatusTypeToString (const StatusType status)
 The string name corresponding to the given StatusType enum value.
 
StatusType Belos::convertStringToStatusType (const std::string &status)
 The StatusType enum value corresponding to the given string name.
 
NormType Belos::convertStringToNormType (const std::string &normType)
 Convert the given string to its NormType enum value.
 
ScaleType Belos::convertStringToScaleType (const std::string &scaleType)
 Convert the given string to its ScaleType enum value.
 
std::string Belos::convertScaleTypeToString (const ScaleType scaleType)
 Convert the given ScaleType enum value to its corresponding string.
 
std::string Belos::convertMsgTypeToString (const MsgType msgType)
 Show MsgType as a comma-delimited list of names.
 

Detailed Description

Collection of types and exceptions used within the Belos solvers.

Definition in file BelosTypes.hpp.