groups

Unless otherwise specified, data names are accessible in level 3 only.
activesuppressed
Returns non-zero if the entity is set inactive, 0 otherwise.
attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
cardimage
The name of the assigned card image.
Type: string
cardimagetype
The type of the assigned card image.
Type: string
color
The 1-64 color of the entity.
Type: integer
color_rgb
The RGB color of the entity.
Type: string
component
Pointer to the component (use with the pointer - pointer1.component.name).
config
The configuration of the entity.
0 - none
1 - elem and elem
2 - node and elem
3 - elem
4 - node
5 - rigidwall
6 - ALE
7 - OS body
8 - NSM
Type: unsigned integer
contactsurf
Pointer to the contactsurf.
Type: pointer
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
mainallmodel
Returns true if the main definition is all.
Type: Boolean
mainboxmax
The maximum global x, y and z coordinates for the main box. Valid for hm_getvalue query only.
Type: triple double
mainboxmin
The minimum global x, y and z coordinates for the main box. Valid for hm_getvalue query only.
Type: triple double
mainboxxmax
The maximum global x coordinate for the main box.
Type: double
mainboxxmin
The minimum global x coordinate for the main box.
Type: double
mainboxymax
The maximum global y coordinate for the main box.
Type: double
mainboxymin
The minimum global y coordinate for the main box.
Type: double
mainboxzmax
The maximum global z coordinate for the main box.
Type: double
mainboxzmin
The minimum global z coordinate for the main box.
Type: double
maincomponentlist
Pointer to the main component IDs contained in the group.
Type: pointer
maincomponentlistmax
The number of main components in the group.
Type: integer
maincontactsurflist
Pointer to the main contactsurf IDs contained in the group.
Type: pointer
maincontactsurflistmax
The number of main contactsurfs in the group.
Type: integer
maindefinition
The method used to define the main.
0 - entities
1 - components
2 - boxes
3 - all
4 - sets
5 - contactsurfs
Type: integer
mainelementlist
List of main elements in the group. Valid for hm_getvalue query only.
Type: integer
mainentityids
List of main entity IDs in the group. Valid for hm_getvalue query only.
Type: integer
mainsetlist
Pointer to the main set IDs contained in the group.
Type: pointer
mainsetlistmax
The number of main sets in the group.
Type: integer
material
Material pointer to the material assigned to the group.
Type: pointer
materialid
The ID of the material assigned to the group.
Type: integer
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
parentcgid
The ID of the parent contact group entity.
Type: entity
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
set
Pointer to sets (use with pointer - pointer1.set.name).
secondaryallmodel
Returns true if the secondary definition is all.
Type: Boolean
secondaryboxmax
The maximum global x, y and z coordinates for the secondary box. Valid for hm_getvalue query only.
Type: triple double
secondaryboxmin
The minimum global x, y and z coordinates for the secondary box. Valid for hm_getvalue query only.
Type: triple double
secondaryboxxmax
The maximum global x coordinate for the secondary box.
Type: double
secondaryboxxmin
The minimum global x coordinate for the secondary box.
Type: double
secondaryboxymax
The maximum global y coordinate for the secondary box.
Type: double
secondaryboxymin
The minimum global y coordinate for the secondary box.
Type: double
secondaryboxzmax
The maximum global z coordinate for the secondary box.
Type: double
secondaryboxzmin
The minimum global z coordinate for the secondary box.
Type: double
secondarycomponentlist
Pointer to the secondary component IDs contained in the group.
Type: pointer
secondarycomponentlistmax
The number of secondary components in the group.
Type: integer
secondarycontactsurflist
Pointer to the secondary contactsurf IDs contained in the group.
Type: pointer
secondarycontactsurflistmax
The number of secondary contactsurfs in the group.
Type: integer
secondarydefinition
The method used to define the secondary.
0 - entities
1 - components
2 - boxes
3 - all
4 - sets
5 - contactsurfs
Type: integer
secondaryelementlist
List of secondary elements in the group. Valid for hm_getvalue query only.
Type: integer
secondaryentityids
List of secondary entity IDs in the group. Valid for hm_getvalue query only.
Type: integer
secondarysetlist
Pointer to the secondary set IDs contained in the group.
Type: pointer
secondarysetlistmax
The number of secondary sets in the group.
Type: integer
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
type
The solver dependent type code for the group.
Type: integer
Groups with config 5 (rigid walls) contain the following additional data:
base
The x-, y- and z-coordinates of the base node of the rigid wall.
basenode
Pointer to the base node of the rigid wall.
Type: pointer
basenodeid
The ID of the base node of the rigid wall.
Type: integer
basex
The x-coordinate of the base node of the rigid wall.
Type: double
basey
The y-coordinate of the base node of the rigid wall.
Type: double
basez
The z-coordinate of the base node of the rigid wall.
Type: double
cornernode1
The ID of the first corner node in a rigid wall finite plane or finite prism.
Type: integer
cornernode2
The ID of the second corner node in a rigid wall finite plane or finite prism.
Type: integer
geometrytype
The type of geometry used to define the rigid wall.
1 - infinite plane
2 - finite plane
3 - infinite prism
4 - finite prism
5 - cylinder
6 - sphere
Type: integer
length
Valid for hm_getvalue query only.
Finite planes - Returns the length x and y. (Type: double double)
Finite prisms - Returns the length x, y and z. (Type: triple double)
Cylinders - Returns the length and the radius. (Type: double double)
Spheres - Returns the radius. (Type: double)
lengthx
The length of the rigid wall in the local x direction.
Type: double
lengthy
The length of the rigid wall in the local y direction.
Type: double
lengthz
The length of the rigid wall in the local z direction.
Type: double
madymoid
The ID of the associated MADYMO entity.
Type: integer
midpoint
The x, y and z coordinates of the midpoint of the finite plane when geometrytype is 2. Valid for hm_getvalue query only.
Type: triple double
midpointx
The x coordinate of the midpoint of the finite plane when geometrytype is 2.
Type: double
midpointy
The y coordinate of the midpoint of the finite plane when geometrytype is 2.
Type: double
midpointz
The z coordinate of the midpoint of the finite plane when geometrytype is 2.
Type: double
motion
The x, y and z components of the motion vector. Valid for hm_getvalue query only.
Type: triple double
motiondirection
The x, y and z components of the motion vecto. Valid for hm_getvalue query only.
Type: triple double
motionmagnitude
The magnitude of the motion vector.
Type: double
motiontype
The type of motion.
0 - none
1 - velocity
2 - displacement
Type: integer
motionx
The x component of the motion vector.
Type: double
motiony
The y component of the motion vector.
Type: double
motionz
The z component of the motion vector.
Type: double
normal
The x, y and z components of the normal unit vector. Valid for hm_getvalue query only.
Type: triple double
normalmotionangle
The angle between the motion and the normal vector.
Type: double
normalx
The x component of the normal unit vector.
Type: double
normaly
The y component of the normal unit vector.
Type: double
normalz
The z component of the normal unit vector.
Type: double
pointa
The x, y and z coordinates of Point A on a finite plane as defined in PAM-CRASH. Valid for hm_getvalue query only.
Type: triple double
pointax
The x coordinate of Point A on a finite plane as defined in PAM-CRASH.
Type: double
pointay
The y coordinate of Point A on a finite plane as defined in PAM-CRASH.
Type: double
pointaz
The z coordinate of Point A on a finite plane as defined in PAM-CRASH.
Type: double
radius
The radius of a cylinder or spherical rigid wall.
Type: double
radiusnode
Pointer to the radius node assigned to a cylinder or spherical rigid wall.
Type: pointer
solverkeyword
The name of the solver keyword.
Type: string
xaxis
The x, y and z components of the local x axis unit vector. Valid for hm_getvalue query only.
Type: triple double
xaxisx
The x component of the local x axis unit vector.
Type: double
xaxisy
The y component of the local x axis unit vector.
Type: double
xaxisz
The z component of the local x axis unit vector.
Type: double
yaxis
The x, y and z components of the local y axis unit vector. Valid for hm_getvalue query only.
Type: triple double
yaxisx
The x component of the local y axis unit vector.
Type: double
yaxisy
The y component of the local y axis unit vector.
Type: double
yaxisz
The z component of the local y axis unit vector.
Type: double

Version History

2020 - Added new data names color_rgb and parentcgid.

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.