LOCA::GlobalData Class Reference

Container class to hold "global" LOCA objects. More...

#include <LOCA_GlobalData.H>

List of all members.

Public Member Functions

 GlobalData (const Teuchos::RCP< NOX::Utils > &loca_utils, const Teuchos::RCP< LOCA::ErrorCheck > &loca_error_check, const Teuchos::RCP< LOCA::Factory > &loca_factory)
 Constructor taking a ref-count pointer to each global object.
virtual ~GlobalData ()
 Destructor.

Public Attributes

Teuchos::RCP< NOX::UtilslocaUtils
 Ref-count pointer to NOX::Utils object.
Teuchos::RCP< LOCA::ErrorChecklocaErrorCheck
 Ref-count pointer to LOCA::ErrorCheck object.
Teuchos::RCP< LOCA::FactorylocaFactory
 Ref-count pointer to LOCA::Factory object.
Teuchos::RCP
< LOCA::Parameter::SublistParser
parsedParams
 Ref-count pointer to parsed parameter list.

Private Member Functions

 GlobalData (const GlobalData &)
 Copy constructor is private to preclude copying.
GlobalDataoperator= (const GlobalData &)
 Assignment operator is private to preclude copying.


Detailed Description

Container class to hold "global" LOCA objects.

GlobalData is a container class that holds ref-count pointers to "global" objects, i.e., objects that nearly every LOCA object will need access to. By putting them all in one container class, the container class can be stored in each LOCA object, and if a new global object is needed, it can be added here without modifying the rest of the code. This is an alternative to true global or static objects which are note safe in many contexts. In particular, this approach allows multiple LOCA "invocations" to be in memory at the same time. Note that all data members are declared public.

Definition at line 79 of file LOCA_GlobalData.H.


Constructor & Destructor Documentation

LOCA::GlobalData::GlobalData ( const Teuchos::RCP< NOX::Utils > &  loca_utils,
const Teuchos::RCP< LOCA::ErrorCheck > &  loca_error_check,
const Teuchos::RCP< LOCA::Factory > &  loca_factory 
)

Constructor taking a ref-count pointer to each global object.

Definition at line 49 of file LOCA_GlobalData.C.

LOCA::GlobalData::~GlobalData (  )  [virtual]

Destructor.

Definition at line 60 of file LOCA_GlobalData.C.

LOCA::GlobalData::GlobalData ( const GlobalData  )  [private]

Copy constructor is private to preclude copying.


Member Function Documentation

GlobalData& LOCA::GlobalData::operator= ( const GlobalData  )  [private]

Assignment operator is private to preclude copying.


Member Data Documentation

Ref-count pointer to NOX::Utils object.

Definition at line 92 of file LOCA_GlobalData.H.

Ref-count pointer to LOCA::ErrorCheck object.

Definition at line 95 of file LOCA_GlobalData.H.

Ref-count pointer to LOCA::Factory object.

Definition at line 98 of file LOCA_GlobalData.H.

Ref-count pointer to parsed parameter list.

Definition at line 101 of file LOCA_GlobalData.H.


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

Generated on Wed Oct 21 14:28:27 2009 for Nonlinear Solver Project by  doxygen 1.5.9