Interface for accessing the global list of zones, IZoneList. More...

#include <izonelist.h>

Classes
struct	FaceGroupCallbackData

struct	FaceSelectCallbackData

Public Types
using	ModelQueryInfo = module::IGenericModelList::ModelQueryInfo

Public Member Functions
virtual const IThing *	getIThing () const =0
	Returns a const pointer to an IThing interface representing the IZoneList.

virtual IThing *	getIThing ()=0
	Returns a pointer to an IThing interface representing the IZoneList.

virtual const IContainer *	getIContainer () const =0
	Returns a const pointer to the IContainer.

virtual IContainer *	getIContainer ()=0
	Returns a pointer to the IContainer.

virtual const IZone *	getFirstZone () const =0
	Returns a const pointer to the first zone, IZone, in the list, or 0 if list is empty.

virtual IZone *	getFirstZone ()=0
	Returns a pointer to the first zone, IZone, in the list, or 0 if list is empty.

virtual uint32	getZoneType () const =0
	Returns const pointer to the first character of the string retaining the type of zone.

virtual uint32	getFaceType () const =0
	Returns const pointer to the first character of the string retaining the type of face.

virtual const IZone *	findZoneWithID (uint64 id) const =0
	Returns a const pointer to the zone, IZone, with the ID id, or 0 if the zone does not exist.

virtual IZone *	findZoneWithID (uint64 id)=0
	Returns a pointer to the zone, IZone, with the ID id, or 0 if the zone does not exist.

virtual const IZone *	findZoneNearest (const DVect &vec, const double &radius=limits< double >::max()) const =0

virtual IZone *	findZoneNearest (const DVect &vec, const double &radius=limits< double >::max())=0

virtual uint64	getNZone () const =0
	Returns the total number of zone in the model.

virtual IZone *	findZoneContainingNull (const DVect &v, bool hideNull) const =0

virtual IZone *	findZoneNearestLive (const DVect &dv3)=0
	Returns a pointer to the zone closest to location dv3.

virtual uint32	getZoneExtraNotice () const =0
	Returns the tag for the zone extra variable change notice.

virtual uint32	getModelNotice () const =0
	Returns the tag for the zone model change notice.

virtual uint32	getPropertyNotice () const =0
	Returns the tag for the zone property change notice.

virtual uint32	getStateNotice () const =0
	Returns the tag for the zone state change notice.

virtual uint32	getDensityNotice () const =0
	Returns the tag for the zone density change notice.

virtual uint32	getGroupNotice () const =0
	Returns the tag for the zone group change notice.

virtual uint32	getStressNotice () const =0
	Returns the tag for the zone stress state change notice.

virtual uint32	getThermalFluxNotice () const =0
	Returns the tag for the zone thermal flux change notice.

virtual uint32	getFaceGroupNotice () const =0
	Returns the tag for the zone group change notice.

virtual uint32	getFaceExtraNotice () const =0
	Returns the tag for the zone extra FISH variable change notice.

virtual uint32	getHideNotice () const =0
	Returns the tag for zone hide status.

virtual uint32	getSelectNotice () const =0
	REturns the tag for zone select status.

virtual uint32	getFaceHideNotice () const =0
	Returns the tag for face hide status.

virtual uint32	getFaceSelectNotice () const =0
	Returns the tag for face select status.

virtual uint32	getMultiplierNotice () const =0

virtual uint32	getFluidPropNotice () const =0

virtual uint32	getThermPropNotice () const =0

virtual uint64	getNumberFacesHidden () const =0
	Returns the total number of faces (surface or otherwise) that are hidden.

virtual uint64	getNumberFacesSelected () const =0
	Returns the total number of faces (surface or otherwise) that are selected.

virtual int	claimBit () const =0
	Claims a bit from the zones 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 bit from the zones utility value array.

virtual void	releaseValue (int bit) const =0
	Releases a value index back to the zones utility value array. Thread-safe.

virtual IZoneData *	createIZoneData () const =0

virtual StringList	getAllMechanicalModels () const =0
	Returns a StringList containing all unique mechanical constitutive models in all zones (null excluded).

virtual StringList	getAllMechanicalProperties () const =0
	Returns a StringList containing all unique property names of all mechanical constitutive models in all zones in the model.

virtual ModelQueryInfo	getModelQueryOnSelected () const =0

virtual const IFace *	makeFace (const IZone *z, uint32 side) const =0

virtual IFace *	makeFace (IZone *z, uint32 side)=0

virtual itascaxd::IFetchProperty *	makeFetchProperty (const string &prop) const =0

virtual IFetchThermalProperty *	makeFetchThermalProperty (const string &prop) const =0

virtual string	getZoneGroupsOnSides (std::set< IGroupID > zf1GroupList, std::set< IGroupID > zf2GroupList) const =0

virtual std::vector< base::PropDesc >	getMechanicalPropertiesAvailable () const =0

virtual std::vector< base::PropDesc >	getFluidPropertiesAvailable () const =0

virtual std::vector< base::PropDesc >	getThermalPropertiesAvailable () const =0

virtual void	threadedCallbackObject (Callback4< void, const IZone , uint32, uint32, void > &callback, void *v=nullptr, bool useThreads=true) const =0

virtual void	threadedCallbackFunction (void(function)(const IZone , uint32, uint32, void ), void v=nullptr, bool useThreads=true) const =0

template<class S , void(S::)(const IZone , uint32, uint32, void *) MFP>
void	threadedCallbackMethod (S s, void v=nullptr, bool useThreads=true) const

virtual void	threadedCallbackObjectFaceGroups (Callback3< void, const FaceGroupCallbackData *, uint32, uint32 > &callback, bool useThreads=true) const =0

template<class S , void(S::)(const FaceGroupCallbackData , uint32, uint32) MFP>
void	threadedCallbackMethodFaceGroups (S *s, bool useThreads=true) const

virtual void	threadedCallbackObjectFaceSelect (Callback3< void, const FaceSelectCallbackData *, uint32, uint32 > &callback, bool useThreads=true) const =0

template<class S , void(S::)(const FaceSelectCallbackData , uint32, uint32) MFP>
void	threadedCallbackMethodFaceSelect (S *s, bool useThreads=true) const

Detailed Description

Interface for accessing the global list of zones, IZoneList.

Member Function Documentation

◆ claimBit()

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

pure virtual

Claims a bit from the zones utility bit field.

It is sometimes useful to be able to store flags and data in a zone 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 IZone::getBit() and IZone::setBit() functions. This function is thread-safe (IZone::getBit and IZone::setBit are not).

See also: releaseBit() IZone::setBit() IZone::getBit()

◆ claimValue()

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

pure virtual

Claims a bit from the zones utility value array.

It is sometimes useful to be able to store flags and data in a zone 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 a value index that can be used with the IZone::getValue() and IZone::setValue() functions. This function is thread-safe (IZone::getValue and IZone::setValue are not).

See also: releaseBit() IZone::setValue() IZone::getValue()

◆ createIZoneData()

virtual IZoneData * zone::IZoneList::createIZoneData ( ) const

pure virtual

Returns the pointer to IZoneData. This pointer must be destroyed. The IZoneData object can be used to retrieve scalar data from a zone.

◆ findZoneContainingNull()

virtual IZone * zone::IZoneList::findZoneContainingNull	(	const DVect &	v,
		bool	hideNull ) const

pure virtual

Returns a pointer to the zone, IZone, containing the location vec , or 0 if the zone does not exist. bHideMechNull indicates that zones with a null mechanical model should be ignored. bHideFluidNull indicates that zones with a null fluid model should be ignored. bHideThermNull indicates that zones with a null thermal model should be ignored.

◆ findZoneNearest() [1/2]

virtual const IZone * zone::IZoneList::findZoneNearest	(	const DVect &	vec,
		const double &	radius = limits< double >::max() ) const

pure virtual

Returns a const pointer to the zone, IZone, whose centroid is the closest to the location vec , or 0 if the zone does not exist.

◆ findZoneNearest() [2/2]

virtual IZone * zone::IZoneList::findZoneNearest	(	const DVect &	vec,
		const double &	radius = limits< double >::max() )

pure virtual

Returns a pointer to the zone, IZone, whose centroid is the closest to the location in vec , or 0 if the zone does not exist.

◆ findZoneNearestLive()

virtual IZone * zone::IZoneList::findZoneNearestLive ( const DVect & dv3 )

pure virtual

Returns a pointer to the zone closest to location dv3.

Parameters bMech, bFluid and bTherm are used to returns a zone that has 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.

◆ getFirstZone() [1/2]

virtual const IZone * zone::IZoneList::getFirstZone ( ) const

pure virtual

Returns a const pointer to the first zone, IZone, in the list, or 0 if list is empty.

Use in conjunction with IZone::getNext()

◆ getFirstZone() [2/2]

virtual IZone * zone::IZoneList::getFirstZone ( )

pure virtual

Returns a pointer to the first zone, IZone, in the list, or 0 if list is empty.

Use in conjunction with IZone::getNext()

◆ makeFace() [1/2]

virtual const IFace * zone::IZoneList::makeFace	(	const IZone *	z,
		uint32	side ) const

pure virtual

Returns an IFace object representing face side of zone z. Created from the heap, must be deleted by the user with the destroy() method.

◆ makeFace() [2/2]

virtual IFace * zone::IZoneList::makeFace	(	IZone *	z,
		uint32	side )

pure virtual

Returns an IFace object representing face side of zone z. Created from the heap, must be deleted by the user with the destroy() method.

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

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

Classes

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

◆ claimBit()

◆ claimValue()

◆ createIZoneData()

◆ findZoneContainingNull()

◆ findZoneNearest() [1/2]

◆ findZoneNearest() [2/2]

◆ findZoneNearestLive()

◆ getFirstZone() [1/2]

◆ getFirstZone() [2/2]

◆ makeFace() [1/2]

◆ makeFace() [2/2]