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 Functions
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
Solver Template Functions
@acos()
@allowduplicateids()
@asin()
@atan()
@atan2()
@attributearray2dcols()
@attributearray2drows()
@attributearray2dvalue()
@attributearraylength()
@attributearrayvalue()
@attributeindexarray2dcols()
@attributeindexarray2drows()
@attributeindexarray2dvalue()
@attributeindexarraylength()
@attributeindexarrayvalue()
@attributeindexbehavior()
@attributeindexentityid()
@attributeindexentitytype()
@attributeindexentitytypename()
@attributeindexidentifier()
@attributeindexsolver()
@attributeindexstatus()
@attributeindextype()
@attributeindexvalue()
@attributereferencecount()
@attributesmaxforsolver()
@autocreateproperty()
@checkfile()
@checkmergeinclude()
@compressNodeElems()
@controlcardattributedefined()
@cos()
@count()
@defaultstatus()
@defined()
@dofs()
@elemcountperinclude()
@entitygettype()
@entityincollector()
@entitymaxid()
@enum()
@exists()
@exp()
@fabs()
@getattributearraylength()
@getattributearrayvalue()
@getcelltriplevalue()
@getcelltype()
@getcellvalue()
@getcollectorcardimage()
@getcollectorname()
@getcolumnentitytype()
@getcolumnlabel()
@getcolumntype()
@getcontrolcardattribute()
@getdatabaseentitytypename()
@getentityvalue()
@getincludeidbyfilename()
@getincludereferenceflag()
@getinternalid()
@getnewid()
@getsolverid()
@gettablecelltriplevalue()
@gettablecelltype()
@gettablecellvalue()
@gettablecolumnentitytype()
@gettablecolumnlabel()
@gettablecolumnsize()
@gettablecolumntype()
@gettablecolumntypestring()
@icedependentcount()
@icedependentdof()
@icedependentnode()
@keywordrenumber()
@loadexistinmergedloadloadsteptable()
@log()
@log10()
@lookup()
@magnitude()
@nlookup()
@pow()
@rangecount()
@rangeend()
@rangestart()
@remsuppressedincludefrommaster()
@repeatkeywordtitles()
@sin()
@sqrt()
@stringequal()
@stringinstring()
@stringlookup()
@stringsplit()
@stringstartswithnumericcharacter()
@tan()
@vectorlookup()
@vectorlookupcomponent()
@vectorlookupnotkey()
@writehmcomments()
@xpointelementoffsetvectorlocal()
@xpointlocal()
@xpointvectorlocal()
@ypointelementoffsetvectorlocal()
@ypointlocal()
@ypointvectorlocal()
@zpointelementoffsetvectorlocal()
@zpointlocal()
@zpointvectorlocal()
Undocumented Solver Template Functions
Solver Template Functions
@acos()
Trigonometric arc cosine of x, the result is expressed in radians between 0 and pp.
@allowduplicateids()
Returns 1 if the allow duplicate IDs option is enabled via
*allowduplicateids
, 0 otherwise.
@asin()
Trigonometric arc sine of x, the result is expressed in radians between -pp/2 and pp/2.
@atan()
Trigonometric arc tangent of x, the result is expressed in radians between -pp/2 and pp/2.
@atan2()
Trigonometric arc tangent of x/y, with the result is expressed in radians between -pp and pp.
@attributearray2dcols()
Returns the number of columns in a 2D array attribute.
@attributearray2drows()
Returns the number of rows in a 2D array attribute.
@attributearray2dvalue()
Returns the value of a 2D array attribute.
@attributearraylength()
Returns the length of a 1D array attribute.
@attributearrayvalue()
Returns the value of 1D array attribute.
@attributeindexarray2dcols()
Returns the number of rows for a 2D array attribute on an entity.
@attributeindexarray2drows()
Returns the number of rows for a 2D array attribute on an entity.
@attributeindexarray2dvalue()
Returns the value of a 2D array attribute on an entity.
@attributeindexarraylength()
Returns the length of a 1D array attribute on an entity.
@attributeindexarrayvalue()
Returns the value of a 1D array attribute on an entity.
@attributeindexbehavior()
Returns the behavior of an attribute on an entity.
@attributeindexentityid()
Returns the entity ID of an entity attribute on an entity.
@attributeindexentitytype()
Returns the entity type (number) of an entity attribute on an entity.
@attributeindexentitytypename()
Returns the entity type (string) of an entity attribute on an entity.
@attributeindexidentifier()
Returns the identifier of an attribute on an entity.
@attributeindexsolver()
Returns the solver of an attribute on an entity.
@attributeindexstatus()
Returns the status of an attribute on an entity.
@attributeindextype()
Returns the type of attribute on an entity.
@attributeindexvalue()
Returns the value of an attribute on an entity.
@attributereferencecount()
Returns the number of times an entity is referenced by an attribute.
@attributesmaxforsolver()
Returns the number of attributes on the current entity that belong to a solver.
@autocreateproperty()
Returns the status of the "auto create property" export option.
@checkfile()
Checks for a file.
@checkmergeinclude()
Returns the state of the "merge include" export option.
@compressNodeElems()
Returns 0 if HM_NODEELEMS_SET_COMPRESS_SKIP is passed via
*feoutputwithdata
.
@controlcardattributedefined()
Returns 1 if an attribute exists, 0 otherwise.
@cos()
Trigonometric cosine of x, where x is expressed in radians.
@count()
Counts the entities in the database.
@defaultstatus()
Returns the default status of an attribute.
@defined()
Tests to see if a dictionary item or an attribute is defined.
@dofs()
Extracts individual degrees of freedom from an integer and returns the status.
@elemcountperinclude()
Returns the number of elements of a specific configuration and type for a specific component being exported to an include file.
@entitygettype()
Returns the user-assigned entity type. The user-assigned entity type is set in the template.
@entityincollector()
Returns the number of entities in a collector.
@entitymaxid()
Returns the maximum ID in use from a type of entity.
@enum()
Returns the value of an enumeration.
@exists()
Indicates if a pointer is pointing to an entity or if it is set to NULL.
@exp()
Exponential of x.
@fabs()
Absolute value of x.
@getattributearraylength()
Retrieves the length of a 1D array attribute attached to a specific entity.
@getattributearrayvalue()
Retrieves the value of a 1D array attribute attached to a specific entity.
@getcelltriplevalue()
Returns the values of a triple cell in a table.
@getcelltype()
Returns the type of a cell in a table.
@getcellvalue()
Returns the values of a bool, double, float, int, string, unsigned int, or entity ID cell in a table.
@getcollectorcardimage()
Retrieves the
card image
of a collector (such as PSHELL, Part, and so on).
@getcollectorname()
Retrieves the name of a collector.
@getcolumnentitytype()
Returns the entity type ID of a column in a table.
@getcolumnlabel()
Returns the label of a column in a table.
@getcolumntype()
Returns the type ID of a column in a table.
@getcontrolcardattribute()
Returns the value of an attribute on a
Control Card
.
@getdatabaseentitytypename()
Gets the type name of an entity from its index.
@getentityvalue()
Retrieves the value of an entity.
@getincludeidbyfilename()
Returns the ID of an include file name.
@getincludereferenceflag()
Returns the referenced state of an include in the master file.
@getinternalid()
This command, used in feoutput and summary templates, returns an internal ID based on the pool number and solver ID of an entity. This command needs to be used in conjunction with the command
@getentityvalue()
, which returns the solver ID. You must know the pool number corresponding to an entity type of attribute.
@getnewid()
Returns the next valid ID by checking IDs of other entities.
@getsolverid()
Returns solver ID based on entity type and internal ID of an entity. This needs to be used in feoutput and summary templates.
@gettablecelltriplevalue()
Returns the values of a triple cell in a table.
@gettablecelltype()
Returns the type of a cell in a table.
@gettablecellvalue()
Returns the values of a bool, double, float, int, string, unsigned int, or entity ID cell in a table.
@gettablecolumnentitytype()
Returns the entity type ID of a column in a table.
@gettablecolumnlabel()
Returns the label of a column in a table.
@gettablecolumnsize()
Returns the size (number of rows) of a column in a table.
@gettablecolumntype()
Returns the type ID of a column in a table.
@gettablecolumntypestring()
Returns the type string of a column in a table.
@icedependentcount()
Returns the number of ICE dependent nodes for an independent node.
@icedependentdof()
Returns ICE dependent node DOFs for an independent node.
@icedependentnode()
Returns ICE dependent nodes for an independent node.
@keywordrenumber()
Returns 1 if RENUMBER is passed with the queried keyword via
*feoutputwithdata
.
@loadexistinmergedloadloadsteptable()
Returns 1 if the load exists in the table containing merged loads for a loadstep created by
*createmergedloadloadsteptable()
.
@log()
Natural logarithm.
@log10()
Logarithm of x to the base 10.
@lookup()
Retrieves a value stored in a lookup table.
@magnitude()
Returns the magnitude of a vector.
@nlookup()
Retrieves a value stored in the nth lookup table.
@pow()
Returns the real value of X raised to the power Y.
@rangecount()
Returns the number of ranges for the numbers used with
*rangeadd()
.
@rangeend()
Returns the ending range of a range of numbers.
@rangestart()
Returns the starting range of a range of numbers.
@remsuppressedincludefrommaster()
Returns the value of the "Remove include file reference based on export status" export option.
@repeatkeywordtitles()
Returns the status of the "repeat keyword titles" export option.
@sin()
Trigonometric sine of x, where x is expressed in radians
@sqrt()
Returns the square root of a number.
@stringequal()
Compares two strings, and returns 1 if they are equal; otherwise, 0.
@stringinstring()
@stringlookup()
Retrieves a value stored in a string lookup table.
@stringsplit()
Splits the given string using the given continuation character.
@stringstartswithnumericcharacter()
Checks if a string starts with a numeric character.
@tan()
Trigonometric tangent of x, where x is expressed in radians.
@vectorlookup()
Retrieves a value stored in a vector lookup table.
@vectorlookupcomponent()
Retrieves a component of the vector stored in a lookup table.
@vectorlookupnotkey()
Retrieves a value stored in a vector lookup table.
@writehmcomments()
Returns 0 if HMCOMMENTS_SKIP is passed via
*feoutputwithdata
.
@xpointelementoffsetvectorlocal()
Transforms a global vector into an elemental system and returns the x value of the transformation.
@xpointlocal()
Transforms a global coordinate into a local system and returns the x value of the transformation.
@xpointvectorlocal()
Transforms a vector into a local system and returns the x value of the transformed vector.
@ypointelementoffsetvectorlocal()
Transforms a global vector into an elemental system and returns the y value of the transformation.
@ypointlocal()
Transforms a global coordinate into a local system and returns the y value of the transformation.
@ypointvectorlocal()
Transforms a vector into a local system and returns the y value of the transformed vector
@zpointelementoffsetvectorlocal()
Transforms a global vector into an elemental system and returns the z value of the transformation.
@zpointlocal()
Transforms a global coordinate into a local system and returns the z value of the transformation.
@zpointvectorlocal()
Transforms a vector into a local system and returns the z value of the transformed vector.
Undocumented Solver Template Functions