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
Solver Templates
Solver templates are ASCII data files containing HyperMesh Template Language Commands and HyperMesh Template Language Functions.
Commands and Functions
Solver Template Commands
*format()
Indicates that the following commands should be executed on the format level.

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.
    - Card Previewer
      The HyperMesh Card Image panel is used to define solver specific data and review card information. The format of the cards and the menus in the panel are defined in the export template, using HyperMesh Card Preview Commands.
    - Create Solver Templates
    - Commands and Functions
      - Card Previewer Commands
      - Solver Template Commands
        *accelerometers()
        Starts an accelerometers block.
        *addblock()
        Adds a block to a link.
        *addcomment()
        Sets the characters of strings which are considered comment lines.
        *after()
        Indicates that the commands following are processed on the *after() level.
        *aftercollector()
        Indicates that the commands following are processed on the *aftercollector() level.
        *alefsiprojections()
        Starts an alefsiprojections block.
        *alereferencesystemcurves()
        Starts an alereferencesystemcurves block.
        *alereferencesystemgroups()
        Starts an alereferencesystemgroups block.
        *alereferencesystemnodes()
        Starts an alereferencesystemnodes block.
        *alereferencessystemswitches()
        Starts an alereferencessystemswitches block.
        *alesmoothings()
        Starts an alesmoothings block.
        *aletanktests()
        Starts an aletanktests block.
        *analysis()
        Starts an analysis block.
        *analysisparameters()
        Starts an analysis parameter block.
        *assemblies()
        Starts an assembly output block. All the assemblies in the HyperMesh database are output according to the user-defined format in this block.
        *attachmentcontrols()
        Starts an attachmentcontrols block.
        *attachments()
        Starts an attachments block.
        *axisymmetries()
        Starts an axisymmetries block.
        *bags()
        Starts a bag output block.
        *beamsectcols()
        Starts a beamsectcols block.
        *beamsects()
        Starts a beamsects block.
        *before()
        Indicates that the commands following are processed on the *before() level.
        *beforecollector()
        Indicates that the commands following are processed on the *before() collector level.
        *beginlink()
        Starts a link.
        *behaviors()
        Starts a behaviors block.
        *blocks()
        Starts a finite difference block output block. All the blocks in the HyperMesh database are output according to the user-defined format in this block.
        *bodies()
        Starts a bodies block.
        *boxes()
        Starts a boxes block.
        *cards()
        Starts a Control Card output block.
        *charts()
        Starts a charts block.
        *clearances()
        Starts a clearances block.
        *codename()
        Sets a unique solver number to be used for identifying attributes.
        *collections()
        Starts a collections block.
        *collisions()
        Starts a collisions block.
        *comments()
        Starts a comment block.
        *components()
        Starts a component block.
        *compressreal()
        Changes how real numbers are written to the output deck.
        *configurations()
        Starts a configurations block.
        *connectorsets()
        Starts a connectorsets block.
        *constrainedextranodes()
        Starts a constrainedextranodes block.
        *constrainedrigidbodies()
        Starts a constrainedrigidbodies block.
        *constraints()
        Starts a constraints block.
        *contactsurfs()
        Starts a contactsurfs block.
        *contactbehaviors()
        Starts a contactbehaviors block.
        *contactgroups()
        Starts a contactgroups block.
        *controlvols()
        Starts a control volume block.
        *counterinc()
        Increments a counter.
        *counterset()
        Sets the initial value of the global counter.
        *createmergedloadloadsteptable()
        Creates the table containing merged loads for a loadstep.
        *crosssections()
        Starts a crosssections block.
        *curves()
        Starts a curves block.
        *dampings()
        Starts a damping block.
        *define()
        Defines a dictionary item.
        *defineattribute()
        Defines an attribute for a solver.
        *defineentitytypealiasname()
        Defines an entity type alias name for a solver.
        *deletemassthicknesstable()
        Deletes the element mass/thickness table.
        *deletemergedloadloadsteptable()
        Deletes the table containing merged loads for a loadstep.
        *dequations()
        Starts a dequations output block.
        *designpointmethods()
        Starts a designpointmethod block.
        *designpoints()
        Starts a designpoint block.
        *designpointsets()
        Starts a designpointset block.
        *designvars()
        Starts a design variable output block.
        *desvarlinks()
        Starts a dlink output block.
        *directmatrixinputs()
        Starts a direct matrix input block.
        *dvprels()
        Starts a dvprel output block.
        *elementareacalculation()
        Determines how to calculate the area of an element.
        *elementbehaviors()
        Starts a elementbehaviors block.
        *elementclusters()
        Starts an elementclusters block.
        *elementresultstore()
        Stores an element value for the current element.
        *elements()
        Starts an element block.
        *else()
        Used to define false conditions for an *if() block.
        *enabledatabase()
        Used to scan for entities in the HyperMesh database.
        *encryptions()
        Starts an encryptions block.
        *end()
        *endif()
        Used to define the end of an *if() block.
        *endlink()
        Ends a link.
        *endloop()
        Indicates the end of a block that was initialized with the *loopif() command.
        *endsegments()
        Ends a segment block.
        *enginefiles()
        Starts an enginefile block.
        *entitypointerset()
        Sets the initial value of a specified entity.
        *equations()
        Starts an equation output block. The equations in the HyperMesh database with a type equal to the type argument are output according to the user-defined format in this block.
        *errormessage()
        Displays an error message on the menu bar.
        *executetclscript()
        Executes a Tcl script from within a template, and optionally calls a procedure defined in the script.
        *explorations()
        Starts an explorations block.
        *failures()
        Starts a failures block.
        *field()
        Places a formatted value from the database into the output file.
        *fieldleft()
        Places a left-justified, formatted value from the database into the output file.
        *fieldleftwithcomments()
        Places a left-justified, formatted field name and value from the database into the output file. The field name is written just above the value line.
        *fieldright()
        Places a right-justified, formatted value from the database into the output file.
        *fieldrightwithcomments()
        Places a right-justified, formatted field name and value from the database into the output file. The field name is written just above the value line.
        *fields()
        Starts a fields block.
        *fieldwithcomments()
        Places a formatted field name and value from the database into the output file. The field name is written just above the value line.
        *format()
        Indicates that the following commands should be executed on the format level.
        *freebodygroups()
        Starts a freebodygroup block.
        *freebodysections()
        Starts a freebodysection block.
        *frequencies()
        Starts a frequency block.
        *frequencysets()
        Starts a frequency set block.
        *frictions()
        Starts a friction block.
        *function()
        Starts a function block.
        *geometricrepresentations()
        Starts a geometricrepresentation block.
        *geometryoverride()
        Overrides the lines option on the Export Data panel and activates lines for output.
        *groups()
        Starts a group output block. The groups in the HyperMesh database whose configuration and type are equal to the parameters are output according to the user-defined format in this block.
        *hm_features()
        Starts a feature block.
        *hourglass()
        Starts an hourglass block.
        *if()
        Used to conditionally execute branches of code.
        *ignorecomment()
        Sets the characters of strings which are ignored as comment lines.
        *ignoreelemconfigtype()
        Sets the characters of strings which are ignored as comment lines.
        *include()
        Includes a file from the include directory.
        *includefiles()
        Starts an include file output block. The include file references in the HyperMesh database are output according to the user-defined format in this block.
        *initialstates()
        Starts an initialstates block.
        *integrationrules()
        Starts an integrationrules block.
        *interfacecomponents()
        Starts an interfacecomponents block.
        *interfacelinkings()
        Starts an interfacelinkings block.
        *internalsupports()
        Starts a internalsupports block.
        *joints()
        Starts a joints block.
        *laminates()
        Starts a laminate block.
        *legends()
        Starts a legends block.
        *lines()
        Starts a line output block. All of the lines in the database are output according to the user-defined format in the block following the *lines()command.
        *lists()
        Starts a lists block.
        *loadcols()
        Starts a load collector block.
        *loads()
        Starts a load output block. The loads in the HyperMesh database whose configuration is equal to the parameter configuration, and whose type is equal to the parameter type are output according to the user-defined format in this block.
        *loadsteps()
        Starts a loadsteps output block.
        *loopif()
        Conditionally executes a block of code while a condition is true.
        *markfailed()
        Marks an element as failed when used in the Check Elements panel (user subpanel).
        *materialbehaviors()
        Starts a materialbehaviors block.
        *materials()
        Starts a material block.
        *mechanismconstraints()
        Starts a mechanismconstraints block.
        *mechanisms()
        Starts a mechanisms block.
        *memberjoints()
        Starts a memberjoint block.
        *memberpanels()
        Starts a memberpanel block.
        *members()
        Starts a member block.
        *membersections()
        Starts a membersection block.
        *membersegments()
        Starts a membersegment block.
        *meshcontrols()
        Starts a meshcontrols block.
        *metadata()
        Starts a metadata output block. All of the metadata entries in the database are output according to the user-defined format in the block following the *metadata() command.
        *modelcheckchecks()
        Starts a model check checks block.
        *modelcheckcorrections()
        Starts a model check corrections block.
        *modelMOI()
        Computes the inertia tensor for the global model and store the results into a table.
        *modules()
        Starts a modules block.
        *nctlayers()
        Starts an nctlayers block.
        *nodes()
        Starts a node output block. All of the nodes in the database are output according to the user-defined format in the block following the *nodes() command.
        *noisecontroltreatments()
        Starts a noisecontroltreatments block.
        *objectives()
        Starts an objectives output block.
        *optiresponses()
        Starts an optiresponses output block.
        *output()
        Outputs the data defined in the preceding block.
        *outputblocks()
        Starts an outputblocks block.
        *outputparameterizeddata()
        Specifies whether to output in parameterized or unparameterized format.
        *outputrequests()
        Starts an outputrequests block.
        *panels()
        Starts a panels block.
        *parameters()
        Starts a parameters block.
        *partsets()
        Starts a partset block.
        *perturbations()
        Starts a perturbations block.
        *physicalquantites()
        Starts a physicalquantity block.
        *plies()
        Starts a ply block.
        *plotcontrols()
        Starts a plotcontrols block.
        *plots()
        Starts a plot output block. The plots in the HyperMesh database are output according to the user-defined format in this block.
        *pointerset()
        Sets the initial value of a pointer.
        *points()
        Starts a points output block.
        *polycages()
        Starts a polycage block.
        *populatemassthicknesstable()
        Populates the element mass/thickness table.
        *positions()
        Starts a positions block.
        *pretensioners()
        Starts a pretensioners block.
        *properties()
        Starts a property block.
        *quote()
        Writes a quotation (") character.
        *rangeadd()
        Add a number to a list so that ranges can be found with @rangecount(), @rangestart(), and @rangeadd().
        *rangereset()
        Resets the list of numbers stored with *rangeadd().
        *realprecision()
        Sets the number of significant figures after the decimal point for real numbers.
        *referencegeometries()
        Starts a reference geometry block.
        *regions()
        Starts a regions block.
        *registerparameterizeddataappendstring()
        Registers the string to be added before parameter names written in place of parameterized values.
        *registerparameterizeddataendstring()
        Registers the string to be added after parameter names written in place of parameterized values.
        *registersolvercommentsyntaxstring()
        Registers the string to be added in the beginning of the solver comment lines.
        *resources()
        Starts a resources block.
        *responses()
        Starts a responses block.
        *results()
        Starts a results block.
        *resultsimulations()
        Starts a resultsimulations block.
        *resultsubcases()
        Starts a resultsubcases block.
        *retractors()
        Starts a retractors block.
        *return()
        Ends a function block.
        *rigidbodies()
        Starts a rigidbodies block.
        *rigidwalls()
        Starts a rigid wall block.
        *scalefieldwidth()
        Scales the width of a field.
        *scenarios()
        Starts a scenarios block.
        *seamexcitations()
        Starts a seamexcitations block.
        *seamjunctions()
        Starts a seamjunctions block.
        *seamsubsystems()
        Starts a seamsubsystems block.
        *seasubsystems()
        Starts a seasubsystems block.
        *seatbeltcontrolpoints()
        Starts a seatbeltcontrolpoint block.
        *seatbelts()
        Starts a seatbelt block.
        *sections()
        Starts a section block.
        *segments()
        Starts a segment output block.
        *sensors()
        Starts a sensors block.
        *sequences()
        Starts a sequences block.
        *setcollector()
        Sets the current collector based on the last *pointerset() command. This is commonly used with loadsteps. You can also use this command with sets that contain components.
        *setcurrentbagentitytype()
        Sets the type of entity within a bag for which information is to be queried.
        *setettypeelemtypereference()
        Sets the element configuration corresponding to the ET type specified in the sensor card image.
        *setformattype()
        Sets the export format type for the LS-DYNA profile.
        *setidmanagerexcludedidpools()
        Defines list of ID pools not to be supported by ID Manager.
        *setidmanagersupportedentitytypes()
        Defines the list of entity types to be supported by ID Manager.
        *sets()
        Starts a set block.
        *setsolverusessegmentsets()
        Adds support for segment sets to a template.
        *shape3ds()
        Starts a shape3d block.
        *shapes()
        Starts a shape output block. All the shapes are output according to the user-defined format in this block.
        *skeletons()
        Starts a skeleton block.
        *sketches()
        Starts a sketch output block. All the sketches are output according to the user-defined format in this block.
        *sliprings()
        Starts a sliprings block.
        *smartrules()
        Starts a smartrules block.
        *solvermasses()
        Starts a solvermasses block.
        *solverrepresentations()
        Starts a solverrepresentation block.
        *solversettings()
        Starts a solversettings block.
        *solversubmodels()
        Starts a solversubmodels block.
        *sortelements()
        Sets the order that elements are output in an *elements() block.
        *sortentity()
        Changes the order that entities are output in the corresponding *entity() block.
        *sortloads()
        Changes the order that loads are output in the *loads() block.
        *sortloadsteps()
        Changes the order that loadsteps are output in a *loadsteps() block.
        *sortnodes()
        Sets the order that nodes are output in a *nodes() block.
        *sortsets()
        Sets the order that sets are output in a *sets() block.
        *specialidruletoignoreincomingids()
        Sets an ID pool to ignore incoming IDs for when there is an ID range defined.
        *stateequations()
        Starts a state equations block.
        *string()
        Outputs a string to the output file.
        *stringtablereset()
        Resets the string lookup table.
        *stringtablestore()
        Stores an entry into the string lookup table.
        *stringwithcomments()
        Outputs a string field name and string to the output file. The field name is written just above the string line.
        *structuralproperties()
        Starts a structuralproperty block.
        *studies()
        Starts a studies block.
        *subsystemconfigurations()
        Starts a subsystemconfigurations block.
        *subsystems()
        Starts a subsystems block.
        *subsystemsets()
        Starts a subsystemsets block.
        *surfaces()
        Starts a surface output block.
        *symmetrypivots()
        Starts a symmetrypivot block.
        *systcols()
        Starts a system collector output block.
        *systems()
        Starts a systems block.
        *tablenreset()
        Resets the nth lookup table.
        *tablenstore()
        Stores an entry in the nth lookup table.
        *tablereset()
        Resets the lookup table.
        *tables()
        Starts a tables block.
        *tablestore()
        Stores an entry in the lookup table.
        *terminations()
        Starts a termination block.
        *text()
        Starts a block that contains text.
        *timestepcontrols()
        Starts a timestepcontrol block.
        *titles()
        Starts a title output block.
        *transformations()
        Starts a transformations block.
        *uservariableset()
        Sets a user variable to a specific value.
        *variableset()
        Sets a variable to a specific value.
        *vectorcols()
        Starts a vector collector output block.
        *vectors()
        Starts a vectors block.
        *vectortablereset()
        Resets the vector lookup table.
        *vectortablestore()
        Stores an entry into the vector lookup table.
        *weldlines()
        Starts a weldline block.
        *writegeometry()
        Outputs the Altair geometry database in an internal ASCII format.
        *writenamedbuffer()
        Copies the content from an include file to the current output file.
        Deprecated Solver Template Commands
        The list of deprecated solver template commands, and the new commands to use.
        Undocumented Solver Template Commands
        The list of undocumented solver template commands.
      - Solver Template 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.

*format()

Indicates that the following commands should be executed on the format level.

Syntax

*format ()

Type

HyperMesh Template Command