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
hminlib Functions
Transfer Functions
elements
HMIN_element_writegap()
Writes a gap element to HyperMesh.

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
      - hminlib Functions
        Basic Functions
        File Locator Functions
        ID Functions
        Message Functions
        Move Functions
        Rename Functions
        Transfer Functions
        assemblies
        attributes
        bags
        blocks
        cards
        components
        connectors
        contactsurfs
        controlvols
        curves
        dequations
        designvars
        desvarlinks
        dictionaries
        dvprels
        elements
        
        HMIN_element_getnodesfromconfig()
        Determines the number of nodes associated with the configuration of the element.
        HMIN_element_solver_writebar_vector()
        Writes a 2-noded bar with property idpool to HyperMesh using a vector to define the bar local x axis.
        HMIN_element_solver_writebar_ynode()
        Writes a 2-noded bar element with property idpool to HyperMesh using a node to define the local bar y axis.
        HMIN_element_solver_writebar_znode()
        Writes a bar element with property idpool to HyperMesh using a node to define the local bar z axis.
        HMIN_element_solver_writebar3_vector()
        Writes a 3-noded bar with property idpool to HyperMesh using a vector to define the bar local x axis.
        HMIN_element_solver_writebar3_ynode()
        Writes a 3-noded bar element with property idpool to HyperMesh using a node to define the local bar y axis.
        HMIN_element_solver_writebar3_znode()
        Writes a bar element with property idpool to HyperMesh using a node to define the local bar z axis.
        HMIN_element_solver_writegap()
        Writes a gap element with property idpool to HyperMesh.
        HMIN_element_solver_writejoint()
        Writes a joint element with property idpool to HyperMesh.
        HMIN_element_solver_writemass()
        Writes a mass element with property idpool to the HyperMesh database.
        HMIN_element_solver_writerod()
        Writes a rod element with property idpool to HyperMesh.
        HMIN_element_solver_writespring()
        Writes a rod element with property idpool to HyperMesh.
        HMIN_element_writebar_vector()
        Writes a 2-noded bar to HyperMesh using a vector to define the bar local x axis.
        HMIN_element_writebar_ynode()
        Writes a 2-noded bar element to HyperMesh using a node to define the local bar y axis.
        HMIN_element_writebar_znode()
        Writes a bar element to HyperMesh using a node to define the local bar z axis.
        HMIN_element_writebar3_vector()
        Writes a 3-noded bar to HyperMesh using a vector to define the bar local x axis.
        HMIN_element_writebar3_ynode()
        Writes a 3-noded bar element to HyperMesh using a node to define the local bar y axis.
        HMIN_element_writebar3_znode()
        Writes a bar element to HyperMesh using a node to define the local bar z axis.
        HMIN_element_writegap()
        Writes a gap element to HyperMesh.
        HMIN_element_writegroup_shellid()
        Creates a main or secondary element from an existing element in HyperMesh.
        HMIN_element_writegroup_solidid()
        Creates a main or secondary element from an existing element in HyperMesh.
        HMIN_element_writehex8()
        Writes an eight-noded brick solid element to HyperMesh.
        HMIN_element_writehex20()
        Writes a twenty-noded brick solid element to HyperMesh.
        HMIN_element_writejoint()
        Writes a joint element to HyperMesh.
        HMIN_element_writemain3()
        Writes a three-noded main interface element to HyperMesh.
        HMIN_element_writemain4()
        Writes a four-noded main interface element to HyperMesh.
        HMIN_element_writemass()
        Writes a mass element to the HyperMesh database.
        HMIN_element_writepenta5()
        Writes a five-noded solid pyramid element to HyperMesh.
        HMIN_element_writepenta6()
        Writes a six-noded wedge solid element to HyperMesh.
        HMIN_element_writepenta13()
        Writes a thirteen-noded, second order solid pyramid element to HyperMesh.
        HMIN_element_writepenta15()
        Writes a fifteen-noded wedge solid element to HyperMesh.
        HMIN_element_writeplot()
        Writes a plot element to HyperMesh.
        HMIN_element_writequad4()
        Writes a four-noded quadrilateral shell element to HyperMesh.
        HMIN_element_writequad8()
        Writes an eight-noded quadrilateral shell element to HyperMesh.
        HMIN_element_writerbe3()
        Writes an RBE3 element to HyperMesh.
        HMIN_element_writerbe3header()
        Writes an RBE3 element header to HyperMesh.
        HMIN_element_writerbe3node()
        Writes the nodes that define the RBE3 element to HyperMesh.
        HMIN_element_writerigid()
        Writes a rigid element to HyperMesh.
        HMIN_element_writerigidlink()
        Writes a rigid link element to HyperMesh.
        HMIN_element_writerigidlinkheader()
        Writes a rigid link header to HyperMesh.
        HMIN_element_writerigidlinknode()
        Writes the nodes that define the rigid link to HyperMesh.
        HMIN_element_writerod()
        Writes a rod element to HyperMesh.
        HMIN_element_writesecondary_face()
        Creates a secondary element from an existing element in HyperMesh.
        HMIN_element_writesecondary1()
        Writes a one-noded secondary interface element to HyperMesh.
        HMIN_element_writesecondary3()
        Writes a three-noded secondary interface element to HyperMesh.
        HMIN_element_writesecondary4()
        Writes a four-noded secondary interface element to HyperMesh.
        HMIN_element_writespring()
        Writes a spring element to HyperMesh.
        HMIN_element_writetetra4()
        Writes a four-noded tetrahedral solid element to HyperMesh.
        HMIN_element_writetetra10()
        Writes a ten-noded tetrahedral solid element to HyperMesh.
        HMIN_element_writetria3()
        Writes a three-noded triangular shell element to HyperMesh.
        HMIN_element_writetria6()
        Writes a six-noded triangular shell element to HyperMesh.
        HMIN_element_writeweld()
        Writes a weld element to HyperMesh.
        equations
        groups
        laminates
        lines
        loadcols
        loads
        loadsteps
        materials
        metadata
        miscellaneous
        nodes
        objectives
        opticonstraints
        opticontrols
        optidscreens
        optiresponses
        outputblocks
        plies
        plots
        properties
        sensors
        sets
        surfaces
        systemcols
        systems
        tables
        tags
        titles
        vectorcols
        vectors
        Deprecated hminlib Functions
        The list of deprecated hminlib functions, and the new functions to use.
        Undocumented hminlib Functions
        The list of undocumented 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.

HMIN_element_writegap()

Writes a gap element to HyperMesh.

Syntax

void HMIN_element_writegap(HM_entityidtype id, char elementtype, HM_entityidtype propertyid, HM_entityidtype nodes[], int collectorid, HM_entityidtype vectorid);

Type

HyperMesh hminlib Function

Description

Writes a gap element to HyperMesh.

Inputs

id: The ID of the element.
elementtype: The type of the element, a user-defined value.
propertyid: The ID of the property to which the gap element should point.
nodes[2]: The nodes associated with the element.
collectorid: The ID of the collector where the gap element should be placed.
vectorid: The ID of the vector associated with the element.

Errors

None.