regions

Unless otherwise specified, data names are accessible in level 3 only.

activesuppressed
Returns non-zero if the entity is set inactive, 0 otherwise.
Type: integer
config
The configuration of the entity.
1 - Geometric entities
3 - Metadata
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
id
The ID of the entity.
Type: unsigned integer
include
The ID of the include file the entity is organized in.
Type: entity
includeid
The ID of the include file the entity is organized in.
Type: unsigned integer
internalid
The ID of the entity.
Type: unsigned integer
internalname
The internal name of the entity.
Type: string
metadata_etype
The entity type of the metadata.
4 - Lines/edges
5 - Surfaces
25 - Points
Type: integer
metadata_name
The name of the metadata.
Type: string
metadata_rule
The etadata rule.
1 - Exists
2 - Match value
3 - Contains value
Type: integer
metadata_value_string
The value of the metadata.
Type: string
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
outputsuppressed
Returns non-zero if the entity is set "do not export", 0 otherwise.
Type: integer
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
queryassociatedelements0D
The list of 0D support elements.
Type: entity array
queryassociatedelements1D
The list of 1D support elements.
Type: entity array
queryassociatedelements2D
The list of 2D support elements.
Type: entity array
queryassociatedelements3D
The list of 3D support elements.
Type: entity array
queryassociatedelementsdim
Returns the support elements' dimension.
-1 - Mixed
0 - 0D
1 - 1D
2 - 2D
3 - 3D
Type: integer
queryassociatednodes
The list of support elements' nodes.
Type: entity array
simpleids
The list of geometric IDs defined by the region.
Type: entity array
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
solvername
The solver name of the entity for entities enabled for name pool, otherwise the internal name of the entity.
Type: string
sourceentities
The list of support entity IDs, no matter how the region is defined. Valid for hm_getvalue query only.
Type: entity array
topo
The topology of entity.
0 - 0-d
10 - 1-d
21 - Edges of 2-d
22 - Faces of 2-d
33 - 3-d solid
Type: integer

Version History

2017.1 - Added topo value 33 for 3-d soilds.

2020.1 - Added new data name solverkeyword.

2021.1 - Added new data names moduleid, poolid, poolname, and solver_id.

2021.2 - Added new data names internalname and solvername.