2022.2 API Programmer's Guide

To create a *DEFINE_ELEMENT_DEATH keyword:

*createentity elementbehaviors config=101

To create a *DEFINE_ELEMENT_EROSION keyword:

*createentity elementbehaviors config=102

To set the value of the ‘PERCENT’ field on a *DEFINE_ELEMENT_DEATH card and the ‘NUMFIP’ on a *DEFINE_ELEMENT_EROSION card:

*setvalue elementbehaviors id=1 STATUS=1 PERCENT=1.0
*setvalue elementbehaviors id=1 STATUS=1 NUMFIP=10.0

The query the fields on a *DEFINE_ELEMENT_DEATH or a *DEFINE_ELEMENT_EROSION card:

hm_getvalue elementbehaviors id=1 dataname=PERCENT
hm_getvalue elementbehaviors id=1 dataname=NUMFIP

To create a *DEFINE_CONNECTION_PROPERTIES keyword:

*createentity materialbehaviors config=111

To create a *DEFINE_CONNECTION_PROPERTIES_ADD keyword:

*createentity materialbehaviors config=111 ADD_option=1

To set the value of the ‘PRUL’ field on a *DEFINE_CONNECTION_PROPERTIES card and the ‘Number_of_Materials’ on a *DEFINE_CONNECTION_PROPERTIES_ADD card:

*setvalue materialbehaviors id=1 STATUS=1 PRUL=1
*setvalue materialbehaviors id=1 STATUS=1 Number_of_Materials=2

To query the fields on a *DEFINE_CONNECTION_PROPERTIES card or a *DEFINE_CONNECTION_PROPERTIES_ADD card:

hm_getvalue materialbehaviors id=1 dataname=PRUL
hm_getvalue materialbehaviors id=1 dataname=Number_of_Materials

• Airbag Folding
  • *createinflatorinsertfold
• Connectors
  • *CE_RerunPost
  • *CE_SeamConnectorFromWeldLine
• Data Names
  • elementbehaviors
  • internalsupports
  • scenarios
  • smartrules
• General/Core
  • hm_detectselfsymmetry
  • hm_gettotalcog
  • hm_gettotalmass
  • hm_gettotalmoi
  • hm_nodeismidnode
  • *applyscenario
  • *metadatamarkbool
  • *removeincludes
  • *writeengineeringandcontroldata
• Geometry
  • *createsketchfrombeamsection
• HMASCII
  • *elementbehaviors()
  • *internalsupports()
  • *scenarios()
  • *smartrules()
• Meshing
  • *beamsectioncreatefromentities
  • *beamsectioncreatefromsectioncut
  • *createbead
  • *imprint_pointchain
  • *solidmap_equivalence2
• Post-processing
  • hm_getactiveplotcontrolmaxvalue
  • hm_getactiveplotcontrolminvalue
  • hm_getdatatypeaveraginglist
  • hm_getdatatyperesolvedinlist
  • hm_plotcontrol_update_begin
  • hm_plotcontrol_update_end
• Subsystems
  • *modent_reparentbymark
• Template Commands
  • *elementbehaviors()
  • *internalsupports()
  • *scenarios()
  • *smartrules()
• Template Functions
  • @checkentitynameexists()
  • @loadsinloadcollector()

The following commands have modified behavior that potentially require script updates:

• Subsystems
  • *modent_addcontentsbyids – Only one includefile entity can be associated with a subsystem.
  • *modent_addrepresentations – Added new value HyperMesh for representation_file_format.
  • *modent_removecontentsbyids– Removing an includefile entity is not allowed when modular_entity_type is subsystem.
  • *modent_saverepresentation – Subsystem representations are saved in a HyperMesh database.

The following commands have new options or enhanced capabilities. Existing scripts are not affected and only need to be updated if usage of the new functionality is desired:

• Data Names
  • analysis - Added new loadtype values 114 and 115.
  • analysisparameters - Added new data names disp, disp_select, dof, dof_select, grid and grid_select.
  • beamsects - Added new data names center, computeproperties, partscount, partmanagertable, partmaterial, partname, and partsize.
  • components - Added new data name explosion.
  • includefiles - Added new data name is_managed.
  • loads
    • accelerations - Added new data names for Abaqus engineering loads: boundary_region, cyclic_mode, dload_type, matrix_generation, ref_node, ref_set, and rot_axis_pos.
    • constraints - Added new data names for Abaqus engineering loads: boundary_region, firstdof, lastdof, load_case, and variable_type.
    • fluxes - Added new data names for Abaqus engineering loads: boundary_region, firstdof, load_case, and variable_type.
    • forces - Added new data names for Abaqus engineering loads: boundary_region, cyclic_mode, load_case, and matrix_generation.
    • moments - Added data name for Abaqus engineering loads: boundary_region, cyclic_mode, dload_type, load_case, matrix_generation, and rot_axis_pos.
    • pressures - Added new data names for Abaqus engineering loads: boundary_region, cyclic_mode, dload_type, dsload_type, matrix_generation, pipe_diameter, ref_node, and ref_set.
    • temperatures - Added new data name for Abaqus engineering loads: boundary_region, firstdof, lastdof, load_case, and variable_type.
  • materialbehaviors - Added new data names ADD_option, AREAEQ, CON_ID, DDGPR, DDGPR_Funct, DETAN, DETAN_Funct, DEXSB, DEXSB_Funct, DEXSN, DEXSN_Funct, DEXSS, DEXSS_Funct, DGFAD, DGFAD_Funct, DGPR, DGTYP, DLCSB, DLCSN, DLCSS, DRANK, DSB, DSB_Funct, DSCLMRR, DSIGY, DSIGY_Curve, DSIGY_Funct, DSN, DSN_Funct, DSS, DSS_Funct, ETAN, EXSB, EXSN, EXSS, GFAD, LCSB, LCSN, LCSS, MID_array, MOARFL, Number_of_Materials, OPT_DSIGY_curve, OPT_SIGY_curve, PRUL, RANK, SB, SCLMRR, SIGY, SIGY_Curve, SN, and SS. Added a new config value 111.
  • retractors - Added new data names EL_ID, Elem_size, Fct_ID1, Fct_ID2, Fct_ID3, Force, Node_ID, Pullout, Sens_ID1, Sens_ID2, Tens_typ, Xscale1, Xscale2, Yscale1, Yscale2. Added new config value 201.
  • seatbelts - Added new data names resolve_intersections, seg_intersection_resolve, and seg_intersection_elems.
  • sliprings - Added new data names A, Ed_factor, EL_ID1, EL_ID2, EL_SET1, EL_SET2, Fct_ID1, Fct_ID2, Fct_ID3, Fct_ID4, Flow_flag, Fricd, Frics, Node_ID, Node_ID2, Node_SET, Sens_ID, Xscale1, Xscale2, Xscale3, Xscale4, Yscale2, Yscale4. Added new config values 201, 202.
  • subsystems - Added new data names maxid and minid.
  • tables - Added new data name dtablevalue.
• General/Core
  • *absorbentities - Added support for properties.
  • *absorbloads - Added groups as a possible value for entity_type.
  • *elementchecksettings - Value 3 (LS-DYNA) is now supported for solver, aspect_2d, aspect_3d, angle, cell_squish_2d, chord_dev, skew_2d, skew_3d, skew_3d, taper, tetra_collapse, time_step, and warpage.
  • *realizefieldloads - Added support for groups.
  • *realizehmentity - Added support for solvermasses.
  • *setoption/hm_getoption - Added new options auto_bs_thickness, br_autofit_graphics, br_autoscroll, br_autosort, br_filter_mode, br_filter_nested, br_partbrowser_show_components, br_show_entities_all, br_show_treelines, bs_thickness, cadupdate_inspire_installation, elem_sphere_radius, intell_exact_match, intell_max_id, intell_max_name, left_justify_num_fields, sketcher_shade_closed_regions, and sketcher_update_in_inspire.
• Geometry
  • *autotopocleanuplimited - Added new optional argument adj_surfs_layers.
• Meshing
  • *midmesh_extract - Added new options MidlineTrimFilletsFactor and SuppressProximityFilletsFactor.
  • *update1delements - Added new sectiontype value solid and new options createsketch and mergetol.

The following commands are deprecated in HyperWorks but continue to be supported in HyperWorks Desktop:

• *setgraphictranslation - Use *setvalue to set the explosion data name on a component entity.