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
hmmodlib Functions
Access Functions
HMMOD_elementgetactive()
Retrieves the activity status of an element.

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
      - hmmodlib Functions
        Access Functions
        HMMOD_elementgetactive()
        Retrieves the activity status of an element.
        HMMOD_elementgetcentroidalresult()
        Retrieves the centroidal result of an element specified by element pointer, layer, and index.
        HMMOD_elementgetconfig()
        Retrieves the configuration of an element specified by a pointer to that element.
        HMMOD_elementgetcounter()
        Retrieves the value stored in counter.
        HMMOD_elementgetid()
        Retrieves the ID of an element specified by the pointer to the element.
        HMMOD_elementgetintegrationpointresult()
        Retrieves the integration point result of an element specified by element pointer, integration point, layer and index.
        HMMOD_elementgetnodeonelementresult()
        Retrieves the node-on-element result of an element specified by element pointer, layer, node index, and index.
        HMMOD_elementgetnumberofintegrationpoints()
        Retrieves the number of integration points in an element specified by a pointer to that element.
        HMMOD_elementgetnumberofnodes()
        Retrieves the number of nodes associated with an element specified by a pointer to that element.
        HMMOD_elementgettype()
        Retrieves the type of an element specified by a pointer to that element.
        HMMOD_elementgetuservalue()
        Retrieves the user value of an element.
        HMMOD_elementgetvalue()
        Retrieves the value of an element specified by element pointer.
        HMMOD_nodegetactive()
        Retrieves the activity status of a node.
        HMMOD_nodegetcords()
        Retrieves the coordinates of a node.
        HMMOD_nodegetcounter()
        Retrieves the value stored in counter.
        HMMOD_nodegetdisplacement()
        Retrieves the displacement values of the node specified by the node pointer.
        HMMOD_nodegetid()
        Retrieves a node ID.
        HMMOD_nodegetresult()
        Retrieves the nodal result of the node specified by the node pointer, layer, and index.
        HMMOD_nodegetvalue()
        Retrieves the value associated with a node specified by the pointer to the node.
        Averaging Functions
        Comparison Functions
        Model Construction Functions
        Scanning Functions
        Storage Functions
        Transfer Functions
        Utility 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.

HMMOD_elementgetactive()

Retrieves the activity status of an element.

Syntax

int HMMOD_elementgetactive(void * elementptr);

Type

HyperMesh hmmodlib Function

Description

Retrieves the activity status of an element.

Inputs

elementptr: The pointer to an element.

Example

0, if the element is inactive.

1, if the element is active.

Errors

None.