Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
HyperMesh
Scripts
This section contains details on general HyperWorks scripting concepts, along with documentation on the Tcl commands that can be used to query and modify the database and GUI.
Commands and Functions
Tcl Query Commands
Commands that query the HyperMesh database.
hm_getreferencedentities
Finds entities that are referenced by the specified entity.
Supported Entities
Supported entities for hm_getreferencedentities.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- External Readers and Altair Binary Format
  Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
- Generic ASCII Reader
  A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
- Batch Mode
  Batch mode allows you perform a series of operations outside the program interface.
- External Resources
  External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
- Translators
  Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
- Result Math
  XML commands in the Result Math Module.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
  - API Programmer's Guides
    These provide an overview of all additions, updates, and changes to the HyperMesh APIs for each release.
  - Data Names
    Details on the core data that can be queried and manipulated.
  - Ext API
    This API allows external applications to link HyperMesh as a library and provides a limited set of functions and structures to access specific functionality.
  - FE Input Readers
    FE input readers are C programs that read information from ASCII or binary finite element models files into the HyperMesh database.
  - HMASCII
    Details on the HMASCII format and associated commands.
  - Scripts
    This section contains details on general HyperWorks scripting concepts, along with documentation on the Tcl commands that can be used to query and modify the database and GUI.
    - Introduction
    - Create Scripts
      The functionality of the HyperMesh Tcl Modify Command commands are available through Tcl. Additionally, commands that allow you to extract information from the HyperWorks database, such as entity ID numbers on a mark, a list of assemblies, component names, elements per component, nodes per element, node values, and so forth. These are known as HyperMesh Tcl Query Command commands. They are used to query information from the database or template system.
    - Run Scripts
      Tcl/Tk scripts can be run in several ways.
    - Commands and Functions
      - Tcl GUI Commands
        Commands that operate on the HyperMesh GUI widgets.
      - Tcl Modify Commands
        Commands that modify the HyperMesh database.
      - Tcl Query Commands
        Commands that query the HyperMesh database.
        hf_getautotippingangles
        Return the auto-tipping angle along Z axis for selected mesh.
        hf_getdrawbeadforce
        Calculates and returns the draw bead forces.
        hm_addchildrenoflistsinmark
        Add children entities of lists in a mark.
        hm_ae_findattachmentsfromFEs
        Returns resolved link entity information.
        hm_ae_get_partson
        Returns the part IDs for given attachments.
        hm_ae_getfe
        Returns the elements from the realized attachment.
        hm_ae_state
        Return the current state of an attachment.
        hm_allentitiesinfo
        Get information about all entities of the given type in the current model. A single call returns a list where every HyperMesh entity of the specified type (currently only assemblies, components, materials, and properties are supported) is represented with a single list item. Each list item is identical to the return value of the command, hm_entityinfo all for that entity.
        hm_answernext
        Provides an answer to the next command for Tcl scripts.
        hm_appendmark
        Appends entities on a mark based on user supplied options.
        hm_assemlist
        Returns the hierarchical structure of assemblies, and optionally standalone components, along with properties, materials, groups and beamsection collectors.
        hm_attributeentitytype
        Returns the entity type number of an entity attribute on an entity for the current template.
        hm_attributeidentifier
        Returns the identifier flag of an attribute on an entity for the current template.
        hm_attributeidfromname
        Returns an attribute ID from the attribute name for the current template.
        hm_attributeindexentitytype
        Returns the entity type number of an indexed entity attribute on an entity.
        hm_attributeindexentitytypename
        Returns the entity type string of an indexed entity attribute on an entity.
        hm_attributeindexidentifier
        Returns the identifier flag of an indexed attribute on an entity.
        hm_attributeindexsolver
        Returns the solver number of an indexed attribute on an entity.
        hm_attributeindexstatus
        Returns the status flag of an indexed attribute on an entity.
        hm_attributeindextype
        Returns the attribute type number of an indexed attribute on an entity.
        hm_attributeindextypename
        Returns the attribute type string of an indexed attribute on an entity.
        hm_attributelist
        Returns a list of all attribute IDs or names assigned to a specific entity for the current template.
        hm_attributelistall
        Returns a list of all attribute IDs, names, types or type names for the current template.
        hm_attributenamefromid
        Returns an attribute name from the attribute ID for the current template.
        hm_attributereferencecount
        Returns the number of times an entity is referenced as an entity attribute.
        hm_attributesolverarrayvalues
        Returns the solver code and all values for a 1D array attribute on an entity.
        hm_attributetype
        Returns the attribute type number of an attribute for the current template.
        hm_attributetypename
        Returns the attribute type string of an attribute for the current template.
        hm_bag_getconfigfromgenericname
        Returns the bag configuration for the specified generic name.
        hm_bag_getentitytypes
        Returns the types of entities inside a bag.
        hm_bag_getgenericnamefromconfig
        Returns the generic bag name for the specified configuration.
        hm_bag_getsupportedconfiglist
        Returns a list of supported bag configurations.
        hm_baglist_byconfig
        Get a list of bag names or IDs of the specified bag configuration.
        hm_batchexportenginefile
        Exports Radioss Engine and Starter files.
        hm_blockbrowserupdate
        Controls the update of the browsers.
        hm_cardassignedtoentity
        Indicates if a card can be assigned to the entities on the mark for the current template.
        hm_ce_alldetailsget
        Returns all custom details assigned to a connector.
        hm_ce_cfglistget
        Returns info on FE configurations for a specified solver, connector style and FE config file.
        hm_ce_checklinkentities
        Returns the names or IDs of entities added to the connector that currently do not exist in the database.
        hm_ce_checkprojection
        Check if the connectors make projection. Returns the failed connector IDs.
        hm_ce_close_mcf
        Ends the process of reading a main connector file, triggered by hm_ce_read_mcf.
        hm_ce_datalist
        Returns, in a list, all connector data displayed in the table for a single connector on mark and as a list of lists for multiple connectors.
        hm_ce_detailget
        Returns certain details about a connector.
        hm_ce_errorreport
        Returns the specific reason for the failed realization of a connector.
        hm_ce_fe_config
        Gets the weld config defined for the connector.
        hm_ce_fedata
        Returns the weld config or the tolerance set to realize a connector.
        hm_ce_findduplicates
        Returns a list of connectors that are considered to be duplicates of other connectors, within a given tolerance.
        hm_ce_generatenamefrominclude
        Returns a name using a base name and connector include ID.
        hm_ce_generatenamefromsubsystem
        Returns a name using a base name and connector subsystem ID.
        hm_ce_getallfe
        Returns specific FE and post created entity type(s) and ID(s) from a realized connector.
        hm_ce_getconfigfromconnectorcontrol
        Gets the FE config name from a connector control or connector control default.
        hm_ce_getconnectorcontrol
        Returns connector control or connector control default information from a connector.
        hm_ce_getconnectorcontrollist
        Returns a list of connector controls or connector control defaults.
        hm_ce_getcords
        Returns the location of the connector.
        hm_ce_getdefaultconnectorcontrolfromconfig
        Returns the connector control default name and ID for an FE config.
        hm_ce_getfe
        Returns specific weld ID(s) from a realized connector.
        hm_ce_getfeprojfeatureelems
        Returns the independent or dependent layer of feature elements.
        hm_ce_getfeprojtrip
        Returns the connector projection data for a specific layer.
        hm_ce_getfeprojweldnodes
        Returns the independent or dependent layer of nodes belonging to weld elements.
        hm_ce_getfilteredconfignames
        Get filtered config list for given connector style and type.
        hm_ce_getglobalsharedentitysettings
        Gets the global shared entity management settings.
        hm_ce_gethmholes
        Get bolt holes information from components.
        hm_ce_getlinkentities
        Returns specific type of entities IDs that are added to a connector.
        hm_ce_getlinkentityinfo
        Returns specific entity information for a connector.
        hm_ce_getlinkinfo
        Returns link info for a connector including entity type, IDs/names, locator rule and XYZs.
        hm_ce_getnumoffeprojinfo
        Returns the number of projection data stored in the array (size of array).
        hm_ce_getprojcompid
        Returns the component ID for the projection data layer of interest.
        hm_ce_getprojectiondata
        Returns newly created component projection information for a given set of connectors, points, or nodes.
        hm_ce_getprojfe
        Returns the weld data list (types and IDs) for the given projection array index and weld array index.
        hm_ce_getprojfesize
        Returns the number of welds created in a layer. This includes weld and rigids.
        hm_ce_getprojnodeid
        Returns the node ID for the projection data layer of interest.
        hm_ce_getrealizedtestpoints
        Gets the realized test points from the connector.
        hm_ce_getresolvedlinkentities
        Returns resolved link entity information.
        hm_ce_getsolverprojectionbymark
        Returns the solver projection data.
        hm_ce_gettestpoints
        Gets the test point(s) from the connector.
        hm_ce_getthickness
        Gets the total number of layers to be connected.
        hm_ce_getunsyncdata
        Returns data which are not synchronized from the connectorcontrol assigned to a connector.
        hm_ce_getvalidabsolutepath
        Returns a valid absolute path from a relative path.
        hm_ce_globalget
        Get global variables related to connector display.
        hm_ce_imprintelemsget
        Returns imprinted elements for a connector.
        hm_ce_info
        Returns the requested information from a specified connector entity.
        hm_ce_linkprojectionorderget
        Returns ordered projection information from links of spot connectors.
        hm_ce_mesh_imprint_option_get
        Returns a mesh imprint option value.
        hm_ce_mesh_imprint_option_set
        Sets a mesh imprint option value.
        hm_ce_numlinkentities
        Returns the number of link entities for the connector.
        hm_ce_organize
        Organizes displayed connectors into components by their definition.
        hm_ce_projecthexaface
        Controls the creation of hexa elements for the ACM realization.
        hm_ce_read_mcf
        Begins the process of reading a main connector file.
        hm_ce_setfeorientaxis
        Set the axis aligned with the welds for the coordinates systems created during realization process.
        hm_ce_state
        Returns the current connector state (unrealized, realized or failed).
        hm_ce_tooclosetoedgecheck
        Checks if connectors are too close to an edge.
        hm_ce_type
        Returns the type of a connector entity.
        hm_ce_xmlstringget
        Returns connector information in XML format.
        hm_checkmark
        Determines if the specified entity exists on the specified mark
        hm_checkproximity
        Checks proximity between elements/components.
        hm_collisioncheck
        Performs a collision detection.
        hm_collisionend
        Clear memory and end the collision detection module.
        hm_collisionentitycreate
        Adds entities to consider for collision detection.
        hm_collisiongetcomponententitypair
        Returns the entity details for an entity collision pair.
        hm_collisiongetcomponententitypaircount
        Returns the number of entity pairs for a component collision pair.
        hm_collisiongetcomponentlinesegment
        Returns the start and end coordinates of intersection line segments.
        hm_collisiongetcomponentlinesegmentcount
        Returns the number of line segment for the component collision pair.
        hm_collisiongetcomponentpair
        Returns the component IDs of a collision pair.
        hm_collisiongetcomponentpaircount
        Returns the number of component collision pairs.
        hm_collisiongetconfig
        Returns flags to be used for configuration of the collision detection.
        hm_collisioninit
        Initializes the collision detection module.
        hm_collisionvisualizebymark
        Enables the visualization of collision entities using one of various supported visualization modes.
        hm_collisionwriteresultsfile
        Writes the current collision results to a file.
        hm_compareend
        Clear memory and end the comparison module.
        hm_compareentities
        Generates comparison results for entities positioned at any location.
        hm_compareentitiesposition
        Generates comparison results for entities positioned at a specific location.
        hm_compareentitiesrecursive
        Generates recursive comparison results for entities positioned at any location.
        hm_compareentitiesrotate
        Generates comparison results for entities rotated about a vector.
        hm_compareentitiessameside
        Generates comparison results for entities positioned at the same location. This must be preceded by a call to hm_compareinit.
        hm_compareentitiessymmetry
        Generates comparison results for entities positioned symmetrically about a plane.
        hm_compareentitiestranslate
        Generates comparison results for entities translated along a vector.
        hm_comparefinddistances
        Calculates the distance between all source and target entities.
        hm_comparegetarea
        Calculates the area values for all source and target entities.
        hm_comparegetcomparea
        Returns the comparison area of a specific component.
        hm_comparegetdistance
        Returns the distance value for a specific distance index.
        hm_comparegetdistancecount
        Returns the number of distances found.
        hm_comparegetdistanceentityid
        Returns the entity ID for a specific distance index.
        hm_comparegetdistanceentitytype
        Returns the entity type for a specific distance index.
        hm_comparegetdistancetransformid
        Returns the transformation index for a specific distance index.
        hm_comparegettransformationcount
        Returns the number of transformations found.
        hm_comparegettransformationmatchcount
        Returns the number of matches for a specific transformation.
        hm_comparegettransformationmatchentities
        Returns the entity IDs associated with a specific transformation and match.
        hm_comparegettransformationmatchentitycount
        Returns the number of entities associated with a specific transformation and match.
        hm_comparegettransformationmatchentitytype
        Returns the type of entities associated with a specific transformation and match.
        hm_comparegettransformationmatchstate
        Returns the state of a specific transformation and match.
        hm_comparegettransformationmatchtype
        Returns the type of a specific transformation and match.
        hm_comparegettransformationmatrix
        Returns the 4x4 transformation matrix for a specific transformation.
        hm_compareinit
        Initializes the comparison module.
        hm_comparereadfile
        Reads comparison data from a file into the comparison database.
        hm_comparereturnresults
        hm_comparesetanalysismode
        Specifies the analysis mode for element-to-surface comparisons.
        hm_comparesetelemsurfmode
        Specifies whether to consider element centroids for element-to-surface comparisons.
        hm_comparesetflags
        If enabled, the comparison module will cache extra pairwise data while performing comparisons between source and target.
        hm_comparesetignoreholes
        Specifies whether to ignore holes and/or slots for 3D shell comparisons.
        hm_comparesetrefacetmode
        Regenerates facets on source and target surfaces for comparison purposes.
        hm_comparesetreview
        Sets the graphical review type for comparison results.
        hm_comparesetreviewcolor
        Sets the graphical review color for comparison results.
        hm_comparesetreviewcolordefault
        Sets the graphical review color for comparison results back to the defaults.
        hm_comparesetreviewmode
        Sets the graphical review mode for comparison results.
        hm_comparesetreviewtypes
        Sets the graphical review types to show for comparison results.
        hm_comparesettransparentmode
        Sets the graphical transparency mode for non-reviewed entities.
        hm_comparewritefile
        Writes the current comparison data to a file.
        hm_comparewritepairedcomps
        Writes a list of pairs of source and target components to an output file.
        hm_comparewriteresults
        Writes the current comparison results to a file.
        hm_controlcardattributedefined
        Returns 1 if an attribute exists, 0 otherwise.
        hm_convertFromOutFileToDatFile
        Generates a DAT file from an OUT file.
        hm_convertmarktorange
        Converts a mark to an ID range and returns the ID range list with comma separators.
        hm_count
        Counts the entities in the database.
        hm_createmark
        Places entities on a mark based on user-supplied options.
        hm_defaultstatus
        Returns the default status of an attribute.
        hm_defined
        Queries whether an attribute or metadata is defined on an entity.
        hm_detectmeshpatterns
        Evaluates mesh patterns and connectivity on an input quad/mixed mesh, and output problem elements onto a mark.
        hm_detectselfsymmetry
        Finds and returns a point on the plane of symmetry and the normal of the plane.
        hm_diffencodings
        Calculates the distance between two lists of encoded strings representing shapes of geometries.
        hm_elemlist
        Get a list of element IDs or types for the passed component.
        hm_encodeshape
        Generate an encoded string representing the shape of a geometry.
        hm_entitiesassociatedbygroupsmark
        Selects entities associated through groups.
        hm_entity_setvector
        Set the vector ID for the weld element.
        hm_entitycanselectby
        Returns true if the passed entity type can be selected using the specified advanced method.
        hm_entitygettype
        Returns the user-assigned entity type. The user-assigned entity type is set in the template.
        hm_entityincollector
        Returns the number of entities in a collector.
        hm_entityinfo
        Returns various information on entities.
        hm_entityisdirty
        Returns dirtiness status of an entity.
        hm_entitylist
        Returns a list of names or IDs of all entities of the requested type.
        hm_entitymaxid
        Returns the maximum internal ID in use for an entity type.
        hm_entitymaxsolverid
        Returns the maximum solver ID in use for an entity type.
        hm_entityminid
        Returns the minimum internal ID in use for an entity type.
        hm_entityminsolverid
        Returns the minimum solver ID in use for an entity type.
        hm_entityrecorder
        Records the IDs of the entities created while the recorder is enabled.
        hm_estimategeomthicknesslimits
        Returns the minimum and maximum thickness limits for thin solid geometry.
        hm_evaluatepythonexpression
        Evaluates a Python expression.
        hm_excludebeyond
        Removes entities from the base mark which are beyond the given distance or number of element rows from the entities on the target mark.
        hm_export
        Exports data name values for entity hierarchy.
        hm_exportdummytargetpointstocsv
        Exports the marked design points with ‘TargetPoint’ configuration to a CSV file.
        hm_exportentitydefaults
        Exports the entity default setting values to an XML file in the current working directory.
        hm_exportidmgr
        Exports the ID manager rules to a CSV or XML file.
        hm_exportoptimizationcards
        Exports a Radioss optimization file.
        hm_exportplyorientation
        Writes the fiber orientation vector for each element in a ply to a text file.
        hm_fe_getconfigfile
        Returns the FE config file set for user-defined weld creation.
        hm_fe_getdiameter
        Returns the diameter value set for weld or property creation.
        hm_fe_getdvstfile
        Returns the dvst file set for weld or property creation.
        hm_fe_getWvsTfile
        Returns the width versus thickness (wvst) file for weld or property creation on connector.
        hm_fe_setconfigfile
        Set the FE configuration file for user-defined welds.
        hm_fe_setdvstfile
        Set the diameter versus thickness file for user-defined welds on connector.
        hm_fe_setWvsTfile
        Sets the width versus thickness file for seam welds.
        hm_findadvancedselectiongroups
        Finds advanced selection entities and separates them into selection method specific groups.
        hm_findcirclefromthreepoints
        Find the center and the radius of a circle that lies on three 2D points.
        hm_findclosestpointonline
        For a given point on a line, returns the closest other point on that same line.
        hm_findclosestpointonsurface
        For a given point on a surface, returns the closest other point on that same surface.
        hm_findconnectedpatches
        Returns patches of connected elements.
        hm_finddeviation
        Finds the deviation between two CAD geometries and returns a list of component pairs along with the deviation data.
        hm_findnarrowsurfaces
        Returns the list of narrow surfaces, including large surfaces with narrow tails or local narrow neck regions.
        hm_findpolygonselection
        Finds a polygonal path that connects all given input elements. This path takes into consideration the local mesh flow when defining a polygon.
        hm_findprojected
        Finds nodes which lie on or within shells or solid faces, or which can be projected on to those shells or solid faces along a vector or element normal.
        hm_findtangentpointoncircle
        From a point, find the corresponding two tangent points on a circle.
        hm_findthinsolidproximity
        Finds and returns the proximate solid pairs for a given set of selected solids.
        hm_flangedetectionend
        Clear memory and ends the flange detection module.
        hm_flangedetectionfindflanges
        Executes the flange detection tools.
        hm_flangedetectionfindmates
        Executes the flange mating tools.
        hm_flangedetectiongetflangedetails
        Returns details about a specific flange.
        hm_flangedetectiongetflangemates
        Returns indices of flanges that directly mate with the specified flange.
        hm_flangedetectiongetflangemidline
        Returns offset boundary points for a given flange.
        hm_flangedetectiongetmatingentities
        Returns the entities for two mating flanges.
        hm_flangedetectiongetmatinggroupdetails
        Returns the members of a mating group.
        hm_flangedetectiongetnumberofflanges
        Returns the number of found flanges.
        hm_flangedetectiongetnumberofmatinggroups
        Returns the number of found flange mating 'groups'.
        hm_flangedetectioninit
        Initializes the flange detection module.
        hm_flangedetectionsetparams
        Defines parameters for finding flanges in both geometry and FE.
        hm_formnodelistsfrommark
        Forms ordered node lists from a mark of nodes.
        hm_geomfindsymmetry
        Finds and returns the symmetry transformation matrix and matched / unmatched surfaces between two selections.
        hm_getabsoluterotationvector
        Returns a list {x y z} which describes the given entity’s absolute rotation. If HyperMesh is unable to locate the associated systems, the list will contain three empty members.
        hm_getactiveplotcontrolid
        Returns the active plot control ID for a particular result plot type.
        hm_getactiveplotcontrolmaxvalue
        Returns the maximum value for the active plot control together with the entity ID.
        hm_getactiveplotcontrolminvalue
        Returns the minimum value for the active plot control together with the entity ID.
        hm_getactiveplotcontrolvalues
        Queries the result values on entities for the active plot control.
        hm_getactivesimstep
        Returns the active subcase ID and simulation step ID.
        hm_getaddendumid
        Returns the IDs of the addendum surfaces.
        hm_getadjfacesfromface
        Returns the faces adjacent to the specified face.
        hm_getadjsurfacesfromsurface
        Returns the surfaces adjacent to the specified surface.
        hm_getadvancedselectiontypes
        Returns a list of valid advanced selection strings for the specified entity type and mode.
        hm_getallmodels
        Returns the names of the primary and all the secondary models.
        hm_getallmodelsinsession
        Returns the names of the models in a current session.
        hm_getalltiedentities
        Identifies groups of connected components and free parts within selected components.
        hm_getangle
        Returns the angle between three nodes/points.
        hm_getareaofsurface
        Returns the area of a surface.
        hm_getattachedsolidelemfaces
        Returns information about solid elements attached to shell element faces.
        hm_getaverageelemsize
        Returns the average element size for shell elements.
        hm_getaxisymmetricvolumereduced
        Calculates the reduced volume of axisymmetric solids.
        hm_getbatchparams
        Query the values of global mesh parameters.
        hm_getbestcirclecenter
        Returns the center and radius of the best fit circle from the input nodes, points or lines.
        hm_getbinderid
        Returns the IDs of the binder surfaces.
        hm_getboundingbox
        Returns the bounding box of the specified entities.
        hm_getboundingbox_predefined
        Returns the bounding box for a predefined box trim cut.
        hm_getcardimageoptions
        Returns information about certain options supported by a card image.
        hm_getcardmark
        This command returns the IDs (from the CARDINPUTLIST) for the entity type specified.
        hm_getcentroid
        Returns the geometric centroid for selected entities.
        hm_getcleanupglobalflags
        Returns the global flags currently being used for switching of some default modes for geometry autocleanup, element cleanup and element QI smoothing.
        hm_getclosedshelllayerelems
        Separates thin closed-shell meshes into top and bottom layers.
        hm_getclosestnode
        Returns the ID of the closest node to the point (x,y,z). Zero is returned if there are no nodes in the database.
        hm_getclosestpointsbetweenlinesurface
        Find the shortest distance between a line and a surface, and return line and surface points corresponding to this distance.
        hm_getclosestpointsbetweentwolines
        Find the shortest distance between two lines and return line points corresponding to this distance.
        hm_getcog
        Returns the mass center-of-gravity coordinates for the selected entities.
        hm_getcollectorname
        Returns the name of a collector.
        hm_getcommandfile
        Returns the full path and file name of the command file.
        hm_getconfigtypecountincol
        Returns a list indicating the entity config, type and count values that are contained in a collector.
        hm_getconfigtypeincol
        Returns a list indicating the entity config and type values that are contained in a collector.
        hm_getconnected2delems
        Returns lists of 2D shell elements and nodes that form t-connections or share edges at component boundaries.
        hm_getconnected3delems
        Detects and categorizes connections involving 3D elements and provides a list of entities involved in the connections.
        hm_getcoordinatesfromnearestsurface
        Finds coordinates of a point that belongs to one of surfaces in input set and is a closest point to the location specified in command input.
        hm_getcoordinatesofpointsonline
        Gets the coordinates of the points for which normalized parameters are specified, along with the ID of the line on which they are located, as arguments to the command.
        hm_getcriteria
        Query the values of global mesh quality criteria.
        hm_getcrossreferencedentities
        Finds entities that reference the specified entity.
        hm_getcrossreferencedentitiesmark
        Finds entities that reference the entities on the specified mark.
        hm_getcurrentframe
        Returns the current animation frame.
        hm_getcurrenttime
        Returns the current transient animation time.
        hm_getcurrentmodel
        Returns the name of the current model.
        hm_getdatatypeaveraginglist
        Returns a list of available averaging modes for the specified data type.
        hm_getdatatypecomponents
        Returns a list of available data components for a specific result subcase and data type.
        hm_getdatatypelayers
        Returns a list of available layers for a specific result subcase and data type.
        hm_getdatatyperesolvedinlist
        Returns a list of available systems the specified data type can be resolved in.
        hm_getdefaultcardimage
        Returns the default card image for the specified entity type for the current template/profile.
        hm_getdeleteassociatedentitiesbycompmark
        Returns the unique associated entities for the components on a mark.
        hm_getdiameterfromfile
        Returns the diameter for the specified thickness from the DVST file.
        hm_getdiedisplayattribute
        Returns the die display attribute.
        hm_getdiepartid
        Returns the IDs of the die part surfaces.
        hm_getdiepartshape
        Returns the shape ID of the die part.
        hm_getdistance
        Returns the distance between two nodes/points relative to a local coordinate system.
        hm_getdistancefromnearestline
        Gets the distance of the given point from the nearest line with IDs specified as arguments.
        hm_getdistancefromnearestsurface
        Gets the distance of the given point from the nearest of the surfaces with IDs specified as arguments.
        hm_getdrawbarid
        Returns the IDs of the draw bar surfaces.
        hm_getdrawbeadattribute
        Returns the attributes of the drawbar or drawbead created by the die module.
        hm_getdrawbeadid
        Returns the IDs of the draw bead surfaces.
        hm_getduplicateelements
        Returns a list of lists containing duplicate elements.
        hm_getedgeloops
        Returns surface and element entities of specific connection types.
        hm_getedgeloops2
        Returns surface and element boundary entities of specific connection types, and assumes any non-selected entities do not exist.
        hm_getedgesfromvertex
        Returns all surface edges connected to a specified vertex point.
        hm_getelemcheckbounds
        Returns the lower and upper bound values of the specified element check from the selected elements.
        hm_getelemcheckelems
        Returns the elements from within a selection that match the specified element check criteria.
        hm_getelemchecksummary3d
        Returns the 3D solid element quality summary.
        hm_getelemcheckvalues
        Returns the check value for elements from within a selection.
        hm_getelementcheckmethod
        Returns the method (solver) currently being used for calculating specific element quality checks.
        hm_getelementchecksettings
        Returns the list of methods being used for calculating specific element quality checks.
        hm_getelementnormal
        Returns the normal vector of the specified element vertex/edge/face.
        hm_getelementsqualityinfo
        Computes quality parameters for the specified selection of elements.
        hm_getelementvolumes
        Returns lists of shell element volumes and baffle elements in each volume.
        hm_getentities_dirty
        Returns a list of dirty entities for an entity type.
        hm_getentitiesinboxes
        Returns specified entities within boxes.
        hm_getentityalias
        Returns the alias for a specified entity type.
        hm_getentitybasename
        Returns the full HyperMesh entity type name for the passed entity type partial or short name.
        hm_getentitybundleinfo
        Returns information about entity bundles.
        hm_getentitycardimagedictionary
        Returns a list of card images for the specified entity type and card image organizational type defined in the current template.
        hm_getentitycreationid
        Returns a valid entity ID that can be used to renumber both the creating and mapping entities.
        hm_getentityinfo
        Returns definition information for an entity, either corresponding to the data name specified or all data names for that entity.
        hm_getentityname
        Returns the full HyperMesh entity type name for the passed entity type ID.
        hm_getentityroot
        Returns the ID of the root entity for a given modular entity type.
        hm_getentitytype
        Returns the HyperMesh entity type ID for the passed entity type name.
        hm_getentitytypealiasname
        Returns the alias name for a specified entity type in the current user profile.
        hm_getentitytypedictionary
        Returns a list of card image types defined in the current template for the specified entity type.
        hm_getentitytypedisplayname
        Returns the display name for the specified entity type.
        hm_getentitytypes
        Returns a list of entity types based on the specified option.
        hm_getexistingentitytypes
        Returns the list of entity types that exist in the current database.
        hm_getfacesbyarea
        Gets the faces with an area smaller or equal to the specified value.
        hm_getfacesbyedgelength
        Gets the faces that have an edge with a length smaller or equal to the specified value.
        hm_getfacesfromedge
        Gets all faces connected to the edge whose ID is supplied as the argument.
        hm_getfacesfromsurface
        Gets faces contained in the surface whose ID is supplied as the argument.
        hm_getfacesfromvertex
        Gets all faces connected to the point whose ID is supplied as the argument.
        hm_getfilletfaces
        Returns the faces containing fillets with a radius inside a range.
        hm_getfilletfacesbyprofile
        Returns the faces containing fillets with a selected profile edge.
        hm_getfilletfacesfrommark
        Returns the faces containing fillets with a radius inside a range, only considering specific faces.
        hm_getFLid
        Returns the IDs of the flange lines.
        hm_getgeometricthinsolidinfo
        Identify and return information on thin solid surface groups.
        hm_getgeometrynodes
        Get a list of associated nodes from the set of geometric entities.
        hm_getgeomtopologytype
        Returns the topology type of a geometric entity.
        hm_getgeomwithlargestitch
        Returns the list of all surfaces, lines and points for which the topological stitch distance exceeds the input tolerance.
        hm_getguientityname
        Returns the full HyperMesh entity type name with GUI style capitalization for the passed entity type ID.
        hm_gethistorylimit
        Returns the maximum number of steps allowed to be recorded in the history.
        hm_gethistorymemorylimit
        Returns the maximum amount of memory allowed to be used for recording history.
        hm_gethistorymemoryusage
        Returns the current amount of memory used for recording history.
        hm_gethmfileuserprofile
        Returns the user profile information saved in the HyperMesh database.
        hm_gethmfileversion
        Returns the binary file version string for a specified HyperMesh database.
        hm_getidpoolnumber
        Returns the ID pool number for a given solver and ID pool name.
        hm_getidpools
        Returns a list of pool IDs or names for the specified entity type.
        hm_getidpoolsforidrange
        Returns a list of pool names based on the specified entity type and solver ID range.
        hm_getincludeisolationentitiesmark
        Returns the entities referenced/cross-referenced by the selected components, for include file organization purposes.
        hm_getincludes
        Returns a list of include IDs or names.
        hm_getincludes_modified_since_last_export
        Returns the include file IDs marked as dirty since the last export.
        hm_getincludesentities
        Selects entities and returns the entity types contained in specified include files.
        hm_getincrementalname
        Returns a unique incremental name from a specified base name and one or more entity types.
        hm_getinputoffsetid
        Returns the current import offset ID value for the specified entity type.
        hm_getinternalid
        Returns the internal HyperMesh ID for a solver ID and solver ID pool.
        hm_getinternalidlist
        Returns the internal HyperMesh IDs for a list of solver IDs and a solver ID pool.
        hm_getinternalname
        Returns the internal name for the specified pool string/pool ID and solver name.
        hm_getlinearclenpoint
        Finds the coordinates of the point on the line that is at a given arc-length distance from another point on the line
        hm_getlineendpoint
        Returns the components of the line end point.
        hm_getlinelineangle
        Returns the angle between two lines at one of their intersection points.
        hm_getlinepointsatdistance
        For a given line, test point, and distance, this command finds all of the line points that are at the specified distance from the test point.
        hm_getlinestartpoint
        Returns the components of the line start point.
        hm_getlinetangentatcoordinate
        Returns the closest point, the components of the tangent vector and the angle between the tangent vector and the z-axis at the point on the line closest to the input coordinates.
        hm_getlinetgendpoint
        Returns the components of the tangent vector and the angle between the tangent vector and the z-axis at the line end point.
        hm_getlinetgstartpoint
        Returns the components of the tangent vector and the angle between the tangent vector and the z-axis at the line start point.
        hm_getlinetype
        Returns the line type.
        hm_getlist
        Returns an ordered list of entities from an entity list.
        hm_getllsid
        Returns the IDs of the latitude lines.
        hm_getlockedentities
        Queries entity locks.
        hm_getmark
        Returns the entity IDs of the passed entity type on the specified mark.
        hm_getmarkall
        Returns a list of lists containing the populated entity type and entity IDs for the specified mark.
        hm_getmarkentitytypes
        Returns a list of entity types that have entities populated on the specified mark.
        hm_getmarkfromtable
        Returns the entity IDs from the specified table.
        hm_getmass
        Returns the mass, volume and area of the selected elements or components.
        hm_getmatching
        Performs a comparison and returns matching results.
        hm_getmatrixdifference
        Given 4x4 transformation matrices M1 and M2, return the 4x4 matrix representing M1-1M2.
        hm_getmaxgapwidth
        Returns the approximate maximum distance between a pair of node lists.
        hm_getmemoryinfo
        Returns system memory information.
        hm_getmeshedgeparams
        Returns all of the relevant automesh settings applied to that surface edge.
        hm_getmeshfaceparams
        Returns all of the relevant automesh settings applied to that surface face.
        hm_getmeshvolumesinfo
        Returns the number of volumes and lists containing the element IDs and volume indices for each input element.
        hm_getmethodinfo
        Returns method information from the stress tool .
        hm_getmidsurfaceinfo
        Returns information related to geometric midsurfaces.
        hm_getmidsurfcomp
        Returns the name of the component in the model that contains middle surfaces and no other surfaces.
        hm_getmodelcheckconcernentityidresultentityid
        Finds the list of untied nodes after a Model Checker run.
        hm_getmodelcheckcheckname
        Returns the function name for a given check.
        hm_getmodelcheckcheckresult
        Returns the result for a given check.
        hm_getmodelcheckcheckstatus
        Returns the status for a given check.
        hm_getmodelcheckcorrectiondisplayname
        Returns the correction names for a given check.
        hm_getmodelcheckcorrectionname
        Returns the function for a given correction.
        hm_getmodelcheckcorrectvalue
        Returns the value for a given correction.
        hm_getmodelcheckdefaultconfigfile
        Returns the default model check config file for a profile.
        hm_getmodelcheckdisplaynames
        Returns check display names.
        hm_getmodelcheckenttype
        Returns the entity type for the specified Model Check check display name.
        hm_getmodelcheckfailedcount
        Returns the number of entities failing a given model checker check.
        hm_getmodelcheckresultentids
        Returns the entity IDs for the specified Model Check check display name.
        hm_getmodelchecksupportedentities
        Returns the list of entity types that have checks.
        hm_getmodelchkvaluelevellimitcriteriaattribute
        Returns model check values for level, limit, criteria and attributes.
        hm_getmoi
        Returns the tensorial moment-of-inertia values for the selected entities.
        hm_getmoiofsolid
        Calculate and return the 3 moment of inertia (Ixx, Iyy, Izz) and 3 product of inertia (Ixy/Iyx, Iyz/Izy, Ixz/Izx) values (MOI) for a single solid geometric entity.
        hm_getmultilevelreferenceentities
        Finds all the multi-level reference entities for the entities specified on the input mark.
        hm_getmydocumentsdir
        Returns the path to the current user’s "My Documents" folder on Windows.
        hm_getnearbyentities
        Finds entities nearby entities on an input mark.
        hm_getnodalthickness
        Gets the thickness of the node whose ID is given as the argument.
        hm_getnodegeometry
        Get the simplest geometry entity associated with the node.
        hm_getnodeinitialcoords
        Returns the node position on the initial associated geometry.
        hm_getnodessharedbyothercomps
        Returns the nodes on the input components that are shared by other components.
        hm_getoccupiedentitiesinrange
        Returns the list of occupied IDs in a specific range.
        hm_getoffset
        Returns the offset value of the specified element.
        hm_getoffsetZ0
        Returns the offset Z0 value of the specified element.
        hm_getoption
        Returns the value of certain HyperMesh options.
        hm_getorientation
        Returns a 4x4 matrix corresponding to the moment directions of the input.
        hm_getplanarfaces
        Returns a list of planar face IDs.
        hm_getplaneintercepts
        Returns the maximum and minimum points of a plane cross-section virtual intersection with entities.
        hm_getPOLid
        Returns the IDs of the POL lines.
        hm_getpoolaliasname
        Returns the alias name for a specified pool ID in current user profile.
        hm_getprefixbasenamesuffixforgivencompname
        Returns the split name as prefix, base name and suffix for the specified component name and separator.
        hm_getprincipalaxes
        Returns the principal axes direction cosines for the selected entities.
        hm_getprojceid
        Returns the ID of the connector from the FE weld data array for a given index.
        hm_getqephtimestep
        Returns the time step calculated from QEPH elements in a component.
        hm_getqualitycriteriaelementsizeinfo
        Returns element size info for a quality criteria file.
        hm_getqualitycriteriastatus
        Checks the status of the quality criteria.
        hm_getredoactions
        Returns the history actions on the redo list.
        hm_getreferencedentities
        Finds entities that are referenced by the specified entity.
        Supported Entities
        Supported entities for hm_getreferencedentities.
        hm_getreferencedentitiesmark
        Finds entities that are referenced by the entities on the specified mark.
        hm_getreplacecomponentpairing
        Returns the component pairing for part replacement.
        hm_getreplacequerryonentities
        Query information about a part replace preview operation.
        hm_getresults
        Returns results data.
        hm_getribsid
        Returns the IDs of the rib lines.
        hm_getshelloverlapinfo
        Returns information regarding proximity overlap between a selection of components or elements.
        hm_getsketchdata
        Queries the information about the entities present in the sketch.
        hm_getsolidboundsforsurfaces
        Returns a list of bounding surface IDs, one list for each set of bounding surfaces found, or nothing if there is not a valid closed bounds found.
        hm_getsolidmappablestate
        Returns the mappable state of the specified solid.
        hm_getsolidsfromsurface
        Returns the list of solid IDs associated with a specified surface ID.
        hm_getsolidshelloverlapinfo
        Returns information regarding proximity overlap between one/more solid cavity element(s) and structural components.
        hm_getsolver
        Returns the name or ID of the solver as provided by the template *codename() command.
        hm_getsolvercards
        Returns a list of solver cards (template tags) for either the specified entity type or solver ID pool.
        hm_getsolverfileprofilename
        Returns the profile name for an FE input file.
        hm_getsolverid
        Returns the solver ID and pool name for the specified HyperMesh internal ID.
        hm_getsolverid2
        Returns the solver ID and pool name for the specified HyperMesh internal ID.
        hm_getsolverids
        Returns the solver IDs and pool names for the specified HyperMesh internal IDs.
        hm_getsolverusessegmentsets
        Queries whether the current solver profile supports segment sets.
        hm_getsourcecompsgroupsusingprefixbasenamesuffix
        Returns a list of matching component IDs which have the same prefix-base-suffix name in the original model and an incoming model.
        hm_getsubcasedatatypes
        Returns a list of available data types for a specific result subcase.
        hm_getsurfacecurvatureforedges
        Returns information about the curvature of surfaces attached to edges.
        hm_getsurfaceedges
        Get a list of edges associated with a specified ID.
        hm_getsurfacefromface
        Gets the surface containing the face whose ID is supplied as the argument.
        hm_getsurfacenormal
        Gets the normals of the surfaces connected to the node or point whose ID is given as the argument.
        hm_getsurfacenormalatcoordinate
        Returns the closest point and the components of the normal vector at the point on the surface closest to the input coordinates.
        hm_getsurfacesbyarea
        Gets the surfaces with an area smaller or equal to the specified value.
        hm_getsurfacesbyedgelength
        Gets the surfaces that have an edge with a length smaller or equal to the specified value.
        hm_getsurfacesfromedge
        Gets all surfaces connected to the edge whose ID is supplied as the argument.
        hm_getsurfacesfromsolid
        Returns the list of surface IDs associated with a specified solid ID.
        hm_getsurfacesfromvertex
        Gets all surfaces connected to the point whose ID is supplied as the argument.
        hm_getsurfacesurfaceangle
        Finds the angle, measured in degrees, between two surfaces.
        hm_getsurfacethicknessvalues
        Returns the midsurface thickness and offset values for nodes, points, or elements.
        hm_getsurfaceuvatcoordinate
        Returns the nearest surface u,v coordinate from a given x, y, z location.
        hm_gettgofpointsonline
        Returns the line coordinates and tangents at each of the given line u parameters.
        hm_getthickness
        Returns the thickness of the specified component, element or property.
        hm_gettiedentities
        Finds elements or components tied to nodes, elements, components or contactsurfs.
        hm_gettimestepaddedmass
        Returns time step added mass for Radioss and Dyna.
        hm_getTLid
        Returns the IDs of the trim lines.
        hm_gettotalcog
        Returns the center of gravity of the entire model.
        hm_gettotalmass
        Returns a list of model mass values.
        hm_gettotalmoi
        Returns the total tensorial moment-of-inertia values of the model about the center of gravity.
        hm_gettracksid
        Returns the ID of the tracks.
        hm_gettrimmedbinderid
        Returns the IDs of the trimmed binder surfaces.
        hm_gettypefromidpoolnumber
        Returns the type for a specified pool ID in the current user profile.
        hm_gettypesenabledfornamepools
        Returns the entity types that are enabled for name pool.
        hm_gettypeswithunresolvedids
        Returns a list of entity types that currently have unresolved IDs.
        hm_getundoactions
        Returns the history actions on the undo list.
        hm_getunmeshedsurfstomark
        Places the unmeshed surfaces from the input mark onto the output mark.
        hm_getunoffsetablenodes
        Saves to the user list the unoffsetable nodes. Useful for CFD BL meshing.
        hm_getunresolvedidcrossreferences
        Returns entities that are referring to an unresolved ID.
        hm_getunresolvedids
        Returns the unresolved IDs for a specific entity type.
        hm_getunusedoremptyentities
        Returns empty or unused entities.
        hm_getusermark
        Returns the entity IDs of the passed entity type from the user mark.
        hm_getuvbounds
        Returns the parametric uv coordinate bounds associated with the referenced surface.
        hm_getuvcoordinates
        Returns the parametric uv coordinates at a node location on the referenced surface.
        hm_getuvvectors
        Returns the parametric uv vectors at a node, point or xyz location on the referenced surface.
        hm_getvalue
        Queries data names, attributes, and metadata on entities.
        hm_getverticesfromedge
        Get surface edge endpoints.
        hm_getvolumeofsolid
        Finds the volume of a solid entity specified by the solid entity’s ID.
        hm_getwhollycontainedcollectormark
        Returns the collectors that fully contain the input entities.
        hm_getwrappoints
        Returns a list of points, from the first input point to the third input point, that trace a convex path across the specified entities.
        hm_hierarchy
        Returns the hierarchical structure of assemblies and components, along with properties, materials, groups and beamsection collectors.
        hm_historyscriptunsupportedtofile
        Writes out to files a summary of the unsupported commands contained inside .tcl script files.
        hm_historysupporttofile
        Writes out to a file the commands that are supported for history.
        hm_holedetectionend
        Clear memory and ends the hole/tube detection module.
        hm_holedetectionfindholes
        Executes the hole/tube detection tools.
        hm_holedetectionfindmates
        Executes the hole/tube mating tools.
        hm_holedetectiongetholedetails
        Returns details about a specific hole/tube.
        hm_holedetectiongetholedetailsdata
        Returns details about a specific query for a hole/tube.
        hm_holedetectiongetmatedetails
        Returns details about a specific hole/tube mating 'group'.
        hm_holedetectiongetnumberofholes
        Returns the number of found holes/tubes.
        hm_holedetectiongetnumberofmates
        Returns the number of found hole/tube mating 'groups'.
        hm_holedetectiongetwasherelementslist
        Returns the ID of washer elements layer-wise.
        hm_holedetectionidentifyhole
        Returns the hole index for a given node or line.
        hm_holedetectioninit
        Initializes the hole/tube detection module.
        hm_holedetectionsetentities
        Defines the entities to consider for hole/tube detection.
        hm_holedetectionsetholeparams
        Defines parameters for finding 2D holes in both geometry and FE.
        hm_holedetectionsettubeparams
        Defines parameters for finding tubes in both geometry and FE.
        hm_idconvertmode
        hm_info
        Query general information about HyperMesh options and paths.
        hm_intersectlineline
        Find the intersection point of two lines.
        hm_iscurrentmodelprimary
        Query if the current model is primary or secondary.
        hm_is_dirtiness_detection_enabled_for_entitytype
        Informs if automatic dirtiness detection is enabled for the entity type.
        hm_isentitydatanameparameterized
        Determines if a specific data name or attribute is parameterized.
        hm_isentitysupportedforaction
        Determines if a particular entity type is supported for a certain action.
        hm_ishistorysupported
        Returns the history support level for the specified command.
        hm_ispointinsidesolid
        Checks whether a point is inside the volume of a solid geometry.
        hm_ispointinsidesolidelem
        Checks whether a point is inside the volume of a solid element.
        hm_issurfacemappable
        Checks whether the given surface can be mapped or not and returns the map shape and vertices of the shape.
        hm_istextcard
        This command returns 1, for control cards if it is a string array card, else it returns 0.
        hm_jobs_addServer
        Add a new server.
        hm_jobs_authenticateServer
        Authenticates a server.
        hm_jobs_canSubmit
        Reports if a job can be submitted on the current server without authentication.
        hm_jobs_editServer
        Edits an already existing server.
        hm_jobs_getAppList
        Returns the list of applications available for a given server.
        hm_jobs_getJobStatus
        Returns the present status of a job on a server.
        hm_jobs_getServerDetails
        Returns the name, IP and port of a server.
        hm_jobs_getServerList
        Returns the list of servers added by HyperMesh.
        hm_jobs_getServerListFromServices
        Returns the list of servers added by all applications.
        hm_jobs_getVersionList
        Returns the list of versions available for a given application in a server.
        hm_jobs_removeServer
        Removes a server.
        hm_jobs_setCurrentServer
        Sets a server as current.
        hm_jobs_setServiceProperty
        Sets a service property for the PBS-sensor.
        hm_jobs_startService
        To explicitly start the PBS-sensor services.
        hm_jobs_submitBatchmeshJob
        Submits a BatchMesh job to the server.
        hm_jobs_submitHSTJob
        Submits a HyperStudy job to the server.
        hm_jobs_submitOptistructJob
        Submits a OptiStruct job to the server.
        hm_jobs_terminateJob
        Kills a running job.
        hm_latestentityid
        Returns the ID of the last created entity.
        hm_linegetorderelems
        Get the list of ordered 1D elements associated with input free lines for the given tolerance.
        hm_linegetordernodes
        Get the list of ordered nodes associated with input free lines for the given tolerance.
        hm_linelength
        Returns the sum of lengths of the lines whose IDs are given as arguments.
        hm_mapelementstoplane
        Fast unfolding of a given set of connected shell elements onto a plane.
        hm_markbyfeature
        Selects geometric entities by feature-based parameters.
        hm_markclear
        Clear all entity IDs of the passed entity type from the specified mark.
        hm_markclearall
        Clear all entity IDs for all entity types from the specified mark.
        hm_marklength
        Returns the number of entities on the specified mark.
        hm_markremove
        Removes entities from the specified mark.
        hm_marksearchmode
        Defines the ID/name search order for *appendmark and *createmark.
        hm_marktotable
        Creates a named mark table and populates it with the entities on a mark.
        hm_me_childrenget
        Returns the first-level children module IDs.
        hm_me_entitiesall
        Returns all of the entity types and IDs contained in a module.
        hm_me_entitiesget
        Returns the entity IDs of a specific entity type contained in a module.
        hm_me_moduleget
        Returns the module ID an entity belongs to.
        hm_me_modulesgetFromUid
        Returns the list of module IDs for a given UID.
        hm_me_occrepkeyget
        Returns the representation key of a part occurrence.
        hm_me_parentsget
        Returns the recursive list of parent module IDs.
        hm_me_protoreplistget
        Returns a list of the representation keys from a part prototype.
        hm_me_protoreptypeget
        Returns the representation type of a part prototype.
        hm_me_repdetailget
        Returns the requested metadata attributes from a part representation.
        hm_me_repfiledataget
        Returns the representation file name and file format in a key-value form.
        hm_me_rootget
        Returns the session-level root module ID.
        hm_measureshortestdistance
        Measures the shortest distance between two entity selections.
        hm_measureshortestdistance2
        Measures the shortest distance between a coordinate location and an entity selection.
        hm_metadata
        Query the HyperMesh database for metadata.
        hm_modelcheckneedscorrection
        Determines if an auto correction is required for a given check.
        hm_modelchecksavetoxml
        Saves the config data to an XML file.
        hm_modent_getchildren
        Get a mark of hierarchical children entities from a modular entity.
        hm_modent_getconstraintruleoptions
        Returns a list of options that control the behavior of add/move/remove operations for a modular entity.
        hm_modent_getcontententitytypes
        Returns a list of entity types contained in a modular entity.
        hm_modent_getcontentsbymark
        Returns a mark of entities which are contents of a modular entity.
        hm_modent_getentityparent
        Returns the hierarchical modular entity parent of a specific entity.
        hm_modent_getincludes
        Returns the list of includes that are managed by a subsystem.
        hm_modent_getmodifiedbyids
        Returns a list of modular entities modified after a representation has been realized.
        hm_modent_getrepresentationdefinitions
        Returns the number of modular entity representations available, and those realized.
        hm_morph_getdomainangle
        Returns the angle between two specified edge domains. Optional argument allows the user to input a normal vector to be used to measure the angle.
        hm_morph_getdomainarcangle
        Returns the arc angle of a specified edge domain. Optional arguments allow the arc angle to be calculated using a line, node, or base point and axis to find the center of curvature.
        hm_morph_getdomainlength
        Returns the length of a specified edge domain. Optional argument allows the user to input a vector along which to measure the length.
        hm_morph_getdomainradius
        Returns the radius of a specified edge domain. Optional arguments allow the radius to be calculated using a line, node, or base point and axis to find the center of curvature.
        hm_morph_gethandledomains
        Returns the domain IDs for the specified handle.
        hm_morph_gethandlenode
        Returns the node ID for the specified handle.
        hm_morph_getinfo
        Returns certain options/values from HyperMorph.
        hm_morph_getmvoledge
        Returns the morph volume edge ID for the specified nodes along the edge.
        hm_morph_getmvoledgenodes
        Returns the IDs of the nodes along a specified morph volume edge.
        hm_morph_getmvolface
        Returns the morph volume face ID for the specified morph volume and nodes along the edges of that face.
        hm_morph_getnodehandle
        Returns the handle ID for the specified node if a handle exists at that node.
        hm_morphupdatecheck
        Identifies changes in the database relevant to HyperMorph entities and calls the necessary commands to update those HyperMorph entities.
        hm_nodeismidnode
        Checks if a node is a mid-side node.
        hm_pathmanager
        Returns all search paths, and runs a specified procedure for each path.
        hm_plotcontrol_update_begin
        Initializes a sequence of updating multiple data names for a specified plotcontrol entity.
        hm_plotcontrol_update_end
        Finalizes a sequence of updating multiple data names for a specified plotcontrol entity.
        hm_postcardeditorforentity
        Posts a card editor for a selected entity.
        hm_postcardeditorformarkmask
        Posts a card editor for a mark of entities.
        hm_projectpointonsegment
        Returns the closest point to a specific point on a finite segment.
        hm_projectpointtosegment
        Returns the closest point to a specific point on a segment.
        hm_projectpointtosegmentwithangle
        Finds the projection point to a specific point on a segment along a specific direction.
        hm_proximityend
        Clears the proximity calculation data and memory.
        hm_proximitygetcomponentelementpair
        Returns a specific proximity element pair for a specific component pair.
        hm_proximitygetcomponentelementpaircount
        Returns the number of element pairs for a specific component pair.
        hm_proximitygetcomponentpair
        Returns a specific proximity component pair.
        hm_proximitygetcomponentpaircount
        Returns the number of proximity component pairs.
        hm_proximitygetelementdistance
        Returns the proximity distance for a given element.
        hm_proximityinit
        Checks the proximity between elements or components, and stores the results internally.
        hm_proximityinitwithtarget
        Checks the proximity between elements or components, allowing the user to specify the target, and stores the results internally.
        hm_proximitymarkcomponentallelementpairs
        Marks the element pairs for a specific component pair.
        hm_proximitymarksourceproximityelements
        Marks all the source elements within proximity to the given mark.
        hm_proximitymarktargetproximityelements
        Marks all the target elements within proximity to the given mark.
        hm_removedieattribute
        Removes the die attribute from an entity.
        hm_saveusermark
        Store the entity IDs of the passed entity type on the user mark.
        hm_setdieattribute
        Sets the die attribute for an entity.
        hm_setmodelcheckcheckstatus
        Sets the run status for the specified Model Check check display name.
        hm_setmodelcheckcorrectionstatus
        Sets the applied status for the specified Model Check correction display name.
        hm_setmodelcheckresultentids
        Sets the entity IDs for the specified Model Check check display name.
        hm_setsolver
        Sets theHyperMesh solver interface name in order to access entity information available for that solver.
        hm_solverconvert
        Converts a model from one solver to another.
        hm_tableappend
        Appends the contents of a HyperMesh table to another HyperMesh table of the same entity type. Creates a destination table if it does not exist.
        hm_tableclear
        Clear a table (all memory is freed).
        hm_tableclearall
        Clear all tables (all memory is freed).
        hm_tablecopy
        Makes a copy of the HyperMesh table. Overwrites destination table.
        hm_tabledifference
        Finds the difference of two HyperMesh tables of the same entity type (subtracts the contents of the second table from the first table) and places the result in the first table.
        hm_tableintersection
        Finds subset of entities common to two HyperMesh tables of the same entity type and places it into the first table.
        hm_tablelist
        List the names of all tables created by marktotable.
        hm_tablelookup
        Search a table for an entity ID. The constant 1 is returned if the ID is found. Otherwise, 0 is returned.
        hm_tabletomark
        Append the entity IDs from the named table to the specified mark.
        hm_triplecos
        Get the cosine angle of two vectors.
        hm_undefinedmatchingcriteria
        Returns the supported undefined matching criteria for a given entity type.
        hm_updatemodelcheckresultvalues
        Updates the failed values for the model check entity.
        hm_visualizeloads
        Plots engineering loads referenced by a load collector.
        hm_wadlinescheckentities
        Checks front and rear entities for validity.
        hm_wadlinesend
        Clear memory and end the WAD lines module.
        hm_wadlinesgetadulttestzone
        Returns the coordinates of the adult test zone boundary.
        hm_wadlinesgetchildtestzone
        Returns the coordinates of the child test zone boundary.
        hm_wadlinesgetdebugtracelines
        Creates the debug lines used to create different types of reference lines, and returns the coordinates.
        hm_wadlinesgetgridpoints
        Returns coordinate data defining WAD grid points.
        hm_wadlinesgetgridpointsleg
        Returns grid points for either upper or lower leg impact analysis.
        hm_wadlinesgetinternalbumperline
        Returns the averaged points for the internal bumper line as a series of x, y, and z values.
        hm_wadlinesgetleggridline
        Returns a series of three doubles denoting the points for the line calculated by the previous call to hm_wadlinesgetgridpointsleg.
        hm_wadlinesgetreferenceline
        Returns coordinate data defining WAD reference lines.
        hm_wadlinesgetsectionmax
        Returns the most outward intercept of a cross section of the model as measured in a given direction.
        hm_wadlinesgetwadline
        Returns coordinate data defining a WAD line.
        hm_wadlinesgetwadpointtapeline
        Returns coordinate data defining a line made by the measuring tape running from the ground to the specified WAD point along the vehicle.
        hm_wadlinesinit
        Initializes the WAD lines module.
        hm_wadlinesispointintestzone
        Returns whether a point is inside a test zone by taking in the coordinates of the zone boundary.
        hm_wadlinessetbumper
        Sets the entities for the internal bumper components used for the internal bumper reference line and upper/lower leg grid point generation.
        hm_wadlinessetfrontentitiesforcollision
        Sets the front entities to be used to create the bonnet rear reference line.
        hm_wadlinessetentities
        Sets the entities used for a WAD lines analysis.
        hm_wadlinessethood
        Sets the entities for the hood used to create the reference line.
        hm_wadlinessetoptions
        Sets various WAD lines module options.
        hm_wadlinessetparameters
        Sets basic parameters for a WAD lines analysis.
        hm_wadlinessetaxes
        Sets the origin and coordinate axes for a WAD lines analysis.
        hm_wadlinessetwindscreen
        Sets the rear entities (windshield) to be used to create the bonnet rear reference line.
        hm_wadlinessetwipers
        Sets the wiper entities for a WAD lines analysis.
        hm_writemeshcontroltemplate
        Writes out the Mesh Control template file.
        hm_writeviewcommands
        Sets the state of writing certain view commands to the command file.
        hm_xformnodetolocal
        Returns the coordinates of a node relative to a local coordinate system.
        hm_xformvectoratpointtoglobal
        Returns the global components of a vector defined at a node and relative to a local coordinate system.
        hm_xformvectoratpointtolocal
        Returns the local components of a vector defined at a node and relative to the global coordinate system.
        hm_xpointlocal
        Transforms a coordinate into a local system and returns the x value of the transformed point.
        hm_xpointvectorlocal
        Transforms a vector into a local system and returns the x value of the transformed vector.
        hm_ypointlocal
        Transforms a coordinate into a local system and returns the y value of the transformed point.
        hm_ypointvectorlocal
        Transforms a vector into a local system and returns the y value of the transformed vector.
        hm_zpointlocal
        Transforms a coordinate into a local system and returns the z value of the transformed point.
        hm_zpointvectorlocal
        Transforms a vector into a local system and returns the z value of the transformed vector.
        hwct_getinfofromlibrary
        Query information from a currently connected library.
        Deprecated Tcl Query Commands
        The list of deprecated Tcl query commands, and the new commands to use.
        Undocumented Tcl Query Commands
        The list of undocumented Tcl query commands.
  - Solver Templates
    Solver templates are ASCII data files containing HyperMesh Template Language Commands and HyperMesh Template Language Functions.
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

Supported Entities

Supported entities for hm_getreferencedentities.

Data Name Entities


assems assems comps bags all entities blocks systems comps mats props connectors assems comps elems nodes props surfs systems tags vectors contactsurfs elems controlvols contactsurfs elems nodes sets designvars ddvals designvars laminates nodes props shapes desvarlinks dequations designvars tables dobjrefs loadsteps optiresponses dvprels dequations designvars elems mats plies props tables elems nodes props sets systems vectors equations nodes groups comps contactsurfs elems sets laminates laminates plies loads comps curves elems lines nodes points sets surfs systems	loadsteps groups loadcols outputblocks nodes systems objectives dobjrefs loadsteps optiresponses opticonstraints loadsteps optiresponses optiresponses dequations designvars dvprels elems loadsteps mats nodes plies props optiresponses tables outputblocks assems comps controlvols groups elems mats nodes props sets systems plies mats sets plots curves props mats sets assems comps elems mats nodes props sets systems nodes systems tables all entities tags elems nodes vectors nodes systems

Collected Entities

beamsectcols

beamsectcs

comps

connectors
elems
lines
points
solids
surfs

loadcols

equations
loads

systemcols

systems

vectorcols

vectors

Attribute Entities

Any entity which supports attributes as entities in the card image.