constraints

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
5 - Non-weighted constraint engineering load
6 - Weighted constraint engineering load
7 - Thermal 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 load.
Type: pointer(levels 2, 3, and 4)
config
The configuration of the entity.
3 - Constraint
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
dofstring
The DOF information in string form. Valid for hm_getvalue query only.
Type: string
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
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
set
Pointer to the set when the load is applied to a set.
Type: pointer
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
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

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 value in DOF1 or -999999.0 for none.
Type: double
comp2
The value in DOF2 or -999999.0 for none.
Type: double
comp3
The value in DOF3 or -999999.0 for none.
Type: double
comp4
The value in DOF4 or -999999.0 for none.
Type: double
comp5
The value in DOF5 or -999999.0 for none.
Type: double
comp6
The value in DOF6 or -999999.0 for none.
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
equalmagnitude
Returns 1 if all six DOFs are equal, 0 otherwise.
Type: integer
inputsystem
Pointer to the reference system.
Type: entity
location
The ID of the node where the load is applied. Valid for hm_getvalue query only.
Type: entity
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
spc
1 if at least ond of the six DOF is constrained, 0 otherwise. Valid for hm_getvalue query only.
Type: 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:

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

The following data names are available for Abaqus engineering loads:

boundary_region
The type of boundary region on which pressure is applied.
LAGRANGIAN - Apply the pressure to a Lagrangian boundary region (default)
SLIDING - Apply the pressure load to a Sliding boundary region
EULERIAN - Apply the pressure to an Eulerian boundary region
Type: string
comp1
Actual magnitude of the variable for DOF1.
Type: double
comp2
Actual magnitude of the variable for DOF2.
Type: double
comp3
Actual magnitude of the variable for DOF3.
Type: double
comp4
Actual magnitude of the variable for DOF4.
Type: double
comp5
Actual magnitude of the variable for DOF5.
Type: double
comp6
Actual magnitude of the variable for DOF6.
Type: double
curveid
The amplitude curve that defines the variation of the load magnitude during the step.
Type: entity
distribution
The distribution type:
0 - Uniform
1 - Non-uniform
Type: unsigned integer
dof1
Degrees of freedom in x-axis.
0 - Free DOF
1 - DOF Constrained
Type: Boolean
dof2
Degrees of freedom in y-axis.
0 - Free DOF
1 - DOF Constrained
Type: Boolean
dof3
Degrees of freedom in z-axis.
0 - Free DOF
1 - DOF Constrained
Type: Boolean
dof4
Degrees of freedom for rotation about x-axis.
0 - Free DOF
1 - DOF Constrained
Type: Boolean
dof5
Degrees of freedom for rotation about y-axis.
0 - Free DOF
1 - DOF Constrained
Type: Boolean
dof6
Degrees of freedom for rotation about z-axis.
0 - Free DOF
1 - DOF Constrained
Type: Boolean
equalmagnitude
Actual magnitude of the variable.
Type: double
expanded_form_flag
Flag to export loads on nodes.
Type: Boolean
firstdof
The first degree of freedom constrained.
Type: unsigned integer
lastdof
The last degree of freedom constrained.
Type: unsigned integer
load_case
The load case number (1 or 2).
Type: integer
variable_type
The parameter to define the type of the magnitude or the variable nature of the magnitude.
DISPLACEMENT - Displacement history (default)
VELOCITY - Velocity history
ACCELERATION - Aacceleration history
FIXED - The values of the variables being prescribed remain fixed throughout the step.
USER - Any nonzero magnitudes associated with variables prescribed through this option can be redefined in a user subroutine.
Type: string

The following data names are available for ADVC engineering loads:

comp1
The ForcedDisplacement/ForcedVelocity value in the x-direction.
Type: double
comp2
The ForcedDisplacement/ForcedVelocity value in the y-direction.
Type: double
comp3
The ForcedDisplacement/ForcedVelocity value in the z-direction.
Type: double
comp4
The ForcedDisplacement/ForcedVelocity value about the x-direction.
Type: double
comp5
The ForcedDisplacement/ForcedVelocity value about the y-direction.
Type: double
comp6
The ForcedDisplacement/ForcedVelocity value about the z-direction.
Type: double
distribution
The distribution type:
0 - Uniform
1 - Non-uniform
Type: unsigned integer
dof1
The translation in x:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof2
The translation in y:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof3
The translation in z:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof4
The rotation in x:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof5
The rotation in y:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof6
The rotation in z:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
expanded_form_flag
Flag to export loads on nodes.
Type: Boolean
load_step_id
The ID of the referred loadstep.
Type: entity
prev_bc
Flag to hold previously applied boundary conditions.
Type: Boolean

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

activation_time
The activation time for constraint (default 0.0).
Type: double
ang_vel_center
The rotational axis vector.
Type: triple double
curveid
The curve ID or function ID.
Type: entity
deactivation_time
The deactivation time for constraint (default 1020).
displayname
The description of the loading.
Type: string
dof1
The translation in x:
0 = Free DOF
1 = Translational constraint in local x-direction.
Type: Boolean
dof2
0 = Free DOF
1 = Translational constraint in local y-direction.
Type: Boolean
dof3
The translation in z:
0 = Free DOF
1 = Translational constraint in local z-direction
Type: Boolean
dof4
The rotation in x:
0 = Free DOF
1 = Rotational constraint in local x-direction
Type: Boolean
dof5
The rotation in y:
0 = Free DOF
1 = Rotational constraint in local y-direction
Type: Boolean
dof6
The rotation in z:
0 = Free DOF
1 = Rotational constraint in local z-direction
Type: Boolean
dyna_death
The death time for NID.
Type: double
dyna_deathd
The default death time.
Type: double
dyna_final_geometry_coords
The x, y, and z coordinates of the final geometry.
Type: triple double
dyna_lcid
The ID of the load curve for NID.
Type: entity
dyna_lcidf
The ID of the default load curve.
Type: entity
inputsystem
The coordinate system ID (default 1020).
Type: entity
keyword_name
Flag that activates ID option.
Type: Boolean
load_boundary_nodes
The node set ID for second boundary for BOUNDARY_CYCLIC (type=6).
Type: entity
load_dof
For BOUNDARY_PRESCRIBED_MOTION (type=2):
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 about 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.
For LOAD_GRAVITY_PART (type=0):
1 – Direction X
2 – Direction Y
3 – Direction Z
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=2) for load_dof values 4 and 8.
Type: entity
nodal_rigid_body
The element ID of the constrained nodal rigid body.
Type: entity
plane_axis_coord1
The offset for BOUNDARY_PRESCRIBED_MOTION (type=2) for load_dof types 9 - 11 (y, z, x direction) (default 0.0).
Type: double
plane_axis_coord2
The offset for BOUNDARY_PRESCRIBED_MOTION (type=1) for load_dof types 9 - 11 (z, x, y direction) (default 0.0).
plane_node3
Orientation node 2 ID for BOUNDARY_PRESCRIBED_MOTION (type=2) for relative displacement.
Type: entity
rel_disp_ref_body
The part ID of the main rigid body.
Type: entity
rigidbody_option
Flag that enables nodal rigid body selection.
Type: Boolean
rigid_part
The part ID of the rigid body.
Type: entity
sort_nodes
Flag to set automatic sorting of nodes in node sets for BOUNDARY_CYCLIC (type=6).
0 – Do not sort nodes (default)
1 – Automatic osrting of nodes in node sets
Type: integer
symmetry_repetition_dir
Flag for repeating symmetry:
0 – Axisymmetric cyclic symmetry (default)
1 – Repeating symmetry in planes normal to global X
2 – Repeating symmetry in planes normal to global Y
3 – Repeating symmetry in planes normal to global Z
Type: integer
time_activate_option
Flag that activates the BIRTH_DEATH option.
Type: Boolean

The following data names are available for Nastran engineering loads:

nas_sname
The set name. SNAME may refer to any of the set names given in degree-of-freedom sets, or their new names on the DEFUSET entry.
Type: string

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

comp1
The value of enforced motion for components Gi at grid Ci.
Type: double
comp2
The value of enforced motion for components Gi at grid Ci.
Type: double
comp3
The value of enforced motion for components Gi at grid Ci.
Type: double
comp4
The value of enforced motion for components Gi at grid Ci.
Type: double
comp5
The value of enforced motion for components Gi at grid Ci.
Type: double
comp6
The value of enforced motion for components Gi at grid Ci.
Type: double
constraint_dof_flag
The constraint type.
For DAREA and TIC, valid values are 0 to 6.
For MOTNG and MOTNGC, valid values are 0 to 18.
Type: unsigned integer
constraint_flag
0 - Translational DOFs (dof1, dof2, dof3)
1 - Rotational DOFs (dof4, dof5, dof6)
2 - All DOFs
Type: unsigned integer
distribution
The distribution type:
0 - Uniform
1 - Non-uniform
Type: unsigned integer
dof1
The translation in x:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof2
The translation in y:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof3
The translation in z:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof4
The rotation in x:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof5
The rotation in y:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof6
The rotation in z:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
magnitude
In OptiStruct and Nastran, it is the initial displacement or initial velocit in the TIC card, or the area scale factor in the DAREA card.
In OptiStruct , it is the scale factor in MOTNG(D), MOTNG(V) and MOTNG(A) cards.
Type: double
os_d0
The initial displacement if motion is acceleration or velocity, ignored otherwise. Additionally, it also represents the time delay for point Pi and component Ci of the DELAY card with DAREA.
Type: double
os_delay_flag
Enables the time delay term in the dynamic loading fucntion.
Type: Boolean
os_dphase_flag
Enables the phase lead term in the dynamic loading fucntion.
Type: Boolean
os_enforced_deform
The value of the enforced motion for weighted constraints (for example, SPC, SPCD).
Type: double
os_spc_f_flag
If enabled, retain the deformed boundary.
Type: Boolean
os_v0
The initial velocity if motion is acceleration, ignored otherwise. Additionally, it also represents the phase lead in degrees of the DPHASE card with DAREA.
Type: double

The following data names are available for OptiStruct engineering loads:

curveid
The ID of the MBCRV entries giving motion versus time.
Type: integer
expanded_form_flag
Flag to export loads on nodes.
Type: Boolean
os_eid
The ID of the MBVAR for the independent variable expression.
Type: entity
os_g2
The grid point ID to define relative motion.
Type: entity
os_intrp_type
The interpolation type. Valid values are AKIMA (default), CUBIC or LINEAR.
Type: string
os_sname
The set name. If not equal to U6 or ZEROU6, USET will be ignored. If set to ZEROU6, the degrees-of-freedom are omitted from the set.
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
displayname
The text for the title entry.
Type: string
distribution
The spring specification in the IMPDISP_FGEO card:
0 - Spring part selection
1 - Final node psotions
Type: unsigned integer
dof1
The translation in x:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof2
The translation in y:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof3
The translation in z:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof4
The rotation in x:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof5
The rotation in y:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
dof6
The rotation in z:
0 - Free DOF
1 - Fixed DOF
Type: Boolean
inputsystem
The skew or frame system.
Type: entity
magnitude
The ordinate (displacement) scale factor for fct_IDT.
Type: double
rad_dir
The direction X, Y or Z in traslation or XX, YY or ZZ in rotation.
Type: string
rad_icoor
The coordinate system usage type:
0 - Cartesian coordinates
1 - Cylindrical coordinates
Type: integer
rad_node_pos
The coordinates of the position node
Type: triple double
rad_sensor_id
The ID of the sensor entity.
Type: entity
rad_sphbcs_ilev
The formulation level:
0 - Particles crossing the symmetry plane will progressively not be taken into account in the computation
1 - Particles will rebound on the symmetry plane, following the elastic shock equations (SPH symmetry conditions)
Type: integer
rad_sphbcs_type
The symmetry condition type:
Slide - Material is perfectly sliding along the plane
Tied - Material cannot slide along the symmetry plane
Type: string
rad_spring_part
The ID of the spring part.
Type: entity
rad_system_input_type
The ID of the reference frame. Must be fixed.
Type: unsigned integer
rad_tstart
The start time.
Type: double
rad_tstop
The stop time (default 10^30).
Type: double
xscale
The abcissa (time) scale factor for fct_IDT.
Type: double

Version History

2020 - New support for engineering loads. Added new data names constraint_flag, constraint_dof_flag, displayname, distribution, dof1, dof2, dof3, dof4, dof5, dof6, displayname, distribution, engineering_type, expanded_form_flag, location, nas_sname, os_d0, os_delay_flag, os_dphase_flag, os_eid, os_enforced_deform, os_g2, os_intrp_type, os_sname, os_spc_f_flag, os_v0, rad_dir, rad_icoor, rad_node_pos, rad_sensor_id, rad_sphbcs_ilev, rad_sphbcs_type, rad_spring_part, rad_system_input_type, rad_tstart, rad_tstop and spc.

2020.1 - Added new data name solverkeyword.

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

2021.1 – Added new data names for LS-DYNA engineering loads: activation_time, ang_vel_center, curveid, deactivation_time, displayname, dof1, dof2, dof3, dof4, dof5, dof6, inputsystem, keyword_name, load_boundary_nodes, load_dof, magnitude, motion_rigid_local_option, motion_type, motion_vec_dir, nodal_rigid_body, plane_axis_coord1, plane_axis_coord2, plane_node2, plane_node3, rel_disp_ref_body, rigid_part, rigidbody_option, sort_nodes, symmetry_repetition_dir, and time_activate_option. Removed data name for Radioss: constraint_flag.

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

2021.2 - Added new data names internalname and solvername.

2022.1 - Added new data names for LS-DYNA engineering loads dyna_death, dyna_deathd, dyna_final_geometry_coords, dyna_lcid, and dyna_lcidf.

2022.2 - Added new data names for Abaqus engineering loads: boundary_region, firstdof, lastdof, load_case, and variable_type.