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.
Introduction
Command Files
Command files can be used to create new command scripts that perform automation, or to recover previously performed steps.

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
      - Command Files
        Command files can be used to create new command scripts that perform automation, or to recover previously performed steps.
      - Entity Types
        HyperWorks entities are often used as string parameters in commands that act directly on entities in some fashion, such as creating filtered sets that contain only a specific entity type.
      - Marks
        Marks specify groups of entities that are transferred to the command processor. Marks can be created for most entities, and commands are then issued to perform operations on the entities on the mark. HyperMesh allows for two standard marks and a user mark.
      - Vectors and Planes
        At times, it is necessary to define a vector or plane for a command. HyperMesh allocates two vectors and two planes with the IDs 1 and 2. The vectors and planes can be defined at any time during the processing of a command file or Tcl script.
      - Data Names
        Data names are used to access data from the HyperWorks database. A data name is a string that represents a piece of data. They are basically generic references to the information that physically defines an entity in the HyperWorks environment.
      - Tcl/Tk
        Tcl (Tool Command Language), commonly pronounced "tickle", is a scripting language like Perl, JavaScript, Born, and Korn. Scripting languages are easy to use and learn because they have a syntax that is easy to read, are platform independent, and do not require compiling.
    - 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
  - 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.

Command Files

Command files can be used to create new command scripts that perform automation, or to recover previously performed steps.

While the application is open, it generates a Tcl file named command<#>.tcl on Windows, and command.tcl on Linux. This file is created at the start of a session if it does not exist. If the file already exists, the application adds the commands for the new session to the end of the original file.

Each time the application performs an operation that modifies something in the database, such as, create an entity, modify a value, import a model, and so on, the Tcl commands that are used to perform the operation, as well as any subsidiary commands, are written to the command file. These commands are known as HyperMesh Tcl Modify Command. As an example, if you are in the Delete panel and decide to delete all of the elements in the model, the commands written out are:

*createmark elements 1 "all"
*deletemark elements 1