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
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.
Commands and Functions
Ext API Structures
HM_FaceLoop
Contains information about individual face loops in the topology of mesh areas defined by the HM_Topology structure.

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.
    - Header Files
    - Library Files
    - Running
    - Examples
    - Commands and Functions
      - Ext API Functions
      - Ext API Structures
        HM_BatchMeshParamSet
        Contains a pair of paths to batch mesh parameter and criteria files used by HM_ExtAPI::GenerateMesh.
        HM_Component
        Contains information about an individual component in the topology of mesh areas defined by the HM_Topology structure.
        HM_Edge
        Contains information about an individual edge in the topology of mesh areas defined by the HM_Topology structure.
        HM_Face
        Contains information about an individual face in the topology of mesh areas defined by the HM_Topology structure.
        HM_FaceLoop
        Contains information about individual face loops in the topology of mesh areas defined by the HM_Topology structure.
        HM_GenerateMeshParamStruct
        Contains information that is used by the HM_ExtAPI::GenerateMesh() function to set meshing parameters in interactive and batch meshing modes.
        HM_ImportModelParamStruct
        Contains information that is used by the HM_ExtAPI::ImportModel() function to set import parameters.
        HM_OffsetParamStruct
        Contains information that is used by the HM_ExtAPI::OffsetFaces() and HM_ExtAPI::OffsetShellsByFaces() functions to set offset parameters and return offset results.
        HM_Point
        Contains information about a point in three-dimensional space.
        HM_PolyLine
        Contains information about the geometry of a line represented by approximation points.
        HM_Topology
        Contains information about mesh area topologies that includes a set of faces, edges and vertices and topological relations between them.
        HM_Transform
        Contains information about a transformation between different coordinate systems.
        HM_Vertex
        Contains information about an individual vertex in the topology of mesh areas defined by the HM_Topology structure.
      - Ext API Types
  - 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.
  - 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 HyperWorks Help

HM_FaceLoop

Contains information about individual face loops in the topology of mesh areas defined by the HM_Topology structure.

Syntax

struct HM_FaceLoop {
int size;
int num_edges;
int* edges;
bool* edge_dirs;
};

Type

HyperMesh Ext API Function

Description

This structure contains information about individual face loops in the topology of mesh areas defined by the HM_Topology structure.

Each face in the set of mesh areas specified by the HM_Topology structure is assumed to have two sides. Of those two sides, the upper side is defined in such a way that in the view from above the face area is located on the left side from each of its loops.

Figure 1.

Different loops of the same face must have consistent directions. Inconsistent directions may result in a failure to resolve topology mapping to actual geometry of the model.

The structure information is declared in hm_extapi.h.

The members are: size, num_edges, edges, edge_dirs

Inputs

size: Specifies the length, in bytes, of the structure. Use sizeof(HM_FaceLoop) for this member. This is used to distinguish the current version of HM_FaceLoop from possible future extended versions with additional members.
num_edges: The number of edge occurrences in the face loop specified by this HM_FaceLoop structure Each edge occurrence is defined by a reference to an edge included into an array pointed to by the edges member of the HM_Topology structure, and by the direction of this edge with the respect to the loop direction.
edges: Pointer to an array of edge references. The number of values in the array must not be smaller than the value specified by the num_edges member of this HM_FaceLoop structure.; Each number in the array pointed to by edges represents a zero-based index in the array of the HM_Edge structures pointed to by the edges member of the HM_Topology structure that contains this HM_FaceLoop structure in its loops array.
edge_dirs: Pointer to an array of flags specifying the direction of each edge within the loop. The number of values in the array must not be smaller than the value specified by the num_edges member of this HM_FaceLoop structure.; A value of true indicates that the direction of the edge referenced by the corresponding edge occurrence coincides with the direction of the loop. A value of false indicates that the direction of the loop is opposite to the direction of the loop.

Errors

None.