zone::IGpList Class Reference

Interface to the global list of all grid points. More...

#include <igplist.h>

Public Member Functions
virtual const IThing *	getIThing () const =0
	Returns a const pointer to an IThing interface representing the IGpList.
virtual IThing *	getIThing ()=0
	Returns a pointer to an IThing interface representing the IGpList.
virtual const IContainer *	getIContainer () const =0
	Returns a const pointer to the IContainer interface representing the global list of grid points.
virtual IContainer *	getIContainer ()=0
	Returns a pointer to the IContainer interface representing the global list of grid points.
virtual const IGp *	getFirstGp () const =0
virtual IGp *	getFirstGp ()=0
virtual uint32	getGridPointType () const =0
	Returns the gridpoint general type.
virtual const IGp *	findGridPointWithID (uint64 id) const =0
	Given a gridpoint id, returns a const pointer to the gridpoint.
virtual const IGp *	findGridPoint (const DVect &vec, uint32 excludeMask=0) const =0
virtual IGp *	findGridPoint (const DVect &vec, uint32 excludeMask=0)=0
virtual IGp *	findGridPoint (const DVect &vec, const IGroupID &group)=0
virtual uint64	getNGp () const =0
	Returns the number of grid points in the list.
virtual IGp *	findGpLive (const DVect &dv3)=0
virtual uint32	getFapNotice () const =0
	Returns the tag for the gridpoint applied force change notice.
virtual uint32	getFobNotice () const =0
	Returns the tag for the gridpoint out of balance change force notice.
virtual uint32	getGpExtraNotice () const =0
	Returns the tag for the gridpoint extra variable change notice.
virtual uint32	getPorePressureNotice () const =0
	Returns the tag for the gridpoint pore-pressure change notice.
virtual uint32	getTemperatureNotice () const =0
	Returns the tag for the gridpoint temperature change notice.
virtual uint32	getGeometryNotice () const =0
	Returns the tag for the gridpoint geometry change notice.
virtual uint32	getFixityNotice () const =0
	Returns the tag for the gridpoint fix condition change notice.
virtual uint32	getVelocityNotice () const =0
	Returns the tag for the gridpoint velocity change notice.
virtual uint32	getDisplacementNotice () const =0
	Returns the tag for the gridpoint displacement change notice.
virtual uint32	getSaturationNotice () const =0
	Returns the tag for the gridpoint saturation change notice.
virtual uint32	getNullChangeNotice () const =0
	Returns the tag for the zone null change notice.
virtual uint32	getMultiplierNotice () const =0
virtual int	claimBit () const =0
	Claims a bit from the gridpoints utility bit field.
virtual void	releaseBit (int bit) const =0
	Releases a bit index previously obtained with claimBit(). Thread-safe.
virtual int	claimValue () const =0
	Claims a value index from the gridpoints utility value array.
virtual void	releaseValue (int bit) const =0
	Releases a value index back to the gridpoints utility value array. Thread-safe.
virtual IGpData *	createIGpData () const =0
	Returns a pointer to a new IGpData object. This pointer must be destroyed by the caller.

Detailed Description

Interface to the global list of all grid points.

Member Function Documentation

claimBit()

virtual int zone::IGpList::claimBit ( ) const

pure virtual

Claims a bit from the gridpoints utility bit field.

It is sometimes useful to be able to store flags and data in a gridpoint during calculations unrelated to the actual model cycling logic.
Two utility arrays are available for this purpose, they are primarily intended to be briefly claimed, used, and then released for back for use in other algorithms.
claimBit() returns a bit index that can be used with the IGp::getBit() and IGp::setBit() functions. This function is thread-safe (IGp::getBit and IGp::setBit are not).

See also

releaseBit() IGp::setBit() IGp::getBit()

claimValue()

virtual int zone::IGpList::claimValue ( ) const

pure virtual

Claims a value index from the gridpoints utility value array.

It is sometimes useful to be able to store flags and data in a gridpoint during calculations unrelated to the actual model cycling logic.
Two utility arrays are available for this purpose, they are primarily intended to be briefly claimed, used, and then released for back for use in other algorithms.
claimValue() returns an array index can be used with the IGp::getValue() and IGp::setValue() functions. This function is thread-safe (IGp::getValue and IGp::setValue are not).

See also

releaseValue() IGp::setValue() IGp::getValue()

findGpLive()

virtual IGp * zone::IGpList::findGpLive ( const DVect & dv3 )

pure virtual

Returns a pointer to the gridpoint closest to location dv3.
Parameters bMech, bFluid and bTherm are used to returns a gridpoint connected to one or more zones that have a live mechanical, fluid and/or thermal model.
Parameter bOr affects the interaction of parameters bMech, bFluid and bTherm: true = Union, false = Intersection
If the criteria is not met, the function returns 0.

findGridPoint() [1/3]

virtual IGp * zone::IGpList::findGridPoint ( const DVect & vec, const IGroupID & group )

pure virtual

Returns the a pointer to grip point closest to location vec.
Parameter group, if non-null, is used to restrict the search only to gridpoints that belong to that group.

findGridPoint() [2/3]

virtual const IGp * zone::IGpList::findGridPoint ( const DVect & vec, uint32 excludeMask = 0 ) const

pure virtual

Returns the a const pointer to grip point closest to location vec.
Parameter excludeMask is used to mask grid points that will be excluded from the search. (value 0 include all grid points in the search)

findGridPoint() [3/3]

virtual IGp * zone::IGpList::findGridPoint ( const DVect & vec, uint32 excludeMask = 0 )

pure virtual

Returns the a pointer to grip point closest to location vec.
Parameter excludeMask is used to mask grid points that will be excluded from the search. (value 0 include all grid points in the search)

getFirstGp() [1/2]

virtual const IGp * zone::IGpList::getFirstGp ( ) const

pure virtual

Return a const pointer to the first gridpoint stored.
IGp::getNext() can be used to iterate on the list.

getFirstGp() [2/2]

virtual IGp * zone::IGpList::getFirstGp ( )

pure virtual

Return a const pointer to the first gridpoint stored.
IGp::getNext() can be used to iterate on the list.

---

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

• C:/Source/itasca-suite/flac3d/zone/interface/igplist.h