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
masterallmodel
Returns true if the master definition is all.
Type: Boolean
masterboxmax
The maximum global x, y and z coordinates for the master box. Valid for hm_getvalue query only.
Type: triple double
masterboxmin
The minimum global x, y and z coordinates for the master box. Valid for hm_getvalue query only.
Type: triple double
masterboxxmax
The maximum global x coordinate for the master box.
Type: double
masterboxxmin
The minimum global x coordinate for the master box.
Type: double
masterboxymax
The maximum global y coordinate for the master box.
Type: double
masterboxymin
The minimum global y coordinate for the master box.
Type: double
masterboxzmax
The maximum global z coordinate for the master box.
Type: double
masterboxzmin
The minimum global z coordinate for the master box.
Type: double
mastercomponentlist
Pointer to the master component IDs contained in the group.
Type: pointer
mastercomponentlistmax
The number of master components in the group.
Type: integer
mastercontactsurflist
Pointer to the master contactsurf IDs contained in the group.
Type: pointer
mastercontactsurflistmax
The number of master contactsurfs in the group.
Type: integer
masterdefinition
The method used to define the master.
0 - entities
1 - components
2 - boxes
3 - all
4 - sets
5 - contactsurfs
Type: integer
masterelementlist
List of master elements in the group. Valid for hm_getvalue query only.
Type: integer
masterentityids
List of master entity IDs in the group. Valid for hm_getvalue query only.
Type: integer
mastersetlist
Pointer to the master set IDs contained in the group.
Type: pointer
mastersetlistmax
The number of master 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
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
set
Pointer to sets (use with pointer - pointer1.set.name).
slaveallmodel
Returns true if the slave definition is all.
Type: Boolean
slaveboxmax
The maximum global x, y and z coordinates for the slave box. Valid for hm_getvalue query only.
Type: triple double
slaveboxmin
The minimum global x, y and z coordinates for the slave box. Valid for hm_getvalue query only.
Type: triple double
slaveboxxmax
The maximum global x coordinate for the slave box.
Type: double
slaveboxxmin
The minimum global x coordinate for the slave box.
Type: double
slaveboxymax
The maximum global y coordinate for the slave box.
Type: double
slaveboxymin
The minimum global y coordinate for the slave box.
Type: double
slaveboxzmax
The maximum global z coordinate for the slave box.
Type: double
slaveboxzmin
The minimum global z coordinate for the slave box.
Type: double
slavecomponentlist
Pointer to the slave component IDs contained in the group.
Type: pointer
slavecomponentlistmax
The number of slave components in the group.
Type: integer
slavecontactsurflist
Pointer to the slave contactsurf IDs contained in the group.
Type: pointer
slavecontactsurflistmax
The number of slave contactsurfs in the group.
Type: integer
slavedefinition
The method used to define the slave (integer).
0 - entities
1 - components
2 - boxes
3 - all
4 - sets
5 - contactsurfs
slaveelementlist
List of slave elements in the group. Valid for hm_getvalue query only.
Type: integer
slaveentityids
List of slave entity IDs in the group. Valid for hm_getvalue query only.
Type: integer
slavesetlist
Pointer to the slave set IDs contained in the group.
Type: pointer
slavesetlistmax
The number of slave sets in the group.
Type: integer
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
7 - MADYMO plane
8 - MADYMO ellipse
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 PAMCRASH . Valid for hm_getvalue query only.
Type: triple double
pointax
The x coordinate of Point A on a finite plane as defined in PAMCRASH.
Type: double
pointay
The y coordinate of Point A on a finite plane as defined in PAMCRASH.
Type: double
pointaz
The z coordinate of Point A on a finite plane as defined in PAMCRASH.
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.