base Class Reference

Detailed Description

Definition at line 15 of file Boundary.H.

#include <Boundary.H>

Public Types
typedef simulation::state::base	StateType
typedef StateType::MetaDataSetType	DataDictionaryType

Public Member Functions
	base ()
void	SetParams (StateType &inParams)
void	DestroyParams ()
void	Destroy ()
void	Create ()
StateType &	Params ()
const StateType &	Params () const
int	BCType () const
void	SetBCType (int inType)
std::string &	BCName ()
const std::string &	BCName () const
void	SetBCName (const std::string &inName)
DataDictionaryType &	ParamDictionary ()
const DataDictionaryType &	ParamDictionary () const
DataDictionaryType &	StateDictionary ()
const DataDictionaryType &	StateDictionary () const

Protected Attributes
int	bcType
std::string	bcName
StateType *	paramPtr
DataDictionaryType	stateDictionary
DataDictionaryType	paramDictionary
bool	myParams

Collaboration diagram for base:

Member Typedef Documentation

DataDictionaryType

typedef StateType::MetaDataSetType DataDictionaryType

Definition at line 20 of file Boundary.H.

StateType

typedef simulation::state::base StateType

Definition at line 19 of file Boundary.H.

Constructor & Destructor Documentation

base()

base ( )

inline

Definition at line 22 of file Boundary.H.

References base::Create().

Here is the call graph for this function:

Member Function Documentation

BCName() [1/2]

std::string& BCName ( )

inline

Definition at line 60 of file Boundary.H.

References base::bcName.

Referenced by base< GridT, StateT >::ConfigureDomain(), base< GridT, StateT >::ConfigureGridDomainBoundaries(), and base< GridT, StateT >::Report().

Here is the caller graph for this function:

BCName() [2/2]

const std::string& BCName ( ) const

inline

Definition at line 61 of file Boundary.H.

References base::bcName.

BCType()

int BCType ( ) const

inline

Definition at line 57 of file Boundary.H.

References base::bcType.

Referenced by base< GridT, StateT >::ConfigureDomain(), and base::Create().

Here is the caller graph for this function:

Create()

void Create ( )

inline

Definition at line 46 of file Boundary.H.

References base::Destroy(), base::myParams, and base::paramPtr.

Referenced by base::base().

Here is the call graph for this function:

Here is the caller graph for this function:

Destroy()

void Destroy ( )

inline

Definition at line 41 of file Boundary.H.

References base::DestroyParams().

Referenced by base::Create().

Here is the call graph for this function:

Here is the caller graph for this function:

DestroyParams()

void DestroyParams ( )

inline

Definition at line 33 of file Boundary.H.

References base::myParams, and base::paramPtr.

Referenced by base::Destroy(), and base::SetParams().

Here is the caller graph for this function:

ParamDictionary() [1/2]

DataDictionaryType& ParamDictionary ( )

inline

Definition at line 64 of file Boundary.H.

References base::paramDictionary.

Referenced by base< GridT, StateT >::ConfigureDomain(), and base< GridT, StateT >::Report().

Here is the caller graph for this function:

ParamDictionary() [2/2]

const DataDictionaryType& ParamDictionary ( ) const

inline

Definition at line 65 of file Boundary.H.

References base::paramDictionary.

Params() [1/2]

StateType& Params ( )

inline

Definition at line 54 of file Boundary.H.

References base::paramPtr.

Referenced by base< GridT, StateT >::ConfigureDomain().

Here is the caller graph for this function:

Params() [2/2]

const StateType& Params ( ) const

inline

Definition at line 55 of file Boundary.H.

References base::paramPtr.

SetBCName()

void SetBCName ( const std::string &  inName )

inline

Definition at line 62 of file Boundary.H.

References base::bcName.

Referenced by base< GridT, StateT >::ConfigureDomain().

Here is the caller graph for this function:

SetBCType()

void SetBCType ( int  inType )

inline

Definition at line 58 of file Boundary.H.

References base::bcType.

Referenced by base< GridT, StateT >::ConfigureDomain().

Here is the caller graph for this function:

SetParams()

void SetParams ( StateType &  inParams )

inline

Definition at line 27 of file Boundary.H.

References base::DestroyParams(), and base::paramPtr.

Here is the call graph for this function:

StateDictionary() [1/2]

DataDictionaryType& StateDictionary ( )

inline

Definition at line 66 of file Boundary.H.

References base::stateDictionary.

Referenced by base< GridT, StateT >::ConfigureDomain(), and base< GridT, StateT >::Report().

Here is the caller graph for this function:

StateDictionary() [2/2]

const DataDictionaryType& StateDictionary ( ) const

inline

Definition at line 67 of file Boundary.H.

References base::bcType, and base::stateDictionary.

Member Data Documentation

bcName

std::string bcName

protected

Definition at line 72 of file Boundary.H.

Referenced by base::BCName(), and base::SetBCName().

bcType

int bcType

protected

Definition at line 67 of file Boundary.H.

Referenced by base::BCType(), base::SetBCType(), and base::StateDictionary().

myParams

bool myParams

protected

Definition at line 78 of file Boundary.H.

Referenced by base::Create(), and base::DestroyParams().

paramDictionary

DataDictionaryType paramDictionary

protected

Definition at line 76 of file Boundary.H.

Referenced by base::ParamDictionary().

paramPtr

StateType* paramPtr

protected

Definition at line 73 of file Boundary.H.

Referenced by base::Create(), base::DestroyParams(), base::Params(), and base::SetParams().

stateDictionary

DataDictionaryType stateDictionary

protected

Definition at line 75 of file Boundary.H.

Referenced by base::StateDictionary().

---

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

• Boundary.H