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
HMASCII
Details on the HMASCII format and associated commands.
Commands and Functions
*initialstates()
Creates an initialstate in HMASCII format.

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.
    - Input Format
    - Output Format
    - Commands and Functions
      - *acceleration()
      - *accelerometers()
        Creates an accelerometer in HMASCII format.
      - *alefsiprojections()
        Creates an alefsiprojection in HMASCII format.
      - *alereferencesystemcurves()
        Creates an alereferencesystemcurve in HMASCII format.
      - *alereferencesystemgroups()
        Creates an alereferencesystemgroup in HMASCII format.
      - *alereferencesystemnodes()
        Creates an alereferencesystemnode in HMASCII format.
      - *alereferencesystemswitches()
        Creates an alereferencesystemswitch in HMASCII format.
      - *alesmoothings()
        Creates an alesmoothing in HMASCII format.
      - *aletanktests()
        Creates an aletanktest in HMASCII format.
      - *altline()
      - *altpoint()
      - *altsurface()
      - *analysis()
        Creates an analysis in HMASCII format.
      - *analysisparameters()
        Creates an analysis parameter in HMASCII format.
      - *assembly()
      - *assemblycomponent()
      - *attachmentcontrols()
        Creates an attachmentcontrol in HMASCII format.
      - *attachments()
        Creates an attachment in HMASCII format.
      - *attributedouble()
      - *attributedoublearray()
      - *attributedoublearray2d()
      - *attributeentity()
      - *attributeentityarray()
      - *attributeentityarray2d()
      - *attributeint()
      - *attributeintarray()
      - *attributeintarray2d()
      - *attributesforentity()
      - *attributesolverid()
      - *attributestring()
      - *attributestringarray()
      - *axisymmetries()
        Creates an axisymmetry in HMASCII format.
      - *bar2()
      - *bar3()
      - *begingeometry()
      - *behaviors()
        Creates a behavior in HMASCII format.
      - *block()
      - *blockcell()
      - *blockidiv()
      - *blockjdiv()
      - *blockkdiv()
      - *blockwall()
      - *bodies()
        Creates a body in HMASCII format.
      - *boxes()
        Creates a box in HMASCII format.
      - *charts()
        Creates a chart in HMASCII format.
      - *clearances()
        Creates a clearance in HMASCII format.
      - *collections()
        Creates a collection in HMASCII format.
      - *collisions()
        Creates a collision in HMASCII format.
      - *comments()
        Creates a comment in HMASCII format.
      - *component()
        Creates a component in HMASCII format.
      - *configurations()
        Creates a configuration in HMASCII format.
      - *connectorsets()
        Creates a connectorset in HMASCII format.
      - *constrainedextranodes()
        Creates a constrainedextranode in HMASCII format.
      - *constrainedrigidbodies()
        Creates a constrainedrigidbody in HMASCII format.
      - *constraint()
      - *constraints()
        Creates a mechanism constraint in HMASCII format.
      - *contactbehaviors()
        Creates a contactbehavior in HMASCII format.
      - *contactgroups()
        Creates a contactgroup in HMASCII format.
      - *contactsurfelement()
      - *contactsurfs()
        Starts a contactsurfs block.
      - *controlcard()
        Creates a control card in HMASCII format.
      - *controlvols()
        Starts a control volume block.
      - *controlvols_elemid()
      - *controlvols_refnode()
      - *crosssections()
        Creates a crosssection in HMASCII format.
      - *curve()
      - *curvepoint()
      - *dampings()
        Creates a damping in HMASCII format.
      - *dependentnodes()
      - *designpointmethods()
        Creates a designpointmethod in HMASCII format.
      - *designpoints()
        Creates a designpoint in HMASCII format.
      - *designpointsets()
        Creates a designpointset in HMASCII format.
      - *dictionary()
      - *directmatrixinputs()
        Creates a direct matrix input in HMASCII format.
      - *elementbehaviors()
        Creates an element behavior in HMASCII format.
      - *elementclusters()
        Creates an elementcluster in HMASCII format.
      - *encryptions()
        Creates a encryption in HMASCII format.
      - *endgeometry()
      - *enginefiles()
        Creates an enginefile in HMASCII format.
      - *equation()
        Defines an equation load in HMASCII format.
      - *explorations()
        Creates an exploration in HMASCII format.
      - *failures()
        Creates a failure in HMASCII format.
      - *fields()
        Creates a field in HMASCII format.
      - *flux()
        Creates a flux load in HMASCII format.
      - *force()
      - *freebodygroups()
        Creates a freebodygroup in HMASCII format.
      - *freebodysections()
        Creates a freebodysection in HMASCII format.
      - *frequencies()
        Creates a frequency in HMASCII format.
      - *frequencysets()
        Creates a frequencyset in HMASCII format.
      - *frictions()
        Creates a friction in HMASCII format.
      - *gap()
        Creates a gap element in HMASCII format.
      - *geometricrepresentations()
        Creates a geometricrepresentation in HMASCII format.
      - *group()
      - *groupcomponentmain()
      - *groupcomponentsecondary()
      - *groupmainbox()
      - *groupmainset()
      - *groupsecondarybox()
      - *groupsecondaryset()
      - *hexa20()
        Creates a hexa20 element in HMASCII format.
      - *hexa8()
        Creates a hexa8 element in HMASCII format.
      - *hm_features()
        Creates a feature in HMASCII format.
      - *hourglass()
        Creates an hourglass in HMASCII format.
      - *ice()
        Creates an IC element in HMASCII format.
      - *icelink()
        Defines the independent nodes for an IC element in HMASCII format.
      - *icoeffs()
        Defines the independent nodes DOF coefficients for an equation load.
      - *idofs()
        Defines the independent nodes degrees of freedom for an equation load.
      - *independentcoeffs()
      - *independentdofs()
      - *independentnodes()
      - *inodes()
        Defines the independent nodes for an equation load.
      - *integrationrules()
        Creates integrationrules in HMASCII format.
      - *interfacecomponents()
        Creates an interfacecomponent in HMASCII format.
      - *interfacelinkings()
        Creates an interfacelinking in HMASCII format.
      - *interfacepairlist()
        Defines the interface pairs for a sub-laminate laminate.
      - *interfacepairmax()
        Defines the number of interface pairs assigned to a sub-laminate laminate.
      - *internalsupports()
        Creates an internalsupport in HMASCII format.
      - *initialstates()
        Creates an initialstate in HMASCII format.
      - *joint_cylindrical()
      - *joint_locking()
      - *joint_planar()
      - *joint_revolute()
      - *joint_spherical()
      - *joint_translational()
      - *joint_universal()
      - *joints()
        Creates a mechanism joint in HMASCII format.
      - *laminateidlist()
        Defines the plies or sub-laminates assigned to a ply laminate or sub-laminate laminate.
      - *laminateidlistmax()
        Defines the number of plies or sub-laminates assigned to a ply laminate or sub-laminate laminate.
      - *laminates()
        Creates a laminate in HMASCII format.
      - *legends()
        Creates a legend in HMASCII format.
      - *lists()
        Creates a list in HMASCII format.
      - *loadcollector()
        Creates a load collector in HMASCII format.
      - *loadstepgroupsid()
      - *loadstepid()
      - *loadstepobid()
      - *loadsteps()
        Starts a loadsteps output block.
      - *main3()
        Creates a main3 element in HMASCII format.
      - *main4()
        Creates a main4 element in HMASCII format.
      - *mass()
        Creates a mass element in HMASCII format.
      - *material()
        Creates a material in HMASCII format.
      - *materialbehaviors()
        Creates a material behavior in HMASCII format.
      - *mechanismconstraints()
        Creates a mechanism constraint in HMASCII format.
      - *mechanisms()
        Creates a mechanism in HMASCII format.
      - *memberjoints()
        Creates a memberjoint in HMASCII format.
      - *memberpanels()
        Creates a memberpanel in HMASCII format.
      - *members()
        Creates a member in HMASCII format.
      - *membersections()
        Creates a membersection in HMASCII format.
      - *membersegments()
        Creates a membersegment in HMASCII format.
      - *meshcontrols()
        Creates a meshcontrol in HMASCII format.
      - *metadata_date()
        Creates date metadata in HMASCII format.
      - *metadata_double()
        Creates double metadata in HMASCII format.
      - *metadata_double_array()
        Creates double array metadata in HMASCII format.
      - *metadata_entityid()
        Creates entity ID metadata in HMASCII format.
      - *metadata_entityid_array()
        Creates entity ID array metadata in HMASCII format.
      - *metadata_integer()
        Creates integer metadata in HMASCII format.
      - *metadata_integer_array()
        Creates integer array metadata in HMASCII format.
      - *metadata_string()
        Creates string metadata in HMASCII format.
      - *metadata_string_array()
        Creates string array metadata in HMASCII format.
      - *modelcheckchecks()
        Creates a model check check in HMASCII format.
      - *modelcheckcorrections()
        Creates a model check correction in HMASCII format.
      - *moment()
      - *nctlayers()
        Creates an nctlayer in HMASCII format.
      - *node()
      - *noisecontroltreatments()
        Creates a noisecontroltreatment in HMASCII format.
      - *outputblockid()
      - *outputblocks()
      - *outputrequests()
        Creates an outputrequest in HMASCII format.
      - *panels()
        Creates a panel in HMASCII format.
      - *parameters()
        Creates a parameter in HMASCII format.
      - *partsets()
        Creates a partset in HMASCII format.
      - *penta15()
        Creates a penta15 element in HMASCII format.
      - *penta6()
        Creates a penta6 element in HMASCII format.
      - *perturbations()
        Creates perturbations in HMASCII format.
      - *physicalquantities()
        Creates a physicalquantity in HMASCII format.
      - *plies()
        Creates a ply in HMASCII format.
      - *plot()
        Creates a plot in HMASCII format.
      - *plotaxis()
      - *plotborder()
      - *plotbounds()
      - *plotcontrols()
        Creates plotcontrols in HMASCII format.
      - *plotcurve()
      - *plotel()
        Creates a plotel element in HMASCII format.
      - *plotgrid()
      - *plotlabel()
      - *plotlabels()
      - *plotlegend()
      - *plotmode()
      - *plotsubtitle()
      - *plottitle()
      - *plyidlist()
        Defines the entities assigned to a ply.
      - *plyidlistmax()
        Defines the number of entities assigned to a ply.
      - *polycages()
        Creates a polycage in HMASCII format.
      - *positions()
        Creates a position in HMASCII format.
      - *pressure()
      - *pretensioners()
        Creates a pretensioner in HMASCII format.
      - *property()
        Creates a property in HMASCII format.
      - *pyramid13()
        Creates a pyramid13 element in HMASCII format.
      - *pyramid5()
        Creates a pyramid5 element in HMASCII format.
      - *quad4()
        Creates a quad4 element in HMASCII format.
      - *quad8()
        Creates a quad8 element in HMASCII format.
      - *rbe3()
        Creates an RBE3 element in HMASCII format.
      - *referencegeometries()
        Creates a reference geometry in HMASCII format.
      - *regions()
        Creates a region in HMASCII format.
      - *resources()
        Creates resources in HMASCII format.
      - *responses()
        Creates a response in HMASCII format.
      - *results()
        Creates a result in HMASCII format.
      - *resultsimulations()
        Creates resultsimulations in HMASCII format.
      - *resultsubcases()
        Creates resultsubcases in HMASCII format.
      - *retractors()
        Creates a retractor in HMASCII format.
      - *rigid()
        Creates a rigid element in HMASCII format.
      - *rigidbodies()
        Creates a rigidbody in HMASCII format.
      - *rigidlink()
        Creates a rigidlink element in HMASCII format.
      - *rigidwall()
        Creates a rigid wall group in HMASCII format.
      - *rigidwallgeometry()
        Adds geometry to a rigid wall group in HMASCII format.
      - *rigidwallmotion()
      - *rigidwalls()
        Creates a rigidwall in HMASCII format.
      - *rod()
        Creates a rod element in HMASCII format.
      - *scenarios()
        Creates a scenario in HMASCII format.
      - *seamexcitations()
        Creates a seamexcitation in HMASCII format.
      - *seamjunctions()
        Creates a seamjunction in HMASCII format.
      - *seamsubsystems()
        Creates a seamsubsystem in HMASCII format.
      - *seasubsystems()
        Creates a seasubsystem in HMASCII format.
      - *seatbeltcontrolpoints()
        Creates a seatbeltcontrolpoint in HMASCII format.
      - *seatbelts()
        Creates a seatbelt in HMASCII format.
      - *secondary1()
        Creates a secondary1 element in HMASCII format.
      - *secondary3()
        Creates a secondary3 element in HMASCII format.
      - *secondary4()
        Creates a secondary4 element in HMASCII format.
      - *sections()
      - *sequences()
        Creates a sequence in HMASCII format.
      - *set()
        Creates a set in HMASCII format.
      - *setid()
        Adds entities to a set in HMASCII format.
      - *setrigidlink()
      - *shape3ds()
        Creates a shape3d in HMASCII format.
      - *skeletons()
        Creates a skeleton in HMASCII format.
      - *sketches()
        Creates a sketch in HMASCII format.
      - *sliprings()
        Creates a slipring in HMASCII format.
      - *smartrules()
        Creates a smartrule in HMASCII format.
      - *solvermasses()
        Creates a solvermass in HMASCII format.
      - *solverrepresentations()
        Creates a solverrepresentation in HMASCII format.
      - *solversettings()
        Creates a solversetting in HMASCII format.
      - *solversubmodels()
        Creates a solver submodel in HMASCII format.
      - *spring()
        Creates a spring element in HMASCII format.
      - *spring3()
        Creates a spring3 element in HMASCII format.
      - *spring4()
        Creates a spring4 element in HMASCII format.
      - *stateequations()
        Creates a state equation in HMASCII format.
      - *structuralproperties()
        Creates a structuralproperty in HMASCII format.
      - *studies()
        Creates a study in HMASCII format.
      - *subsystemconfigurations()
        Creates a subsystemconfiguration in HMASCII format.
      - *subsystems()
        Creates a subsystem in HMASCII format.
      - *subsystemsets()
        Creates a subsystemset in HMASCII format.
      - *symmetrypivots()
        Creates a symmetrypivot in HMASCII format.
      - *system()
        Creates a system in HMASCII format.
      - *systemcollector()
        Creates a system collector in HMASCII format.
      - *tablecolumnend()
        Ends the data definition of a column in a table in HMASCII format.
      - *tablecolumnlabels()
        Defines the column labels of a table in HMASCII format.
      - *tablecolumnstart()
        Starts the data definition of a column in a table in HMASCII format.
      - *tablecolumntypes()
        Defines the column types of a table in HMASCII format.
      - *tablecolumnvalues()
        Sets the value of a cell in a table in HMASCII format.
      - *tables()
        Starts a tables block.
      - *tables_end()
        Ends a table in HMASCII format.
      - *tag()
        Creates a tag in HMASCII format.
      - *tagdescription()
        Assigns a text description to a tag in HMASCII format.
      - *temperature()
      - *terminations()
        Creates a termination in HMASCII format.
      - *tetra10()
        Creates a tetra10 element in HMASCII format.
      - *tetra4()
        Creates a tetra4 element in HMASCII format.
      - *timestepcontrols()
        Creates a timestepcontrol in HMASCII format.
      - *title()
      - *titleanchor()
      - *titleborder()
      - *transformations()
        Creates a transformation in HMASCII format.
      - *tria3()
        Creates a tria3 element in HMASCII format.
      - *tria6()
        Creates a tria6 element in HMASCII format.
      - *valuesforentity()
        Defines a data names block for new-style HyperMesh entities in HMASCII format.
      - *vectorcollector()
        Creates a vector collector in HMASCII format.
      - *vectorentity()
      - *velocity()
      - *weld()
        Creates a weld element in HMASCII format.
      - *weldlines()
        Creates a weldline in HMASCII format.
      - *xelem()
        Creates an xelem element in HMASCII format.
      - Deprecated HMASCII Commands
      - Undocumented HMASCII 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.

*initialstates()

Creates an initialstate in HMASCII format.

Syntax

*initialstates (id,name,color)

Type

HyperMesh HMASCII Command

Description

Creates an initialstate in HMASCII format.

Additional attribute or dataname information is provided separately, see referenced commands.

Inputs

id: The ID of the initialstate.
name: The name of the initialstate.
color: The color of the initialstate. Valid values are 1-64.

Example

To create an initialstate with ID 100, name "my-entity", and color 1:

*initialstates(100,"my-entity",1)

Errors

Incorrect usage results in an import error.

Version History

2023