forces

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

engineering_type
The engineering type of load. Engineering loads act on set entities. Valid values are:
0 - Classic load
3 - Directional engineering load
14 - Composite plate load
Type: unsigned integer

The following data names are available for both classic and engineering loads:

attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
collector
Pointer to the collector that owns the load.
Type: pointer (levels 2, 3, and 4)
config
The configuration of the entity.
1 - Force
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
entityid
The ID of the entity the load is attached to.
Type: integer
entitytype
The type of the entity to which the load is applied.
1 - node
3 - comp
10 - set
27 - point
Type: integer
entitytypename
The string type of the entity to which the load is applied.
nodes
comps
sets
points
Type: string
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
moduleid
The module ID of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
set
Pointer to the set when the load is applied to a set.
Type: pointer
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 entity.
Type: integer
typename
The solver dependent type name for the entity.
Type: string
vectorx
The x component of the unit vector in the global coordinate system.
Type: double
vectory
The y component of the unit vector in the global coordinate system.
Type: double
vectorz
The z component of the unit vector in the global coordinate system.
Type: double

The following data names are available for classic loads:

baselocation
The coordinates where the load on a component or set should display. Valid for hm_getvalue query only.
Also used to convert the load vector components into local values for non-rectangular coordinate systems.
Type: triple double
baselocationx
The x-coordinate where the load on a component or set should display.
Also used to convert the load vector components into local values for non-rectangular coordinate systems.
Type: double
baselocationy
The y-coordinate where the load on a component or set should display.
Also used to convert the load vector components into local values for non-rectangular coordinate systems.
Type: double
baselocationz
The z-coordinate where the load on a component or set should display.
Also used to convert the load vector components into local values for non-rectangular coordinate systems.
Type: double
comp1
The x component of the vector.
Type: double
comp2
The y component of the vector.
Type: double
comp3
The z component of the vector.
Type: double
component
Pointer to the component when the load is applied to a component.
Type: pointer
curveid
The ID of the curve defining the load magnitude when a curve has been used to define the load.
Type: integer
inputsystem
Pointer to the reference system.
Type: pointer
inputsystemid
The ID of the reference system.
Type: integer
local_comp1
The x component of the vector in the local coordinate system.
Type: double
local_comp2
The y component of the vector in the local coordinate system.
Type: double
local_comp3
The z component of the vector in the local coordinate system.
Type: double
local_vector
The load vector in the local coordinate system.
Type: triple double
local_vectorx
The x component of the unit vector in the local coordinate system.
Type: double
local_vectory
The y component of the unit vector in the local coordinate system.
Type: double
local_vectorz
The z component of the unit vector in the local coordinate system.
Type: double
location
The ID of the node where the load is applied. Valid for hm_getvalue query only.
Type: entity
magnitude
The magnitude of the vector.
Type: double
mappedid
The ID of the original load on geometry.
Type: integer
node
Pointer to the node when the load is applied to a node.
Type: pointer
vector
The component of the unit vector. Valid for hm_getvalue query only.
Type: triple double
xscale
The x scale or time scale of the load curve when a curve has been used to define the load.
Type: double

The following data names are available for composite plate loads:

The composite plate loads are only available in OptiStruct, Nastran, and Abaqus profiles.

displayname
The text for the title entry.
Type: string
epsx
The laminate midplane strain in the laminate x direction.
Type: double
epsy
The laminate midplane strain in the laminate y direction.
Type: double
gamxy
The laminate midplane engineering shear strain (in the laminate xy direction).
Type: double
kapx
The laminate curvature in the laminate x direction.
Type: double
kapxy
The laminate curvature in the laminate xy direction.
Type: double
kapy
The laminate curvature in the laminate y direction.
Type: double
mx
The laminate bending moment per unit width in the laminate x direction.
Type: double
mxy
The laminate twisting moment per unit width in the laminate xy direction.
Type: double
my
The laminate bending moment per unit width in the laminate y direction.
Type: double
nx
The laminate in-plane force per unit width in the laminate x direction.
Type: double
nxy
The laminate in-plane shear force per unit width (in the laminate xy direction).
Type: double
ny
The laminate in-plane force per unit width in the laminate y direction.
Type: double
qx
The laminate transverse shear force per unit width in the laminate xz direction.
Type: double
qy
The laminate transverse shear force per unit width in the laminate yz direction.
Type: double
sigfx
The laminate average flexural stress in the laminate x direction.
Type: double
sigfy
The laminate average flexural stress in the laminate y direction.
Type: double
sigx
The laminate average stress in the laminate x direction.
Type: double
sigy
The laminate average normal stress in the laminate y direction.
Type: double
thermal_bottom
The difference of laminate temperature at the bottom (z min) surface and laminate reference temperature.
Type: double
thermal_top
The difference of laminate temperature at the top (z max) surface and laminate reference temperature.
Type: double
taufxy
The laminate average flexural stress in the laminate xy direction.
Type: double
tauxy
The laminate average in-plane shear stress (in the laminate xy direction).
Type: double
tauyz
The laminate average transverse shear stress in the laminate yz direction.
Type: double
tauzx
The laminate average transverse shear stress in the laminate zx direction.
Type: double

The following data names are available for engineering loads:

compx
The dot product of the load vector projected on the global x axis.
Type: double
compy
The dot product of the load vector projected on the global y axis.
Type: double
compz
The dot product of the load vector projected on the global z axis.
Type: double
distribution_table_count
The number of rows of a non-uniform engineering load.
Type: unsigned integer
field
The field entity that stores the tabular load data.
Type: entity
location_unit_node
The nodes for which the data is stored in the table for a non-uniform engineering load.
Type: entity array
orient
The load orientation vector.
Type: triple double
orientx
The x component of the load orientation vector.
Type: double
orienty
The y component of the load orientation vector.
Type: double
orientz
The z component of the load orientation vector.
Type: double
resultant_magnitude
The resultant scalar component of the load vector in the global coordiante system.
Type: double

The following data names are available for ADVC engineering loads:

displayname
The text for the title entry.
Type: string
distribution
The distribution type:
0 - Uniform
1 - Non-uniform
Type: unsigned integer
expanded_form_flag
Flag to export loads on nodes.
Type: Boolean
keyword_name
Flag to specify if the title entry is enabled.
Type: Boolean
load_step_id
The ID of the referred loadstep.
Type: entity
magnitude
The scale factor (default 1.0).
Type: double
prev_bc
Flag to hold previously applied boundary conditions.
Type: Boolean
vector
The direction of the force vector. At least one of the vector components must be non-zero.
Type: triple double

The following data names are available for LS-DYNA engineering loads:

crash_dir_flag
Input flag to determine if directions can be input using vector or using crash direction semantics.
0 – Select global direction
1 – Select direction component
Type: integer
curveid
The load curve ID.
Type: entity
follower_load
Flag that activates the follower load options.
Type: Boolean
force_ev_fn
Flag that activates force as a function of the absolute value of the rigid body displacement.
Type: Boolean
inputsystem
The coordinate system ID.
Type: entity
load_dof
Applicable degree-of-freedom for LOAD_NODE (type=1) and LOAD_RIGID_BODY (type=2).
1 – X-direction of load action
2 – Y-direction of load action
3 – Z-direction of load action
4 – Follower force
Type: integer
magnitude
The load curve scale factor (default 1.0).
Type: double
plane_node1
The node 1 ID for LOAD_NODE (type=1) and LOAD_RIGID_BODY (type=2). Only necessary if load_dof=4.
Type: entity
plane_node2
The node 2 ID for LOAD_NODE (type=1) and LOAD_RIGID_BODY (type=2). Only necessary if load_dof=4.
Type: entity
plane_node3
The node 3 ID for LOAD_NODE (type=1) and LOAD_RIGID_BODY (type=2). Only necessary if load_dof=4.
Type: entity
rigid_part
The part ID of the rigid body.
Type: entity
vector
Force load vector components in the coordinate system CID.
Type: triple double

The following data names are available for Nastran and OptiStruct engineering loads:

distribution
The distribution type:
0 - Uniform
1 - Non-uniform
Type: unsigned integer
inputsystem
The coordinate system ID. A value of 0 or blank references the basic coordinate system.
Type: entity
magnitude
For FORCE, the scale factor.
For FORCE1, the force magnitude.
Type: double
os_g1
The grid point ID.
Type: entity
os_g2
The grid point ID.
Type: entity
vector
The direction of the force vector measured in the system defined by CID. At lesat one of the vector components must be non-zero.
Type: triple double

The following data names are available for OptiStruct engineering loads:

curveid
The ID of the MBCRV entries giving load versus independent variable measured in the coordinate system defined by CID.
Type: integer
expanded_form_flag
Flag to export loads on nodes.
Type: Boolean
follower_load
Flag to activate follower load options.
Type: Boolean
os_eid
The ID of the MBVAR for the independent variable expression.
Type: entity
os_g4
The grid point ID whose parent body hosts the coordinate system with repect to which the force is defined. The force vector changes direction with the orientation of the body. If not specified, the force is defined with repect to the ground body (the basic coordinate system).
Type: entity
os_intrp_type
The interpolation type. Valid values are AKIMA (default), CUBIC or LINEAR.
Type: string

The following data names are available for Radioss engineering loads:

curveid
The ID of the curve defining the time function identifier.
Type: entity
crash_dir_flag
Specifies if directions can be input using vector or crash direction semantics:
0 - Select global direction
1 - Select direction component
Type: unsigned integer
crash_dofstring
The sring that outputs the computed DOF directions, useful if the direction is specified using a string vector.
Type: string
displayname
The text for the title entry.
Type: string
inputsystem
The system ID for the skew identifier.
Type: entity
magnitude
The ordinate scale factor (default 1.0).
Type: double
rad_dir
The direction in translation. Valid values are X, Y and Z. Only valid for CLOAD.
Type: string
rad_itype
The preloading type.
1 - Preload is a force (default).
2 - Preload is a stress.
Type: integer
rad_sect_id
The section identifier to which preloading is applied.
Type: entity
rad_sensor_id
The ID of the sensor entity for CLOAD.
Type: entity
xscale
The abscissa (time) scale factor (default 1.0).
Type: double

Version History

2020 - New support for engineering loads. Added new data names compx, compy, compz, crash_dir_flag, crash_dofstring, displayname, distribution, distribution_table_count, engineering_type, expanded_form_flag, field, follower_load, local_comp1, local_comp2, local_comp3, local_vector, local_vectorx, local_vectory, local_vectorz, location, location_unit_node, orient, orientx, orienty, orientz, os_eid, os_g1, os_g2, os_g4, os_intrp_type, rad_dir, rad_sensor_id and resultant_magnitude.

2020.1 - Added new data name solverkeyword.

2021 - Added new data names keyword_name, load_step_id and prev_bc. New ADVC support.

2021.1 – Added new data names for LS-DYNA engineering loads: crash_dir_flag, curveid, follower_load, force_ev_fn, inputsystem, load_dof, magnitude, plane_node1, plane_node2, plane_node3, rigid_part and vector.

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

2021.2 - Added new engineering_type value 14 and new data names for composite plate loads: epsx, epsy, gamxy, kapx, kapxy, kapy, mx, mxy, my, nx, nxy, ny, qx, qy, sigfx, sigfy, sigx, sigy, taufxy, tauxy, tauyz, and tauzx. Added new data names for Radioss engineering loads rad_itype and rad_sect_id. Added new data names internalname and solvername.

2022.1 - Added new data names for composite plate loads thermal_bottom and thermal_top.