A base class used by the process to treat all the GmpMmBucketIndexBase<T> derivatives in a generic code (but including type information not existant in the Spatial index generic base class. More...

#include <gmpMmBucketIndex.h>

Inheritance diagram for GmpMmBucketIndex:

[legend]

Collaboration diagram for GmpMmBucketIndex:

[legend]

Public Types
enum	GSBIType { GSBIT_NODE , GSBIT_CELL , GSBIT_GAUSS , GSBIT_NUM_BUCKETYPES }

Public Member Functions
	GmpMmBucketIndex (GmSimulationData *simulation, QString id, QString description, GSBIType type, const GmLogCategory &logger)
	Constructor for plugin created objects.

	GmpMmBucketIndex (GmSimulationData simulation, GmMesh mesh, GSBIType type, const GmLogCategory &logger)
	Constructor for process created objects.

virtual	~GmpMmBucketIndex ()
	Destructor.

virtual GmMesh *	mesh () const

virtual const GmValueAccessor *	coordAccessor () const

virtual int	ndim () const

GSBIType	type () const

virtual int	numReferences () const =0
	Number of stored references.

Public Member Functions inherited from GmSpatialIndex
	GmSpatialIndex (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)

virtual const char *	pluginCategory () const

virtual bool	hasCapability (QString capabilityName) const=0

virtual bool	activeOnly () const=0

virtual int	ruleSet () const=0

virtual bool	isOutsideOfDomain (const GmVector &crd) const=0

virtual bool	getClosestNode (const GmVector &crd, double &sqrDist, int &outNodeId, const PointValidator &pv=defaultPointValidator) const=0

virtual void	getClosestNodes (const GmVector &crd, int n, QVector< GmpRefDist< int > > &nodeList, bool ordered, const PointValidator &pv=defaultPointValidator) const=0

virtual void	getClosestNodes (const GmVector &crd, double r, QVector< GmpRefDist< int > > &nodeList, bool ordered, const PointValidator &pv=defaultPointValidator) const=0

virtual void	getClosestNodes (const GmVector &crd, int n, QVector< int > &nodeList, bool ordered, const PointValidator &pv=defaultPointValidator) const=0

virtual void	getClosestNodes (const GmVector &crd, double r, QVector< int > &nodeList, bool ordered, const PointValidator &pv=defaultPointValidator) const=0

virtual GmCell *	getContainingCell (const GmVector &crd) const=0

virtual bool	getClosestGaussPoint (const GmVector &crd, double &sqrDist, GmpMmGaussData &outRef, const PointValidator &pv=defaultPointValidator) const=0

virtual void	getClosestGaussPoints (const GmVector &crd, int n, QVector< GmpRefDist< GmpMmGaussData > > &gpList, bool ordered, const PointValidator &pv=defaultPointValidator) const=0

virtual void	getClosestGaussPoints (const GmVector &crd, double r, QVector< GmpRefDist< GmpMmGaussData > > &gpList, bool ordered, const PointValidator &pv=defaultPointValidator) const=0

virtual void	getClosestGaussPoints (const GmVector &crd, int n, QVector< GmpMmGaussData > &gpList, bool ordered, const PointValidator &pv=defaultPointValidator) const=0

virtual void	getClosestGaussPoints (const GmVector &crd, double r, QVector< GmpMmGaussData > &gpList, bool ordered, const PointValidator &pv=defaultPointValidator) const=0

virtual void	printParameters (const GmLogCategory &logger)

Public Member Functions inherited from GmPluginObject
	GmPluginObject (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)

QString	id () const

QString	description () const

QString	pluginTypeName () const

virtual const char *	pluginName () const=0

virtual const char *	pluginType () const=0

virtual bool	loadPrivateData (LuaTable &table)=0

Static Public Member Functions
static QString	bucketTypeToStr (GSBIType type)
	Converts an bucket index type to a string.

static int	strToBucketType (QString str)
	Converts a string to a GSBIType. Returns -1 if no match is found.

Protected Attributes
GmMesh *	_mesh
	The mesh.

const GmCellGroupSet *	_cellGroup
	The cell group filter or NULL if there is none.

const GmNodeSet *	_nodeGroup
	The node group filter or NULL if there is none.

const GmValueAccessor *	_crdAcc
	The mesh accessor used for retrieving point coordinates.

int	_nDim

GSBIType	_type

Additional Inherited Members
Protected Member Functions inherited from GmPluginObject
virtual const GmLogCategory &	logger () const

GmSimulationData *	simulationData () const

Detailed Description

A base class used by the process to treat all the GmpMmBucketIndexBase<T> derivatives in a generic code (but including type information not existant in the Spatial index generic base class.

Member Enumeration Documentation

◆ GSBIType

enum GmpMmBucketIndex::GSBIType

Enumerator
GSBIT_NODE	Bucket index stores global ids of the mesh nodes.
GSBIT_CELL	Bucket index stores local ids of the mesh nodes in the cell.
GSBIT_GAUSS	Bucket index stores local ids of the mesh gauss points in the element.
GSBIT_NUM_BUCKETYPES	The number of available bucket index types.