GenericGrid Class Reference

#include <GenericGrid.h>

Inheritance diagram for GenericGrid:

Collaboration diagram for GenericGrid:

Public Types
enum	GridTypeEnum { structuredGrid =0, unstructuredGrid }
enum	{ NOTHING = GenericGridData::NOTHING, THEusualSuspects = GenericGridData::THEusualSuspects, EVERYTHING = GenericGridData::EVERYTHING }
enum	{ COMPUTEnothing = GenericGridData::COMPUTEnothing, COMPUTEtheUsual = GenericGridData::COMPUTEtheUsual, COMPUTEfailed = GenericGridData::COMPUTEfailed }
typedef GenericGridData	RCData

Public Member Functions
const Integer &	computedGeometry () const
	GenericGrid ()
	GenericGrid (const GenericGrid &x, const CopyType ct=DEEP)
virtual	~GenericGrid ()
GenericGrid &	operator= (const GenericGrid &x)
GenericGrid &	equals (const GenericGrid &x, int option=0)
void	reference (const GenericGrid &x)
void	reference (GenericGridData &x)
virtual void	breakReference ()
virtual void	consistencyCheck () const
virtual Integer	get (const GenericDataBase &db, const aString &name, bool getMapping=true)
virtual Integer	put (GenericDataBase &db, const aString &name, bool putMapping=true, int geometryToPut=-1) const
virtual void	specifyProcesses (const Range &range)
void	updateReferences (const Integer what=EVERYTHING)
Integer	update (const Integer what=THEusualSuspects, const Integer how=COMPUTEtheUsual)
virtual Integer	update (GenericGrid &x, const Integer what=THEusualSuspects, const Integer how=COMPUTEtheUsual)
virtual void	destroy (const Integer what=NOTHING)
void	geometryHasChanged (const Integer what=~NOTHING)
virtual void	initialize ()
Logical	operator== (const GenericGrid &x) const
Logical	operator!= (const GenericGrid &x) const
GenericGridData *	operator-> ()
const GenericGridData *	operator-> () const
GenericGridData &	operator* ()
const GenericGridData &	operator* () const
virtual aString	getClassName () const
Public Member Functions inherited from ReferenceCounting
	ReferenceCounting ()
	ReferenceCounting (const ReferenceCounting &x, const CopyType ct=DEEP)
virtual	~ReferenceCounting ()
Integer	incrementReferenceCount ()
Integer	decrementReferenceCount ()
Integer	getReferenceCount () const
Logical	uncountedReferencesMayExist ()
Integer	getGlobalID () const
void	setGlobalID (int id)

Public Attributes
RCData *	rcData
Logical	isCounted

Member Typedef Documentation

typedef GenericGridData GenericGrid::RCData

Member Enumeration Documentation

anonymous enum

Enumerator
NOTHING
THEusualSuspects
EVERYTHING

anonymous enum

Enumerator
COMPUTEnothing
COMPUTEtheUsual
COMPUTEfailed

enum GenericGrid::GridTypeEnum

Enumerator
structuredGrid
unstructuredGrid

Constructor & Destructor Documentation

GenericGrid::GenericGrid

(

)

References ReferenceCounting::incrementReferenceCount(), isCounted, LogicalTrue, rcData, and updateReferences().

GenericGrid::GenericGrid	(	const GenericGrid &	x,
		const CopyType	ct = DEEP
	)

References DEEP, ReferenceCounting::incrementReferenceCount(), isCounted, LogicalTrue, NOCOPY, rcData, SHALLOW, and updateReferences().

GenericGrid::~GenericGrid ( )

virtual

References ReferenceCounting::decrementReferenceCount(), isCounted, and rcData.

Member Function Documentation

void GenericGrid::breakReference ( void  )

virtual

Reimplemented from ReferenceCounting.

Reimplemented in MappedGrid.

References ReferenceCounting::getReferenceCount(), isCounted, rcData, reference(), and x.

const Integer& GenericGrid::computedGeometry ( ) const

inline

References GenericGridData::computedGeometry, and rcData.

Referenced by MappedGrid::changeToAllCellCentered(), MappedGrid::changeToAllVertexCentered(), and operator<<().

void GenericGrid::consistencyCheck ( void  ) const

virtual

Reimplemented from ReferenceCounting.

Reimplemented in MappedGrid.

References assert, GenericGridData::consistencyCheck(), ReferenceCounting::consistencyCheck(), getClassName(), ReferenceCounting::getGlobalID(), NULL, and rcData.

Referenced by MappedGrid::consistencyCheck().

void GenericGrid::destroy ( const Integer  what = NOTHING )

virtual

Reimplemented in MappedGrid.

References GenericGridData::destroy(), rcData, and updateReferences().

GenericGrid & GenericGrid::equals	(	const GenericGrid &	x,
		int	option = 0
	)

References GenericGridData::equals(), GenericGridData::getClassName(), rcData, reference(), and updateReferences().

void GenericGrid::geometryHasChanged ( const Integer  what = ~NOTHING )

inline

References GenericGridData::geometryHasChanged(), and rcData.

Referenced by MappedGrid::reference(), Ogen::updateGeometry(), and Ogen::updateOverlap().

Integer GenericGrid::get ( const GenericDataBase &  db, const aString &  name, bool  getMapping = true  )

virtual

Reimplemented in MappedGrid.

References GenericGridData::get(), rcData, and updateReferences().

virtual aString GenericGrid::getClassName ( void  ) const

inlinevirtual

Reimplemented from ReferenceCounting.

Reimplemented in MappedGrid.

Referenced by consistencyCheck().

void GenericGrid::initialize ( )

virtual

Reimplemented in MappedGrid.

References GenericGridData::initialize(), and rcData.

Referenced by MappedGrid::initialize().

Logical GenericGrid::operator!= ( const GenericGrid &  x ) const

inline

References rcData.

GenericGridData& GenericGrid::operator* ( )

inline

References rcData.

const GenericGridData& GenericGrid::operator* ( ) const

inline

References rcData.

GenericGridData* GenericGrid::operator-> ( )

inline

References rcData.

const GenericGridData* GenericGrid::operator-> ( ) const

inline

References rcData.

GenericGrid & GenericGrid::operator=

(

const GenericGrid &

x

)

References GenericGridData::getClassName(), rcData, reference(), and updateReferences().

Logical GenericGrid::operator== ( const GenericGrid &  x ) const

inline

References rcData.

Integer GenericGrid::put ( GenericDataBase &  db, const aString &  name, bool  putMapping = true, int  geometryToPut = -1  ) const

virtual

Reimplemented in MappedGrid.

void GenericGrid::reference

(

const GenericGrid &

x

)

References ReferenceCounting::decrementReferenceCount(), ReferenceCounting::incrementReferenceCount(), isCounted, rcData, ReferenceCounting::reference(), and updateReferences().

Referenced by breakReference(), equals(), operator=(), MappedGrid::reference(), and MappedGrid::updateReferences().

void GenericGrid::reference

(

GenericGridData &

x

)

References ReferenceCounting::decrementReferenceCount(), ReferenceCounting::incrementReferenceCount(), isCounted, rcData, ReferenceCounting::uncountedReferencesMayExist(), and updateReferences().

void GenericGrid::specifyProcesses ( const Range &  range )

virtual

Reimplemented in MappedGrid.

References rcData, and GenericGridData::specifyProcesses().

Integer GenericGrid::update ( const Integer  what = THEusualSuspects, const Integer  how = COMPUTEtheUsual  )

inline

References update().

Referenced by update().

Integer GenericGrid::update ( GenericGrid &  x, const Integer  what = THEusualSuspects, const Integer  how = COMPUTEtheUsual  )

virtual

References rcData, GenericGridData::update(), and updateReferences().

void GenericGrid::updateReferences

(

const Integer

what = EVERYTHING

)

Referenced by destroy(), equals(), GenericGrid(), get(), operator=(), reference(), update(), and MappedGrid::updateReferences().

Member Data Documentation

Logical GenericGrid::isCounted

Referenced by breakReference(), GenericGrid(), reference(), and ~GenericGrid().

RCData* GenericGrid::rcData

Referenced by breakReference(), computedGeometry(), consistencyCheck(), MappedGrid::consistencyCheck(), destroy(), equals(), GenericGrid(), geometryHasChanged(), get(), initialize(), operator!=(), operator*(), operator->(), operator=(), operator==(), reference(), specifyProcesses(), update(), and ~GenericGrid().

---

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

• GenericGrid.h
• GenericGrid.C