Bucket index plugin options

Plugin object types

The MmProcess plugin publishes three spatial index object types that can be used while providing the spatial index type name. They are:

• MmProcess.node: The created spatial index will store node references, implementing the nearestNode spatial index query capability.
• MmProcess.cell: The created spatial index will store cell references, implementing the containingCell spatial index query capability.
• MmProcess.gauss: The created spatial index will store Gauss point references, implementing the nearestGauss spatial index query capability.

Spatial index fields

When defining a Spatial index object, the following fields are available for usage during the definition. When filling this table, keep in mind that only options different from the default are needed. When an option is not present in the table its default value will be used.

Attribute	Description	Type	Required	Def. Value
id	The spatial indexh name.	String	Yes
	Example: id = "myIndexName"
typeName	Spatial index plugin name. Should be equal to 'MmProcess.xxx', where xxx = node, cell or gauss as defined above.	String	Yes
	Example: typeName = "MmProcess.node"
description	An optional description of the spatial index purpose.	String	No
mesh	The name of the mesh that this index is tied to.	String	Yes
	Example: mesh = "mesh name"
capacity	The storing capacity of each bucket.	Integer	No	10
gridStartingSize	The grid partitionning the underlying mesh domain will start with a number of cells equals to gridStartingSize in each direction. Setting this value to -1 automatically computes a reasonable value for this number.	Integer	No	-1
nRefineMax	The maximum number of successive refinements a given cell should suffer before considering the bucket capacity is too small.	Integer	No	4
activeOnly	When set to true, only stores the active elements/cells of the mesh. No effect in case of nodes bucket.	Boolean	No	true
nodeSet	Optional filter stating that only the nodes belonging to the given node set should be included in the index. For node buckets only.	String	No	nil
cellGroup	Optional filter stating that only the cells belonging to the given cell group should be included in the index. For cell and gauss buckets only.	String	No	nil
ruleSet	For Gauss points based bucket indices, this option can be used to set the rule set that will be used for defining the Gauss points location inside each element. By default, the standard rule set (1) is used.	Integer	No	1