HyperMesh Reference Guide
Table of Contents
API Programmer's Guides
2017 API Programmer's Guide
14.0 API Programmer's Guide
13.0 API Programmer's Guide
12.0 API Programmer's Guide
11.0 API Programmer's Guide
10.0 API Programmer's Guide
9.0 API Programmer's Guide
Data Names
accelerometers
assemblies
bags
beamsectcols
beamsects
blocks
bodies
boxes
cards
collections
components
configurations
connectors
constrainedextranodes
constrainedrigidbodies
constraints
contactsurfs
controlvols
crosssections
curves
ddvals
dequations
designvars
desvarlinks
directmatrixinputs
dobjrefs
domains
dvprels
elements
ellipsoids
encryptions
equations
features
fields
global
groups
handles
includefiles
joints
laminates
lines
loadcols
loads
loadsteps
materials
mbjoints
mbplanes
mechanisms
meshcontrols
metadata
modules
morphconstraints
morphvolumes
multibodies
nodes
objectives
opticonstraints
opticontrols
optidscreens
optiresponses
outputblocks
parameters
plies
plots
points
positions
properties
regions
rigidwalls
sensors
sets
shapes
solids
surfaces
symmetries
systemcols
systems
tables
tags
titles
transformations
vectorcols
vectors
Ext API
Header Files
Library Files
Running
Examples
Commands and Functions
FE Input Readers
Result Readers
hmlib
hminlib
hmmodlib
hmreslib
Creating FE Input Readers
Commands and Functions
HMASCII
Input Format
Output Format
Commands and Functions
Model Checker
Config File
Checks and Corrections
Scripts
Introduction
Creating Scripts
Running Scripts
Commands and Functions
Solver Templates
Card Previewer
Creating Solver Templates
Commands and Functions
Index
Search
Home
Table of Contents
Solver Templates
Commands and Functions
Solver Template Commands
Table of Contents
API Programmer's Guides
Data Names
Ext API
FE Input Readers
HMASCII
Model Checker
Scripts
Solver Templates
Card Previewer
Creating Solver Templates
Commands and Functions
Card Previewer Commands
Solver Template Commands
*accelerometers()
*addblock()
*addcomment()
*after()
*aftercollector()
*assemblies()
*bags()
*beamsectcols()
*beamsects()
*before()
*beforecollector()
*beginlink()
*blocks()
*bodies()
*boxes()
*cards()
*codename()
*collections()
*components()
*compressreal()
*configurations()
*constrainedextranodes()
*constrainedrigidbodies()
*constraints()
*contactsurfs()
*controlvols()
*counterinc()
*counterset()
*createmergedloadloadsteptable()
*crosssections()
*cubiclines()
*curves()
*define()
*defineattribute()
*deletemassthicknesstable()
*deletemergedloadloadsteptable()
*dequations()
*designvars()
*desvarlinks()
*directmatrixinputs()
*dvprels()
*elementareacalculation()
*elementresultstore()
*elements()
*else()
*enabledatabase()
*encryptions()
*end()
*endif()
*endlink()
*endloop()
*endsegments()
*entitypointerset()
*equations()
*errormessage()
*executetclscript()
*field()
*fieldleft()
*fieldright()
*fields()
*format()
*function()
*geometryoverride()
*groups()
*hm_features()
*if()
*ignorecomment()
*ignoreelemconfigtype()
*include()
*includefiles()
*laminates()
*lines()
*loadcols()
*loads()
*loadsteps()
*loopif()
*markfailed()
*materials()
*mechanisms()
*meshcontrols()
*metadata()
*modelMOI()
*modules()
*nodes()
*objectives()
*optiresponses()
*output()
*outputblocks()
*outputparameterizeddata()
*parameters()
*plies()
*plots()
*pointerset()
*points()
*populatemassthicknesstable()
*positions()
*properties()
*quote()
*rangeadd()
*rangereset()
*realprecision()
*regions()
*registerparameterizeddataappendstring()
*registerparameterizeddataendstring()
*return()
*rigidwalls()
*scalefieldwidth()
*segments()
*sensors()
*setcollector()
*setcurrentbagentitytype()
*setettypeelemtypereference()
*sets()
*shapes()
*sortelements()
*sortloads()
*sortloadsteps()
*sortnodes()
*sortsets()
*specialidruletoignoreincomingids()
*string()
*stringtablereset()
*stringtablestore()
*surfaces()
*systcols()
*systems()
*tablenreset()
*tablenstore()
*tablereset()
*tables()
*tablestore()
*text()
*titles()
*transformations()
*uservariableset()
*variableset()
*vectorcols()
*vectors()
*vectortablereset()
*vectortablestore()
*writegeometry()
Deprecated Solver Template Commands
Private Solver Template Commands
Undocumented Solver Template Commands
Solver Template Functions
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.
*assemblies()
Starts an assembly output block. All the assemblies in the
HyperMesh
database are output according to the user-defined format in this 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.
*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.
*codename()
Sets a unique solver number to be used for identifying attributes.
*collections()
Starts a collections block.
*components()
Starts a component block.
*compressreal()
Changes how real numbers are written to the output deck.
*configurations()
Starts a configurations block.
*constrainedextranodes()
Starts a constrainedextranodes block.
*constrainedrigidbodies()
Starts a constrainedrigidbodies block.
*constraints()
Creates a mechanism constraint in HMASCII format.
*contactsurfs()
Starts a contactsurfs 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.
*cubiclines()
Starts a line output block in parametric cubic format. All of the lines in the database are output according to the user-defined format in the block following the
*cubiclines()
command.
*curves()
Starts a curves block.
*define()
Defines a dictionary item.
*defineattribute()
Defines an attribute 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.
*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.
*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.
*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.
*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.
*fieldright()
Places a right-justified, formatted value from the database into the output file.
*fields()
Starts a fields block.
*format()
Indicates that the following commands should be executed on the format level.
*function()
Starts a function 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.
*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.
*laminates()
Starts a laminate 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.
*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
).
*materials()
Starts a material block.
*mechanisms()
Starts a mechanisms 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.
*modelMOI()
Computes the inertia tensor for the global model and store the results into a table.
*modules()
Starts a modules 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.
*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.
*parameters()
Starts a parameters block.
*plies()
Starts a ply 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.
*populatemassthicknesstable()
Populates the element mass/thickness table.
*positions()
Starts a positions 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.
*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.
*return()
Ends a function block.
*rigidwalls()
Starts a rigid wall block.
*scalefieldwidth()
Scales the width of a field.
*segments()
Starts a segment output block.
*sensors()
Starts a sensors 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
.
*sets()
Starts a set block.
*shapes()
Starts a shape output block. All the shapes are output according to the user-defined format in this block.
*sortelements()
Sets the order that elements are output in an
*elements()
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.
*string()
Outputs a string to the output file.
*stringtablereset()
Resets the string lookup table.
*stringtablestore()
Stores an entry into the string lookup table.
*surfaces()
Starts a surface output 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.
*text()
Starts a block that contains text.
*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.
*writegeometry()
Outputs the
Altair
geometry database in an internal ASCII format.
Deprecated Solver Template Commands
Private Solver Template Commands
Undocumented Solver Template Commands