velocities

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
2 - Normal engineering load
3 - Directional engineering 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 element.
Type: pointer (levels 2, 3 and 4)
config
The configuration of the entity.
8 - Velocity
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
  • 5 - surf
  • 10 - set
  • 27 - point
  • 28 - line
Type: integer
entitytypename
The string type of the entity to which the load is applied.
  • nodes
  • comps
  • surfs
  • sets
  • points
  • lines
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
poolid
The pool number 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 in the global coordinate system.
Type: double
comp2
The y component of the vector in the global coordinate system.
Type: double
comp3
The z component of the vector in the global coordinate system.
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 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 coordinate system.
Type: double

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

activation_time
The time the imposed motion is activated (default 0.0).
Type: double
analysis_phase
Flag specifying phase of the analysis the velocities apply to for INITIAL_VELOCITY_GENERATION (type=6):
0 – Velocities are applied immediately (default)
1 – Velocities are applied after reaching the start time
Type: integer
ang_vel_center
The rotational axis vector.
Type: triple double
angular_velocity
The angular velocity about the rotational axis (default 0.0).
Type: double
box_region_def
The box ID.
Type: entity
curveid
The load curve ID.
Type: entity
deactivation_time
Time imposed motion is removed (default 1020).
Type: double
displayname
For the title name entry.
Type: string
dyn_relax_evolve_fn
The load curve ID during the dynamic relaxation phase.
Type: entity
entity_select_option
Flag that enables node selection for NY and NZ for INITIAL_VELOCITY_GENERATION (type=6).
Type: Boolean
exempt_node_init_trans_vel
The initial translational velocity of exempted nodes.
Type: triple double
exempt_node_init_rot_vel
The initial rotational velocity of exempted nodes.
Type: triple double
exempt_nodes
The node set ID containing nodes that are exempted from the imposed velocities.
Type: entity
init_rot_vel
The initial rotational velocity.
Type: triple double
init_vel_hierarchy
The option to control hierarchy of initial velocities.
0 - *PART_INERTIA / *CONSTRAINED_NODAL_RIGID_BODY_INERTIA controls initial velocities (default)
1 - *INITIAL_VELOCITY_GENERATION controls initial velocities
Type: integer
init_vel_secondary_nodes_part
Flag for setting the initial velocities of secondary nodes and parts.
0 - Secondary parts are ignored (default)
1 - Secondary parts and secondary nodes of the main parts will be assigned initial velocities like the main part
Type: integer
inputsystem
The coordinate system ID.
Type: entity
keyword_name
Flag that activates ID option.
Type: Boolean
load_body_opt
Angular velocity option. Valid options are RX, RY or RZ.
Type: string
load_dof
Applicable degrees-of-freedom for BOUNDARY_PRESCRIBED_MOTION (type=1):
1 - x-translational degree-of-freedom
2 - y-translational degree-of-freedom
3 - z-translational degree-of-freedom
4 - Translational motion in direction given by the VID. Movement on plane normal to the vector is permitted.
-4 - Translational motion in direction given by the VID. Movement on plane normal to the vector is not permitted.
5 - x-rotational degree-of-freedom
6 - y-rotational degree-of-freedom
7 - z-rotational degree-of-freedom
8 - Rotational motion about a vector parallel to vector VID. Rotation about the normal axes is permitted.
-8 - Rotational motion about a vector parallel to vector VID. Rotation about the normal axes is not permitted.
9 - Rotation motion about axis parallel to the x-axis. Radial motion is not permitted.
-9 - Rotation motion about axis parallel to the x-axis. Radial motion is permitted.
10 - Rotation motion about axis parallel to the y-axis. Radial motion is not permitted.
-10 - Rotation motion axis parallel to the y-axis. Radial motion is permitted.
11 - Rotation motion about axis parallel to the z-axis. Radial motion is not permitted.
-11 - Rotation motion about axis parallel to the z-axis. Radial motion is permitted.
Type: integer
magnitude
The load curve scale factor (default 1.0).
Type: double
motion_rigid_local_option
Flag that activates the LOCAL option.
Type: Boolean
motion_type
Velocity/Acceleration/Displacement flag.
0 - Velocity (rigid bodies and nodes)
1 - Acceleration (rigid bodies and nodes)
2 - Displacement (rigid bodies and nodes)
3 - Velocity versus displacement (rigid bodies only)
4 - Relative displacement (rigid bodies only)
Type: integer
motion_vec_dir
The vector ID for BOUNDARY_PRESCRIBED_MOTION (type=1) for load_dof values 4 and 8.
Type: entity
nodal_rigid_body
The element ID of the constrained nodal rigid body.
Type: entity
part_set_overwrite_vel
The part set ID.
Type: entity
plane_axis_coord1
For BOUNDARY_PRESCRIBED_MOTION: Offset for DOF types 9 - 11 (y, z, x direction) (default 0.0).
Type: double
plane_axis_coord2
For BOUNDARY_PRESCRIBED_MOTION: Offset for DOF types 9 - 11 (z, x, y direction) (default 0.0).
Type: double
plane_node1
For INITIAL_VELOCITY_GENERATION: Node 1 of the rotational axis.
Type: entity
plane_node2
For INITIAL_VELOCITY_GENERATION: Node 2 of the rotational axis.
Type: entity
region_type
Region selection option.
1 - Select part set or node set on entityid dataname
2 - Select rigid body on rigid_part dataname
0 - Velocity is applied on entire model
Type: unsigned integer
rgd_bdy_vel_opt_overwrite
For INITIAL_VELOCITY: Option to overwrite rigid body velocities.
1 - Select part set entity on ‘part_set_overwrite_vel’ dataname
-1 - Overwrite velocities for all rigid bodies that have a center of gravity within box BOXID
-2 - Overwrite velocities for all rigid bodies
Type: integer
rigid_part
The part ID of the rigid body.
Type: entity
rigidbody_option
Flag that enables nodal rigid body selection.
Type: Boolean
set_type
Set type.
Type: unsigned integer
vector
The initial translational velocity.
Type: triple double
xcosine
X-direction cosine (default 0.0).
Type: double
ycosine
Y-direction cosine (default 0.0).
Type: double
zcosine
Z-direction cosine (default 0.0).
Type: double

The following data names are available for Radioss engineering loads:

curveid
The ID of the time function identifier curve.
Type: entity
displayname
The text for the title entry.
Type: string
distribution
The spring specification for IMPVEL_FGEO:
0 - Spring part selection
1 - Final node positions
Type: unsigned integer
inputsystem
The skew/frame identifier.
Type: entity
magnitude
The ordinate (velocity) scale factor for fct_ID (default 1.0).
Type: double
rad_dir
The direction X, Y, or Z for translation or XX, YY, or ZZ for rotation.
Type: string
rad_dmin
The distance between node ID N and node ID N', which are rigidly connected.
Type: double
rad_ebcs_c
The speed of sound (default 0.0).
Type: double
rad_ebcs_fscale_en
The energy scale factor (default 0.0).
Type: double
rad_ebcs_fscale_pr
The pressure scale factor (default 0.0).
Type: double
rad_ebcs_fscale_rho
The density scale factor (default 0.0).
Type: double
rad_ebcs_fscale_vx
The x velocity scale factor (default 0.0).
Type: double
rad_ebcs_fscale_vy
The y velocity scale factor (default 0.0).
Type: double
rad_ebcs_fscale_vz
The z velocity scale factor (default 0.0).
Type: double
rad_ebcs_lc
The characteristic length (default 0.0).
Type: double
rad_ebcs_r1
The linear resistance (default 0.0).
Type: double
rad_ebcs_r2
The quadratic resistance (default 0.0).
Type: double
rad_ebcs_rho
The initial density (default 0.0).
Type: double
rad_fct_en
The function identifier for energy.
Type: entity
rad_fct_l_id
The load time function identifier.
Type: entity
rad_fct_pr
The function identifier for pressure.
Type: entity
rad_fct_rho
The function identifier for density.
Type: entity
rad_fct_vx
The function identifier for x velocity.
Type: entity
rad_fct_vy
The function identifier for y velocity.
Type: entity
rad_fct_vz
The function identifier for z velocity.
Type: entity
rad_grquad_id
The quad groups on which the specific initial velocities are applied.
Type: entity
rad_grtria_id
The tria groups on which the specific initial velocities are applied.
Type: integer
rad_icoor
The coordinate system type:
0 - Cartesian
1 - Cylindrical
Type: integer
rad_inivel_type
Enables selection of INIVEL type:
GRID - Grid material velocity (only for ALE material)
ROT - Rotational material velocity
T+G - Translational and grid material velocity *only for ALE material)
TRA - Translational material velocity
Type: string
rad_node_id
The node identifier giving the final position of the node.
Type: entity
rad_rotational_velocity
The rotational velocity about the rotational axis.
Type: double
rad_sensor_id
The ID of the sensor entity.
Type: entity
rad_spring_part
The spring part identifier.
Type: entity
rad_system_input_type
The system input type:
0 - Skew
1 - Frame
Type: unsigned integer
rad_t0
The time duration.
Type: double
rad_tstart
The start time.
Type: double
rad_tstop
The stop time (default 1030).
Type: double
vector
The velocity vector.
Type: triple double
xscale
The abscissa (time) scale factor for fct_IDT (default 1.0).
Type: double

Version History

2020 - New support for engineering loads. Added new data names compx, compy, compz, displayname, distribution, distribution_table_count, engineering_type, field, local_comp1, local_comp2, local_comp3, local_vector, local_vectorx, local_vectory, local_vectorz, location, location_unit_node, orient, orientx, orienty, orientz, rad_dir, rad_dmin, rad_ebcs_c, rad_ebcs_fscale_en, rad_ebcs_fscale_pr, rad_ebcs_fscale_rho, rad_ebcs_fscale_vx, rad_ebcs_fscale_vy, rad_ebcs_fscale_vz, rad_ebcs_lc, rad_ebcs_r1, rad_ebcs_r2, rad_ebcs_rho, rad_fct_l_id, rad_fct_en, rad_fct_pr, rad_fct_rho, rad_fct_vx, rad_fct_vy, rad_fct_vz, rad_icoor, rad_inivel_type, rad_node_id, rad_sensor_id, rad_spring_part, rad_system_input_type, rad_t0, rad_rotational_velocity, rad_tstart, rad_tstop and resultant_magnitude.

2020.1 - Added new data name solverkeyword.

2021.1 – Added new data names for LS-DYNA engineering loads: activation_time, analysis_phase, ang_vel_center, angular_velocity, box_region_def, curveid, deactivation_time, displayname, dyn_relax_evolve_fn, entity_select_option, exempt_node_init_rot_vel, exempt_node_init_trans_vel, exempt_nodes, init_rot_vel, init_vel_hierarchy, init_vel_secondary_nodes_part, inputsystem, keyword_name, load_body_opt, load_dof, magnitude, motion_rigid_local_option, motion_type, motion_vec_dir, nodal_rigid_body, part_set_overwrite_vel, plane_axis_coord1, plane_axis_coord2, plane_node1, plane_node2, region_type, rgd_bdy_vel_opt_overwrite, rigid_part, rigidbody_option, set_type, vector, xcosine, ycosine, and zcosine.

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

2021.2 - Added new data names for Radioss engineering loads rad_grquad_id and rad_grtria_id. Added new data names internalname and solvername.