MultigridCompositeGrid Class Reference

MultigridCompositeGrid : holds the CompositeGrid and state for Multigrid so that multiple solvers can share the same multigrid hierarchy. More...

#include <MultigridCompositeGrid.h>

Inheritance diagram for MultigridCompositeGrid:

Collaboration diagram for MultigridCompositeGrid:

Classes
class	MultigridCompositeGridData

Public Member Functions
	MultigridCompositeGrid ()
	multigrid hierarchy so that multiple solvers can share the same multigrid hierarchy.
	~MultigridCompositeGrid ()
	Destructor.
	MultigridCompositeGrid (const MultigridCompositeGrid &rcc, const CopyType copyType=DEEP)
MultigridCompositeGrid &	operator= (const MultigridCompositeGrid &rcc)
int	allocate ()
	Allocate space for the CompositeGrid.
const CompositeGrid &	compositeGrid () const
	Return the CompositeGrid.
CompositeGrid &	operator() ()
const CompositeGrid &	operator() () const
bool	isGridUpToDate ()
	Return true if the multigrid hierarchy is up to date.
bool	isNull () const
void	setGridIsUpToDate (bool trueOrFalse=true)
	Specify whether the multigrid hierarchy is up to date. This is used as a mechanism to know when the multigrid hierachy needs to be regenerated.
void	updateToMatchGrid (CompositeGrid &cg)
	Update the grid to match a new CompositeGrid.
void	reference (const MultigridCompositeGrid &rcc)
	Reference this object to another.
void	breakReference ()
	Break the reference that this object has with any other objects after calling this function the object will have a separate copy of all member data.
Public Member Functions inherited from ReferenceCounting
	ReferenceCounting ()
	ReferenceCounting (const ReferenceCounting &x, const CopyType ct=DEEP)
virtual	~ReferenceCounting ()
virtual ReferenceCounting *	virtualConstructor (const CopyType ct=DEEP) const
Integer	incrementReferenceCount ()
Integer	decrementReferenceCount ()
Integer	getReferenceCount () const
Logical	uncountedReferencesMayExist ()
virtual aString	getClassName () const
Integer	getGlobalID () const
void	setGlobalID (int id)
virtual void	consistencyCheck () const

Protected Attributes
MultigridCompositeGridData *	rcData

Detailed Description

MultigridCompositeGrid : holds the CompositeGrid and state for Multigrid so that multiple solvers can share the same multigrid hierarchy.

Until the CompositeGrid is allocated, this is a very lightweight class.

Constructor & Destructor Documentation

MultigridCompositeGrid::MultigridCompositeGrid

(

)

multigrid hierarchy so that multiple solvers can share the same multigrid hierarchy.

MultigridCompositeGrid : holds the CompositeGrid with multigrid hierarchy so that multiple solvers can share the same multigrid hierarchy.

MultigridCompositeGrid::~MultigridCompositeGrid

(

)

Destructor.

References ReferenceCounting::decrementReferenceCount(), and rcData.

MultigridCompositeGrid::MultigridCompositeGrid	(	const MultigridCompositeGrid &	rcc,
		const CopyType	copyType = DEEP
	)

References DEEP, ReferenceCounting::incrementReferenceCount(), rcData, and reference().

Member Function Documentation

int MultigridCompositeGrid::allocate

(

)

Allocate space for the CompositeGrid.

References assert, ReferenceCounting::incrementReferenceCount(), NULL, MultigridCompositeGrid::MultigridCompositeGridData::pcg, and rcData.

Referenced by updateToMatchGrid().

void MultigridCompositeGrid::breakReference ( void  )

virtual

Break the reference that this object has with any other objects after calling this function the object will have a separate copy of all member data.

Reimplemented from ReferenceCounting.

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

const CompositeGrid& MultigridCompositeGrid::compositeGrid ( ) const

inline

Return the CompositeGrid.

References assert, NULL, MultigridCompositeGrid::MultigridCompositeGridData::pcg, and rcData.

bool MultigridCompositeGrid::isGridUpToDate ( )

inline

Return true if the multigrid hierarchy is up to date.

References MultigridCompositeGrid::MultigridCompositeGridData::isUpToDate, and rcData.

bool MultigridCompositeGrid::isNull ( ) const

inline

References NULL, MultigridCompositeGrid::MultigridCompositeGridData::pcg, and rcData.

CompositeGrid& MultigridCompositeGrid::operator() ( )

inline

References assert, NULL, MultigridCompositeGrid::MultigridCompositeGridData::pcg, and rcData.

const CompositeGrid& MultigridCompositeGrid::operator() ( ) const

inline

References assert, NULL, MultigridCompositeGrid::MultigridCompositeGridData::pcg, and rcData.

MultigridCompositeGrid & MultigridCompositeGrid::operator=

(

const MultigridCompositeGrid &

rcc

)

References rcData.

void MultigridCompositeGrid::reference

(

const MultigridCompositeGrid &

rcc

)

Reference this object to another.

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

Referenced by breakReference(), MultigridCompositeGrid(), and Oges::set().

void MultigridCompositeGrid::setGridIsUpToDate

(

bool

trueOrFalse = true

)

Specify whether the multigrid hierarchy is up to date. This is used as a mechanism to know when the multigrid hierachy needs to be regenerated.

References MultigridCompositeGrid::MultigridCompositeGridData::isUpToDate, and rcData.

Referenced by Oges::setGrid().

void MultigridCompositeGrid::updateToMatchGrid

(

CompositeGrid &

cg

)

Update the grid to match a new CompositeGrid.

References allocate(), MultigridCompositeGrid::MultigridCompositeGridData::isUpToDate, MultigridCompositeGrid::MultigridCompositeGridData::pcg, rcData, and CompositeGridData::reference().

Member Data Documentation

MultigridCompositeGridData* MultigridCompositeGrid::rcData

protected

Referenced by allocate(), breakReference(), compositeGrid(), isGridUpToDate(), isNull(), MultigridCompositeGrid(), operator()(), operator=(), reference(), setGridIsUpToDate(), updateToMatchGrid(), and ~MultigridCompositeGrid().

---

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

• MultigridCompositeGrid.h
• MultigridCompositeGrid.C