HyperWorks Desktop

2022

Home
HyperWorks Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperMesh
Scripts
This section contains details on general HyperWorks Desktop 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 GUI Commands
Commands that operate on the HyperMesh GUI widgets.
hm_exit
Exits HyperMesh.

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Reference Guides

2022

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2022.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover HyperWorks Desktop functionality with interactive tutorials.
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Manage Files and Data
Create, open, import, and save models.
Display Controls
Control the view and display of your model in the modeling window.
Session Navigation
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish Sessions
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Parameterize Report Templates
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
HyperWorks Collaboration Tools
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
HyperWorks Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with HyperWorks 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.
- Tcl/Tk Commands
  The HyperWorks Desktop 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.
- HyperWorks Record and Playback
  Record playback workflows in HyperView.
- HyperWorks Report
- 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 Desktop 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 Desktop 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.
        
        hm_arcball
        Allows rotation of the model by manipulating a virtual sphere.
        
        hm_callcollectorpanel
        Displays the Collector panel for selecting a single collector/named entity.
        
        hm_callhelp
        Displays the HTML help for a specific book and topic.
        
        hm_callincludepanel
        Displays the Include panel for selecting a single include.
        
        hm_callspecialpanel
        Displays the specified special panel.
        
        hm_callviewpanel
        Displays the View panel.
        
        hm_callvispanel
        Displays the Vis panel.
        
        hm_centerview
        Moves the selected location to the center of the modeling window.
        
        hm_circlezoom
        Allows you to select a region to zoom into.
        
        hm_clearmarker
        Clears the graphical marker created by hm_plotmarker.
        
        hm_clearmenuerror
        Clear the error flag used to display messages.
        
        hm_clearshape
        Clears the graphical shape created by hm_plotshape.
        
        hm_collectordisplayed
        Returns the display status of a collector.
        
        hm_completemenuoperation
        Cleans up the panel marks, rejection marks and drawlist.
        
        hm_disablepopup
        Removes one item from a popup menu.
        
        hm_editcard
        Launches the Card Editor to edit a specific entity or mark of entities.
        
        hm_edittextcard
        Launches the Tk control Card Editor to edit a text control card.
        
        hm_enableitem
        Enables a panel menu item.
        
        hm_enablepopup
        Adds a previously removed item back to a popup menu.
        
        hm_errormessage
        Displays a custom error message in the status bar.
        
        hm_exit
        Exits HyperMesh.
        
        hm_exitpanel
        Exits from a custom Tk panel.
        
        hm_fbdplot
        Create FBD panel or bar plots.
        
        hm_framework
        Controls certain options and of the HyperMesh GUI framework.
        
        hm_getcommandposition
        Returns the position of the command window.
        
        hm_getcurrentmenu
        Returns the name of the current panel.
        
        hm_getcurrentview
        Returns the transformation matrix for the current view.
        
        hm_getdirectionpanel
        Provides a panel to define a direction/vector.
        
        hm_getfilename
        Get a filename using a HyperMesh panel.
        
        hm_getfloat
        Get a floating point value using a HyperMesh panel.
        
        hm_getgraphicsarea
        Returns the x, y, width and height of the modeling window.
        
        hm_getint
        Get an integer value using a HyperMesh panel.
        
        hm_getitemnumber
        Gets the number of a menu item.
        
        hm_getitemnumberbytag
        This command returns the number of a menu item on a panel using a tag (string).
        
        hm_getloadplotstate
        Queries the current load plot state.
        
        hm_getpanelarea
        Returns the x, y, width and height of the panel area.
        
        hm_getpanelitems
        Returns the IDs and names of menu bar items in the Connector panels.
        
        hm_getpanelposition
        Returns the position (top | bottom) of the panel area.
        
        hm_getplanepanel
        Provides a panel to define a plane.
        
        hm_getstring
        Get a string value using a HyperMesh panel.
        
        hm_gettwoitemtoggle
        Returns the current selection number of a two-item toggle menu bar item.
        
        hm_getwindowarea
        Returns the x, y, width and height of a window.
        
        hm_highlightentity
        Control the highlighting of a single entity collector.
        
        hm_highlightlist
        Control the highlighting of a list of entities.
        
        hm_highlightmark
        Control the highlighting of a mark of entities.
        
        hm_idmgrmessagebox
        Turn on or off the message box for ID Manager messages.
        
        hm_launchhb
        Launches the HyperBeam GUI with a specified beam section loaded by default.
        
        hm_listpanels
        Returns the names of all panels available for the current user profile.
        
        hm_panelnamevalid
        Determines if the specified panel name is a valid HyperMesh panel.
        
        hm_panview
        Performs a dynamic pan of the model.
        
        hm_plotloads
        Plot engineering loads with various options.
        
        hm_plotentity
        Plots entity as either a vector or a contour plot.
        
        hm_plotmarker
        Creates a graphical marker.
        
        hm_plotshape
        Creates a graphical shape.
        
        hm_posteeforentity
        Posts a pop-up for a selected entity.
        
        hm_posteeformarkmask
        Posts a pop-up for a mark of entities.
        
        hm_redraw
        Redraws the HyperMesh window.
        
        hm_registerentitysubtypefilter
        Registers an entity sub-type filter for usage by *createmarkpanel or *createentitypanel.
        
        hm_registerkeyproc
        Registers a script or command to a keyboard shortcut.
        
        hm_registerredraw
        Specifies if markers and shapes should be redrawn when the associated entity is modified.
        
        hm_renameitem
        Renames a menu bar item (selector, entry field, etc); this command is used by user profiles to customize the user interface.
        
        hm_rotateview
        Allows rotation of the model by performing a dynamic rotation.
        
        hm_scaleview
        Performs a dynamic zoom of the model.
        
        hm_getscreenvector
        Returns either the normal or parallel screen vector.
        
        hm_setcommandposition
        Sets the position of the command window.
        
        hm_setentitysubtype
        Use this command in conjunction with the creation of filters to add only entities of the stated type to the filter.
        
        hm_setlinemeshpanelproc
        This customizes the Line Mesh panel, and is used in user profiles.
        
        hm_setmouse
        Use this command in Tcl procedures to show the user that HyperMesh is working.
        
        hm_setpanelheight
        Sets the height, in pixels, of the panel area for use with custom Tk panels.
        
        hm_setpanelposition
        Sets the position of the panel area.
        
        hm_setpanelproc
        Clears HyperMesh panels, and sets <procedure name> as a macro to be called.
        
        hm_setsystempanelproc
        This customizes the Systems panel, and is used in user profiles.
        
        hm_setuserprofileoption
        This command will set user profile options.
        
        hm_togglevirtualcollector
        Toggles the state of the browser virtual collector show/hide, isolate and selector modes.
        
        hm_unregisterentitysubtypefilter
        Unregisters an entity sub-type filter for usage by *createmarkpanel or *createentitypanel.
        
        hm_usermessage
        Displays a custom user message in the status bar.
        
        hm_viewbottomside
        Sets the model to the bottom side view.
        
        hm_viewccw
        Rotates the model counter-clockwise about an axis oriented perpendicular to the screen.
        
        hm_viewclear
        Clears a saved view.
        
        hm_viewcw
        Rotates the model clockwise about an axis oriented perpendicular to the screen.
        
        hm_viewdown
        Rotates the model down about an axis oriented horizontally across the screen.
        
        hm_viewfit
        Fits the model view into the modeling window.
        
        hm_viewfrontside
        Sets the model to the front side view.
        
        hm_viewisometric
        Sets the model to the isometric view.
        
        hm_viewleft
        Rotates the model left about an axis oriented vertically across the screen.
        
        hm_viewleftside
        Sets the model to the left side view.
        
        hm_viewlist
        Returns the list of saved views.
        
        hm_viewprevious
        Returns the view to the previous view.
        
        hm_viewproject
        Converts an x,y,z model coordinate to a modeling window coordinate.
        
        hm_viewrearside
        Sets the model to the rear side view.
        
        hm_viewreverse
        Rotates the model 180 degrees about an axis oriented vertically across the screen.
        
        hm_viewright
        Rotates the model right about an axis oriented vertically across the screen.
        
        hm_viewrightside
        Sets the model to the right side view.
        
        hm_viewshaded
        View all components in shaded mode with no feature or mesh lines.
        
        hm_viewshadedfeatures
        View all components in shaded mode with feature lines.
        
        hm_viewshadedmesh
        View all components in shaded mode with mesh lines.
        
        hm_viewtopside
        Sets the model to the top side view.
        
        hm_viewunproject
        Converts an x,y,z graphic window coordinate to a modeling windowcoordinate.
        
        hm_viewup
        Rotates the model up about an axis oriented horizontally across the screen.
        
        hm_viewwireframe
        View all components in wire frame mode.
        
        hm_windowtoclipboard
        Capture a rectangular area of the screen and save it to the clipboard.
        
        hm_windowtofile
        Capture a rectangular area of the screen and save it to a file.
        
        hm_winfo
        Returns the value of certain HyperMesh window settings.
        
        hm_wm
        Provides a limited interface to the HyperMesh window.
        
        hm_zoomin
        Zooms into the model.
        
        hm_zoomout
        Zooms out of the model.
        
        hmbrapi
        Returns information about hmbr3 browser views and selections.
        
        Deprecated Tcl GUI Commands
        The list of deprecated Tcl GUI commands, and the new commands to use.
        
        Undocumented Tcl GUI Commands
        The list of undocumented Tcl GUI commands.
      - Tcl Modify Commands
        Commands that modify the HyperMesh database.
      - Tcl Query Commands
        Commands that query the HyperMesh database.
      - Utility Menu Commands
        Documentation on the commands that control the Utility menu.
  - 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.

View All Altair Simulation Help

HyperWorks Desktop

2022

Home
HyperWorks Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperMesh
Scripts
This section contains details on general HyperWorks Desktop 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 GUI Commands
Commands that operate on the HyperMesh GUI widgets.
hm_exit
Exits HyperMesh.

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Reference Guides

hm_exit

Exits HyperMesh.

Syntax

hm_exit

Type

HyperMesh Tcl GUI Command

Description

This command exits/quits HyperMesh.

Example

hm_exit

Errors

None.

© 2022 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support