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
FE Input Readers
FE input readers are C programs that read information from ASCII or binary finite element models files into the HyperMesh database.
Commands and Functions
hmlib Functions
Miscellaneous Functions
HM_tablelookup()
Retrieves a previously stored value.

Welcome
What's New
View new features for version 2025.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.
    - Result Readers
    - hmlib
      hmlib is a library which contains a set of routines to aid you in writing a C program.
    - hminlib
      hminlib is a set of routines which allows you to write an external input translator.
    - hmmodlib
      hmmodlib is a library of C routines which allows you to perform results translation of more complex data types, such as integration point results or node-on-element results.
    - hmreslib
    - Create FE Input Readers
    - Commands and Functions
      - hmlib Functions
        ASCII File Functions
        Dynamic Block Functions
        Meshing Allocation Functions
        Miscellaneous Functions
        HM_elementconfiggetnumberofnodes()
        For an element configuration, this function returns the number of nodes that the element uses. For rigidlinks and RBE3s, this function returns 0 because these elements have a variable number of nodes.
        HM_entitynamegettype()
        Returns the HyperMesh #defined type number of an entity, given its name.
        HM_entitytypegetname()
        Returns the name of an entity, given the HyperMesh #defined type number.
        HM_entitystringtypegettype()
        Returns the HyperMesh #defined type number of an entity, given its #defined name.
        HM_entitytypegettypestring()
        Returns the string associated with the HyperMesh #defined entity, given the type number.
        HM_fread()
        Reads information from a binary file.
        HM_fwrite()
        Writes information to a binary file.
        HM_getmachinesizeofdouble()
        Writes information to a binary file.
        HM_getmachinesizeoffloat()
        Gets the hardware size of a float.
        HM_getmachinesizeofint()
        Gets the hardware size of an integer.
        HM_getmachinetype()
        Identifies the type of machine on which the program is currently running.
        HM_message()
        Prints a message on the screen.
        HM_ping_translator()
        Tracks the version number of the translator.
        HM_setterminatefunction()
        Sets a pointer to a function that is called by HM_terminate().
        HM_tableadd()
        Adds an item to the table.
        HM_tableclear()
        Clears the table of all stored items.
        HM_tablelookup()
        Retrieves a previously stored value.
        HM_terminate()
        Terminates a program.
        String Functions
        Vector Functions
      - hminlib Functions
      - hmmodlib Functions
      - hmreslib Functions
  - 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.
  - 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.

HM_tablelookup()

Retrieves a previously stored value.

Syntax

double HM_tablelookup(int key);

Type

HyperMesh hmlib Function

Description

Retrieves a previously stored value.

Inputs

key: The key associated with a stored value.

Example

See HM_tableadd() and HM_tableclear().

Errors

None.