NOX  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LOCA::ErrorCheck Class Reference

An Error checking algorithm for NOX/LOCA routines. More...

#include <LOCA_ErrorCheck.H>

Collaboration diagram for LOCA::ErrorCheck:
Collaboration graph
[legend]

Public Types

enum  ActionType { ThrowError, PrintWarning }
 Type for the action to be taken if the ReturnType is not Ok. More...
 

Public Member Functions

 ErrorCheck (const Teuchos::RCP< LOCA::GlobalData > &global_data)
 Constructor.
 
 ~ErrorCheck ()
 Destructor.
 
void throwError (const std::string &callingFunction="<Unknown Method>", const std::string &message="", const std::string &throwLabel="LOCA Error")
 Generic call to throw that prints info to the screen.
 
void printWarning (const std::string &callingFunction="<Unknown Method>", const std::string &message="")
 Generic printing algorithm for sending warnings to the screen.
 
void checkReturnType (const NOX::Abstract::Group::ReturnType &status, const std::string &callingFunction=std::string("<Unknown Method>"))
 Checks the supplied return type and performs an appropriate action. More...
 
void checkReturnType (const NOX::Abstract::Group::ReturnType &status, const ActionType &action, const std::string &callingFunction=std::string("<Unknown Method>"), const std::string &message=std::string(""))
 Checks the return type for the NOX::AbstractGroup and may throw an error or print a warning to the screen based on the ActionType requested.
 
NOX::Abstract::Group::ReturnType combineReturnTypes (const NOX::Abstract::Group::ReturnType &status1, const NOX::Abstract::Group::ReturnType &status2)
 Combines two return types. More...
 
NOX::Abstract::Group::ReturnType combineAndCheckReturnTypes (const NOX::Abstract::Group::ReturnType &status1, const NOX::Abstract::Group::ReturnType &status2, const std::string &callingFunction=std::string("<Unknown Method>"))
 Combines two return types and checks the first. More...
 

Protected Member Functions

std::string getReturnTypeString (NOX::Abstract::Group::ReturnType status)
 Converts the NOX::Abstract::Group::ReturnType to a std::string.
 

Protected Attributes

Teuchos::RCP< LOCA::GlobalDataglobalData
 Global data.
 

Detailed Description

An Error checking algorithm for NOX/LOCA routines.

This object will check the return types on objects and print a warning or throw an error if appropriate

Member Enumeration Documentation

Type for the action to be taken if the ReturnType is not Ok.

Enumerator
ThrowError 

Throw an error.

PrintWarning 

Print a warning.

Member Function Documentation

void LOCA::ErrorCheck::checkReturnType ( const NOX::Abstract::Group::ReturnType status,
const std::string &  callingFunction = std::string("<Unknown Method>") 
)

Checks the supplied return type and performs an appropriate action.

This routine performs the following actions depending on the value of status

References NOX::Abstract::Group::BadDependency, NOX::Abstract::Group::Failed, NOX::Abstract::Group::NotConverged, NOX::Abstract::Group::NotDefined, NOX::Abstract::Group::Ok, PrintWarning, and ThrowError.

Referenced by LOCA::SingularJacobianSolve::ItRef::compute(), LOCA::SingularJacobianSolve::Nic::compute(), LOCA::SingularJacobianSolve::NicDay::compute(), and LOCA::SingularJacobianSolve::ItRef::computeMulti().

NOX::Abstract::Group::ReturnType LOCA::ErrorCheck::combineAndCheckReturnTypes ( const NOX::Abstract::Group::ReturnType status1,
const NOX::Abstract::Group::ReturnType status2,
const std::string &  callingFunction = std::string("<Unknown Method>") 
)
NOX::Abstract::Group::ReturnType LOCA::ErrorCheck::combineReturnTypes ( const NOX::Abstract::Group::ReturnType status1,
const NOX::Abstract::Group::ReturnType status2 
)

Combines two return types.

If either return type is NOX::Abstract::Group::NotDefined, returns NotDefined. Otherwise if either is BadDependcy, returns BadDependency, if either is Failed, returns Failed, if either is NotConverged, returns NotConverged, and otherwise returns Ok.

References NOX::Abstract::Group::BadDependency, NOX::Abstract::Group::Failed, NOX::Abstract::Group::NotConverged, NOX::Abstract::Group::NotDefined, and NOX::Abstract::Group::Ok.


The documentation for this class was generated from the following files: