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]

List of all members.

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 string &callingFunction="<Unknown Method>", const string &message="", const string &throwLabel="LOCA Error")
 Generic call to throw that prints info to the screen.
void printWarning (const string &callingFunction="<Unknown Method>", const string &message="")
 Generic printing algorithm for sending warnings to the screen.
void checkReturnType (const NOX::Abstract::Group::ReturnType &status, const string &callingFunction=string("<Unknown Method>"))
 Checks the supplied return type and performs an appropriate action.
void checkReturnType (const NOX::Abstract::Group::ReturnType &status, const ActionType &action, const string &callingFunction=string("<Unknown Method>"), const string &message=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.
NOX::Abstract::Group::ReturnType combineAndCheckReturnTypes (const NOX::Abstract::Group::ReturnType &status1, const NOX::Abstract::Group::ReturnType &status2, const string &callingFunction=string("<Unknown Method>"))
 Combines two return types and checks the first.

Protected Member Functions

string getReturnTypeString (NOX::Abstract::Group::ReturnType status)
 Converts the NOX::Abstract::Group::ReturnType to a 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 string &  callingFunction = string("<Unknown Method>") 
)
NOX::Abstract::Group::ReturnType LOCA::ErrorCheck::combineAndCheckReturnTypes ( const NOX::Abstract::Group::ReturnType status1,
const NOX::Abstract::Group::ReturnType status2,
const string &  callingFunction = 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.

Referenced by combineAndCheckReturnTypes().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Generated on Wed Apr 13 09:59:41 2011 for NOX by  doxygen 1.6.3