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
Data Names
Details on the core data that can be queried and manipulated.
solverrepresentations

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.
  - 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

solverrepresentations

Unless otherwise specified, data names are accessible in level 3 only.

_baseFlags: The base flag of the entity.; Type: unsigned integer
_subType: The sub type of the entity.; Type: string
activesuppressed: Returns non-zero if the entity is set inactive, 0 otherwise.; Type: integer
attributesmax: The number of attributes owned by this entity.; Type: unsigned integer
color: The 1-64 color of the entity.; Type: integer
color_rgb: The RGB color of the entity.; Type: string
config: The configuration of the entity.; 1 - 1D Mesh; 2 - 2D Mesh; 3 - Connections; Type: unsigned integer
definedentity: True if the entity is defined, false otherwise.; Type: Boolean
entitylist: The list of entities containing the realized entities.; Type: entity array
id: The ID of the entity.; Type: unsigned integer
include: The ID of the include file the entity is organized in.; Type: entity
includeid: The ID of the include file the entity is organized in.; Type: unsigned integer
internalid: The ID of the entity.; Type: unsigned integer
internalname: The internal name of the entity.; Type: string
jointlegentitylist: The entity associated with each leg of the member joint.; Type: entity array
jointlegentitytable: A tabular attribute that defines the jointlegentitylist.; Type: tabular
meshcontrol: The mesh control ID containing the meshing parameters for realization.; Type: entity
moduleid: The module ID of the entity.; Type: integer
name: The name of the entity.; Type: string
outputsuppressed: Returns non-zero if the entity is set "do not export", 0 otherwise.; Type: integer
poolid: The pool number of the entity.; Type: integer
poolname: The pool name of the entity.; Type: string
solver_id: The solver ID of the entity.; Type: integer
solverkeyword: The name of the solver keyword.; Type: string
solvername: The solver name of the entity for entities enabled for name pool, otherwise the internal name of the entity.; Type: string
symmetryid: The ID of the symmetry plane.; Type: entity

Version History

2022