2022.3 API Programmer's Guide

To create a *CONSTRAINED_JOINT_STIFFNESS_FLEXION-TORSION keyword:

*createentity constraints config=102 Type=1

To create a *CONSTRAINED_JOINT_STIFFNESS_GENERALIZED keyword:

*createentity constraints config=102 Type=2

To create a *CONSTRAINED_JOINT_STIFFNESS_TRANSLATIONAL keyword:

*createentity constraints config=102 Type=3

To create a *CONSTRAINED_JOINT_STIFFNESS_CYLINDRICAL keyword:

*createentity constraints config=102 Type=4

To set value to ‘ESAL’ field on *CONSTRAINED_JOINT_STIFFNESS_FLEXION-TORSION, ‘EST’ on *CONSTRAINED_JOINT_STIFFNESS_GENERALIZED, ‘ESX’ on *CONSTRAINED_JOINT_STIFFNESS_TRANSLATIONAL, ‘ESR’ on *CONSTRAINED_JOINT_STIFFNESS_CYLINDRICAL cards:

*setvalue constraints id=1 STATUS=1 ESAL=1.1
*setvalue constraints id=1 STATUS=1 EST=2.2
*setvalue constraints id=1 STATUS=1 ESX=3.3
*setvalue constraints id=1 STATUS=1 ESR=4.4

To query a field on *CONSTRAINED_JOINT_STIFFNESS_FLEXION-TORSION, *CONSTRAINED_JOINT_STIFFNESS_GENERALIZED, *CONSTRAINED_JOINT_STIFFNESS_TRANSLATIONAL, *CONSTRAINED_JOINT_STIFFNESS_CYLINDRICAL cards:

hm_getvalue constraints id=1 dataname=ESAL
hm_getvalue constraints id=1 dataname=EST
hm_getvalue constraints id=1 dataname=ESX
hm_getvalue constraints id=1 dataname=ESR

• Connectors
  • *CE_AutoCreateMatingConnectors
  • *CE_CreateXMCFData
  • *CE_InputSigPoints
  • *CE_RemoveSigPoints
• Data Names
  • charts
• General/Core
  • *nodemarkclear
  • *replacenodes_multiple
• Geometry
  • *createnodesbetweenpositions
  • *geom_simplify
  • *pointcreateatnodemark
  • *solid_rotate
• HMASCII
  • *charts()
• Meshing
  • *align_entities
• Morphing
  • *morphhandleprojectentityoffset
  • *morphhandleprojectlineoffset
  • *morphhandleprojectplaneoffset
• Multiple Models
  • hm_getallmodelsinsession
• Skeleton
  • *createexoskeletonlattice
• Template Commands
  • *charts()

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

• *element_smooth_nodes - Added new option anchornodes.
• *elementqualitysplitelem - Updated the syntax to support name-value argument pairs and added new option swap.
• *splitelementbyelemselect - Updated the syntax to support name-value argument pairs and added new option consider1ds.

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:

• Connectors
  • hm_ce_getallfe - The returned list now contains the post created entities such as materials, properties, contacts, and so on.
• Data Names
  • constraints - Added new data names CIDA, CIDB, DLCIDAL, DLCIDBT, DLCIDG, DLCIDP, DLCIDPH, DLCIDPS, DLCIDR, DLCIDT, DLCIDX, DLCIDY, DLCIDZ, ESAL, ESBT, ESPH, ESPS, ESR, EST, ESX, ESY, ESZ, FFR, FFR_CURVE, FFR_CURVE_OPT, FFX, FFX_CURVE, FFX_CURVE_OPT, FFY, FFY_CURVE, FFY_CURVE_OPT, FFZ, FFZ_CURVE, FFZ_CURVE_OPT, FMAL, FMAL_CURVE, FMAL_CURVE_OPT, FMBT, FMBT_CURVE, FMBT_CURVE_OPT, FMPH, FMPH_CURVE, FMPH_CURVE_OPT, FMPS, FMPS_CURVE, FMPS_CURVE_OPT, FMT, FMT_CURVE, FMT_CURVE_OPT, JID, LCIDAL, LCIDBT, LCIDG, LCIDPH, LCIDPS, LCIDR, LCIDT, LCIDX, LCIDY, LCIDZ, NSABT, NSAPH, NSAPS, NSAT, NSDX, NSDY, NSDZ, PIDA, PIDB, PSABT, PSAPH, PSAPS, PSAT, PSDR, PSDX, PSDY, PSDZ, RAD1, RAD2, SAAL, and Type. Added new config value 102.
  • designvars
    • gauge - Added new data names designvar_ddval_opt, designvar_initialvalue_opt, designvar_lowerbound_opt, designvar_lowerbound_percent, designvar_movelimit_opt, designvar_upperbound_opt, and designvar_upperbound_percent.
  • failures- Added new config values 235, 236 and 237. Added following new data names comp_dir, denom, dtmin, eps_dot_fld, eps_dot_ps, eps_dot_sm, eps_eff, eps_max, eps_min, eps_vol, epscal, fct_IDe1c, fct_IDg12, fct_IDg13, fct_IDps, fct_IDsm, Fct_Ratio, idel, inst, ismooth, itab, max_comp_strain, n_hard, ncs, nstep, num, ordin, pmax, pmin, pthickfail, shear, sig_max, sigp1_max, sigr, strain_ratio, tab_IDfld, temp_max, thinning, time_max, vol_strain, and volfrac.
  • lines - Added new data names endcoords, endtangentangle, endtangentvector, geometrytype, length, startcoords, starttangentangle, starttangentvector, and topologytype.
  • loads
    • fluxes - Added new data names for OptiStruct engineering loads: Chbdye_start_id, ctrlnd, pconvid, Qbdy1_option, and Ta1.
    • pressures - Added new data names Radioss engineering loads: pblast_rad_iform, pblast_rad_pmin, rad_ground_Id, and rad_pblast_node.
  • plotcontrols - Added new config value 6 and new data names marker_displayColor, numeric_format, numeric_precision show_entityid, and show_value_multiline.
  • points - Added new data names geometrytype and topologytype.
  • solids - Added new data names geometrytype, mappability, topologytype, and volume.
  • surfaces - Added new data names area, geometrytype, and topologytype.
• General/Core
  • hm_getcog - Added new optional arguments lumpedmassflag and system_id.
  • hm_getmoi - Added new location_flag value 3 and added lumpedmassflag.
  • *copymark– Added new optional arguments disable_fe_geom_duplicate and copy_elems_with_surf.
  • *elementtype - Added support for string labels as input arguments.
  • *feinputmerge - Added new options mergemode.sensors and mergemode.sections.
  • *findmark - Added new function Bit9 value and new option recursive.
  • *loadtype - Added support for string labels as input arguments.
  • *mergefile2 - Added new options mergemode.sensors and mergemode.sections.
  • *rundesignmethod - Added new option tableperloadcase.
  • *setoption/hm_getoption- Removed option domain_handle. Added new options delete_preserve_nodes, fe_geom_dupl, morph_1d_domain_method, morph_2d_domain_color, morph_3d_domain_color, morph_autofix_squashed_domains, morph_biasing_style, morph_check_neg_jacobians, morph_cluster_mode, morph_cluster_rotation, morph_cluster_stretch, morph_constraint_size, morph_constraint_size_mode, morph_edge_domain_color, morph_element_midnodes, morph_faces_color, morph_global_influence_method, morph_global_influence_solver, morph_handle_size, morph_handle_tolerance, morph_kriging_covariance, morph_kriging_drift, morph_kriging_finish, morph_kriging_global_domains, morph_kriging_local_domains, morph_kriging_mode, morph_kriging_morphvolumes, morph_kriging_nugget_option, morph_kriging_nugget_value, morph_kriging_resume, morph_kriging_start, morph_large_domain_mode, morph_large_domain_size, morph_large_domain_solve, morph_large_domain_unfold, morph_min_handle_influence, morph_min_step_size_angle, morph_min_step_size_dist, morph_morphing_system, morph_morphvolumes_color, morph_morphvolumes_connector_mode, morph_morphvolumes_connector_realize, morph_morphvolumes_edge_continuity_adjust, morph_morphvolumes_edge_continuity_morph, morph_morphvolumes_edge_method, morph_morphvolumes_edge_points, morph_morphvolumes_mode, morph_morphvolumes_skin_only, morph_morphvolumes_tolerance, morph_morphvolumes_transparency, morph_multithread, morph_other_domain_color, morph_partitioning_add_geometry, morph_partitioning_curve_tolerance, morph_partitioning_domain_angle, morph_partitioning_inside_3d, morph_partitioning_method_quads, morph_partitioning_method_trias, morph_partitioning_order, morph_partitioning_use_geometry, morph_quality_color_plotting, morph_quality_limit, morph_quality_mode, morph_remeshing_edge_mode, morph_remeshing_element_size, morph_remeshing_interval, morph_remeshing_mesh_type, morph_remeshing_mode, morph_remeshing_preserved_shapes, morph_remeshing_qa_fail_pct, morph_remeshing_remesh, morph_remeshing_remesh_3D, morph_remeshing_size_control, morph_remeshing_size_mode, morph_remeshing_skew_control, morph_remeshing_style, morph_remeshing_zone, morph_results_component, morph_results_datatype, morph_results_datatype_values, morph_results_info_titles, morph_results_max_option, morph_results_max_value, morph_results_mesh_color, morph_results_min_max_titles, morph_results_min_option, morph_results_min_value, morph_results_mode, morph_results_plot, morph_results_plot_style, morph_results_refresh, morph_results_simulation, morph_results_simulation_values, morph_results_solve, morph_results_solver_type, morph_results_stamping_direction_x, morph_results_stamping_direction_y, morph_results_stamping_direction_z, morph_save_morphs, morph_show_domain_icons, morph_small_domain_mode, morph_small_domain_properties, morph_small_domain_size, morph_small_domain_solve, morph_small_domain_solver, morph_smoothing_iterations, morph_smoothing_mode, morph_smoothing_type, morph_symmetry_color, morph_symmetry_size, morph_use_constraints, morph_use_symmetry_links, pdm_check_latest_partrev, pdm_check_latest_partrev_interval, rdata_memory_clean, rq_numeric_format, rq_print_header, sketcher_show_construction_of_arcs, and sketcher_show_variables_in_dims.
• Meshing
  • *beamsectioncreatefromentities - Added new option vertexangle.
  • *beamsectioncreatefromsectioncut - Added new option vertexangle.
  • *update1delements - Added new option vertexangle.
• Postprocessing
  • hm_getactiveplotcontrolid - Added support for new plot_type marker.
  • hm_getactiveplotcontrolvalues - Added support for new plot_type marker.

• General/Core
  • hm_ce_getediabsorbedmassgrplist
  • hm_getincludeentities
  • *systemconvertnodetoaxis – Use *setvalue to set the definitioncode data name on a system entity.

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

• Post-processing
  • *animatelinear
  • *animatemodal
  • *animatetransient