Templates

Templates

Altair HyperMesh 3.1

AltairEngineering

For technical support, contact us by phone or e-mail:

Country Phone E-mail

United States 248.614.2400 [email protected]

Germany 49.7031.6208.22 [email protected]

India 91.80.665.8871 [email protected]

Israel 972.3.5473651 [email protected]

Italy 39.11.900.77.11 [email protected]

Japan 81.3.5396.1341 [email protected]

Korea 822.573.4152 [email protected]

Scandinavia 46.46.286.2052 [email protected]

United Kingdom 44.1327.810700 [email protected]

Copyright (c) 2000 Altair Engineering, Inc. All rights reserved.

Trademark Acknowledgments:

HyperMesh is a registered trademark of Altair Engineering, Inc.ACIS is a registered trademark of SPATIAL TECHNOLOGY, INC.ACIS Geometric Modeler is a registered trademark of SPATIAL TECHNOLOGY, INC.ACIS Kernel is the registered trademark of SPATIAL TECHNOLOGY, INC.ACIS Parametric Surfaces is the registered trademark of SPATIAL TECHNOLOGY, INC.MS-DOS is a registered trademark of Microsoft Corporation.UNIX is a registered trademark of AT&T.MSC/NASTRAN is a registered trademark of MSC.ABAQUS is a registered trademark of Hibbitt, Karlsson, & Sorensen, Inc.ANSYS is a registered trademark of Ansys, Inc.PATRAN is a registered trademark of MSC.LS-DYNA is a registered trademark of LSTC.MARC is a registered trademark of MARC Analysis Research Corporation.PAMCRASH is a registered trademark of Engineering Systems International.FLUENT is a registered trademark of Fluent, Incorporated.I-DEAS is a registered trademark of Structural Dynamics Corporation.Spaceball is a registered trademark of Spacetec IMC Corporation.

Altair Engineering, Inc. 1 Templates

Template Design

Templates define the form of an output file using a series of commands. This section describesHyperMesh templates and how to use them to generate a data deck.

HyperMesh templates format the data in a HyperMesh database for finite element codes. A templateis an ASCII data file containing HyperMesh template commands that are organized in blocks. Whenoutputting a database, HyperMesh processes the template per block. Blocks are output in the orderthat they are defined in the template file.

Templates search the HyperMesh database. As you request an entity for output, HyperMeshsearches the database. You can request output on five levels (listed below in ascending order).

before() At this level, you can define a series of commands thatHyperMesh processes before moving to the next level.The before() level is executed once for each data typerequested. Use this level to add comments and set upparameters on the following levels. Some of the data in thedatabase is available at this level.

beforecollector() At this level, HyperMesh scans the database for therequested data type. Each time HyperMesh finds therequested data type collector, it executes thebeforecollector() level. Use this level to addcomments about the data and create groups. Collectordata is available at this level.

format() At this level, HyperMesh processes the commands definedfor each entity contained in a collector. The dataassociated with the printed entity is available, and theformat required for each entity is defined at this level.

aftercollector() After the data entities within a collector have beenprocessed, HyperMesh goes to the aftercollector()level. The aftercollector() level is processed aftereach collector is scanned. Only the collector data isavailable at this level.

after() The after() level is similar to the before() level.HyperMesh executes the after() level once afterHyperMesh scans the database.

The before() and after() blocks are executed even if none of the entities specified exists in thedatabase.

Templates 2 Altair Engineering, Inc.

Nodes - Output Steps

HyperMesh performs the following steps to output nodes:

1. HyperMesh executes the before() level.

2.HyperMesh executes the beforecollector() level using the only node collector in thedatabase.

3. The format() level is executed once for each node in the database.

4. After processing the nodes, HyperMesh executes the aftercollector() level and theafter() level.

When outputting nodes, the before() and beforecollector()levels perform the same operation.The after() and aftercollector() levels also perform the same operation. This is becausethere is no data associated with the collector.

Collectors

HyperMesh performs the following steps to output collectors:

1. HyperMesh executes the before() level following by the beforecollector() level.

2. Since a HyperMesh database does not have a collector collector, the beforecollector()level is a duplicate of the before()level and is immediately executed once.

3. HyperMesh executes the format() level for each of the collectors in the database. All of thecollector data is available.

4. The aftercollector() and after() levels are processed similarly to the before() andbeforecollector() levels in step 1. The collector types in HyperMesh include:

Assemblies Blocks

Components Curves

Load Collectors Materials

Plots Properties

System Collectors

Vector Collectors


Lines - Output Steps

HyperMesh performs the following steps to output lines:

1. HyperMesh executes the before() level before scanning the database.

2. HyperMesh examines each component for a line that matches the requested type. WhenHyperMesh finds a component, the beforecollector() level is processed. Component datais available at this level.

3. HyperMesh executes the format() level once for each line in the component that matches therequested type.

4. The aftercollector() and after() levels are processed similarly to the before() andbeforecollector() levels in step 1.

NOTE In the HyperMesh window, any time that you can select a line, you can also select theedge of a surface. Although those edges function as lines, they are not members ofcollectors and are not output by the template system.

Elements

When HyperMesh outputs elements, it follows the lines output procedure.

Surfaces - Output Steps

When HyperMesh outputs surfaces, it follows the lines output procedure.

Points - Output Steps

When HyperMesh outpus points, it follows the lines output procedure.

NOTE In the HyperMesh window, when you select a point, you can also select a vertex of asurface. Although these vertices can function as parts, they are not members ofcollectors, and are not output by the template system.


Groups - Output Steps

When HyperMesh outputs a group, it restricts the type and number of elements and lines that a groupcollects.

Systems and Loads

When HyperMesh outputs systems and loads, it follows the lines output procedure.

Vectors - Output Steps

HyperMesh performs the following steps to output vectors:

1. HyperMesh executes the before () level before scanning the database.

2. HyperMesh examines each vector collector for a list of vectors. For each vector collector found,the beforecollector() level is processed. Collector data is available at this level.

3. HyperMesh executes the format() level once for each vector found.

4. The aftercollector() and after() levels are processed similarly to the before() andbeforecollector() levels in step 1.

Templated Node Output Example

The following example demonstrates how to use template files to generate output files for nodes.

Assume that a particular analysis code, E-Z-SOL1, requires the nodes in the data deck to appear inthe following format:

BEGIN CODE1 8 16 24 32 40NODE DATANODE <id> <x> <y> <z>*...END NODESEND CODE

The following template generates the necessary output:

BEGIN CODE

*nodes()

*before()

*string("NODE DATA")


*end()

*format()

*string("NODE ")

*field(integer,id,8)

*field(real,x,8)

*field(real,y,8)

*field(real,z,8)

*string("*")

*end()

*after()

*string("END NODES")

*end()

*output()

The *nodes() command indicates the beginning of a node block. The commands following*nodes()format all node entities in the HyperMesh database. The next command, *before() ,instructs HyperMesh to execute the following commands on the before() level. *string() and*end() instruct HyperMesh to output the string contained in double quotes and perform a carriagereturn, respectively. The next command informs HyperMesh to execute the following commands onthe format() level, or with each of the entities (nodes in this case). *string() instructsHyperMesh to place the item in double quotes in the output file. The extra spaces after the wordNODE allow you to define a width, since the *string() command does not allow width definition.The next command is the first data request from the database.

The *field() command is how template files communicate with the HyperMesh database. The*field() command instructs HyperMesh to scan the database and retrieve the next piece ofinformation for the output file. *field() takes three parameters: the output type, the name of thedata accessed, and the width of the generated field. The output type can be integer, real,exponential, string, or hexadecimal. In this case, the data type is an integer. The next parameter isthe data name. ID indicates that HyperMesh places the value of the node ID into this field. The lastparameter is the width of the field. In this example, all fields are formatted to eight characters. Thenext three *field() commands place x, y, and z into the output file formatted as reals. *string()places the trailing asterisk on the end of the line. The *end() command (carriage return) is the lastcommand placed into the *format() level.

The *after() command indicates the last process level. This command instructs HyperMesh toexecute the following commands on the *after() level. The *string() command places thestring contained in double quotes in the output file and the *end() command ends the current line.

The *output() command processes the node entity output requests made in the preceeding block.If the *output() command is missing, HyperMesh does not print anything to the file.


Templated Element Output Example

The following example demonstrates how to use template files to generate output files for elements.

To demonstrate an element template, assume the same analysis code requires the following for thequad elements:

1 10 20 30 40 50

BEGIN ELEMENT DATA

ELEMENTS GROUP = <name>

<id> <node1> <node2> <node3> <node4>

.

.

.

END

.

.

.

END ELEMENTS

The above example assumes that E-Z-SOL1 requires grouped element input, where elements ofsimilar thickness and property are placed in a group. The following template generates the requiredformat:

*elements(104,1,"quads","property")

*before()

*string("BEGIN ELEMENT DATA") *end()

*beforecollector()

*string(" ELEMENTS GROUP = ") *field(string,collector.name,10)*end()

*format()

*field(integer,id,10) *field(integer,node1.id,10)

*field(integer,node2.id,10) *field(integer,node3.id,10)

*field(integer,node4.id,10) *end()

*aftercollector()

*string(" END") *end()


*after()

*string("END ELEMENTS") *end()

*output()

Note the placement of the *() commands. HyperMesh does not place restrictions on where thecommands appear in the file, so you can format the template as necessary. Comments can also beadded for documentation purposes. HyperMesh ignores file content until it finds an asterisk, *. Acommand is defined as the characters between the asterisk, * and the closing parenthesis, ).

The *elements() command instructs HyperMesh that the following commands define an elementoutput block or process. The parameters to the *elements() command are the configuration andtype of element the output block applies to: a user-defined name for the elements, and a user-definedname for the property the elements require. Element configurations are listed in the followingsections for each of the HyperMesh elements. Element types are a user-defined number associatedwith each HyperMesh element (defaults to 1). Changing the type allows multiple definitions for aHyperMesh element configuration. A quad is configuration 104 and type 1. When these parametersare supplied, HyperMesh limits the output of this process to quad elements. The next series ofcommands, *before() , *string() , and *end() behave as described in Templated NodeOutput, Example .

The *beforecollector() command instructs HyperMesh to process the following commands onthe *beforecollector() level. When the beforecollector() level is selected, HyperMeshprocesses the commands each time it finds a collector holding the required type of information in thedatabase. In this case, *string(), *field() , and *end() are the commands HyperMeshprocesses when a component is found. On the *field() command, the data name iscollector.name.

*format() describes the process for each element of configuration 104 and type 1. The formatcommands use the data name node1.id, node2.id, etc. The period, ., is displayed becausenode1 is a pointer to the node. node1.id is the ID of the node.

The commands available in the template files are listed in the Using Template Commands section. Inaddition, the HyperMesh templates serve as examples.


Using Mathematical Expressions

The commands in a template files can contain mathematical expressions. For example, to translate amodel during output, apply a formula to the x coordinate of a node:

*nodes()

*format()

*string("node,")


*string(",")

*field(real,[x+100.0],10)

*string(",")

*field(real,y,10)

*string(",")

*field(real,z,10)

*end()

*output()

100.0 is added to the x coordinate of the nodes and is sent to the formatter, where it is written to file.The square brackets, [], around the formula tell the parser that the enclosed text is a formula and notto interpret the asterisk, *, as a new command.

The following operators are available in a mathematical expression:

% Modulus

* Performs multiplication/ Performs division+ Performs addition

- Performs subtraction

Equalities, Inequalities, and Logical Expressions

Templates contain functions to test values, perform conditional statement execution, or control thetemplate flow. These statements include *if and *loopif. The tests in these commands use thefollowing syntax to determine if the statement is true or false. These statements can be linked tological expressions.

Equalities and Inequalities

Equal to: ==

Not equal to: !=


Less than: <

Greater than; >

Less than or equal to: <=

Greater than or equal to: >=

Logical Expressions

Logical and &&

Logical or ||


What are Data Names?

Template files use data names to access data from the HyperMesh database. A data name is astring that represents a piece of data. At output, HyperMesh replaces the data name string with thevalue that the data name represents. For example, a node has id, x, y, z, and system aspossible data names in the template files. If you enter the command *field(integer,id,8) intoa template file, HyperMesh outputs the node ID in an integer format using eight spaces.

A data name can also represent pointers to another entity in the database. In the preceedingparagraph, the data name node1 is a pointer. node1 points to a node in the HyperMesh database.If you enter the command *field(integer,node1,8), HyperMesh issues the error messagefield statement references a pointer. HyperMesh can’t output the correct value becausenode1 points to a node entity that has many different printable values. To print the node ID,reference the pointer as *field(integer,node1.id,8). A period, . , separates the data namenode1 and the data name id.

In the data name tables, the levels are coded numerically:

1. before()

2. beforecollector()

3. format()

4. aftercollector()

5. after()

Data (except for global data) is only available on levels two through four. Reference all pointers byplacing a period after the name, followed by the data name of the entity type.

Nodes - Data Names

Data Name Level Value

id 3 ID

x 3 x coordinate in the local system

y 3 y coordinate in the local system

z 3 z coordinate in the local system

globalx 3 x coordinate in the global system

globaly 3 y coordinate in the global system

globalz 3 z coordinate in the global system

superid 3 super element ID of the node

inputsystem 3 the input system (system pointer)


inputsystemid 3 the input system ID

outputsystem 3 the output system (system pointer)

outputsystemid 3 the output system ID

surfaceid 3 the ID of the surface where the node is located (maybe zero)

attributesmax 3 the number of attributes owned by this entity

surfaceindex 3 index into the geometry database that identifies thepart of the surface where the node is located.

Mass Elements

Configuration: 1


id 3 ID

config 3 The number, “1”

type 3 element type

node1 3 node (node pointer)

mass 3 mass

property 3 property of the element (property pointer)

propertyid 3 property ID of the element

system 3 input system (system pointer)

collector 2,3,4 component that owns the element (component pointer)


Slave1 Elements

Configuration: 135


id 3 ID


type 3 element type

node1 3 node (node pointer)




Plot Elements

Configuration: 2


id 3 ID


type 3 element type

node1 3 first node (node pointer)

node2 3 second node (node pointer)



Weld Elements and Rigid Elements

Configuration: 3 (weld elements) and 5 (rigid elements)


id 3 ID

config 3 Weld elements - 3

3 Rigid elements - 5

type 3 element type

node1 3 first (independent) node (node pointer)

node2 3 second (dependent) node (node pointer)

dofs 3 degrees of freedom




Rigidlink Elements

Configuration: 55


id 3 ID

config 3 The number, "55"

type 3 element type

independentnode 3 independent node (node pointer)

independentdof 3 specified independent degree of freedoms (forexample 123456, 134, 1256)

dependentnodes 3 dependent nodes

(use with pointerset-pointerset(pointer1,dependentnodes,0))

dependentnodesmax 3 number of dependent nodes

node 3 dependent node pointer (use with pointer -pointer1.node.id)

collector 2,3,4 component that owns the element (componentpointer)

Spring Elements

Configuration: 21


id 3 ID


type 3 element type



dofs 3 degrees of freedom

property 3 property collector (property pointer)

propertyid 3 property collector ID




vectorid 3 ID of the vector associated with the spring element

vector 3 The vector associated with the spring element

Joint Elements

Configuration: 22


id 3 ID of the element


type 3 The type of the element according to the followingtable:

Type Type Name # Nodes Orientation

1 Spherical 2 none/systems/nodes

2 Revolute 4 none/systems

3 Cylindrical 4 none/systems

4 Planar 4 none/systems

5 Universal 4 none/systems

6 Translational 6 none/systems

7 Locking 6 none/systems

node1 3 Node 1 (all types)

node2 3 Node 2 (all types)

node3 3 Node 3 (all types but spherical)

node4 3 Node 4 (all types but spherical)

node5 3 Node 5 (only types translational andlocking)

node6 3 Node 6 (only types translational andlocking)

orientation 3 Orientation type. Use:

0 none

1 uses systems (all types)


2 uses nodes (only spherical type)

orientationnode1 3 orientation node 1 (only spherical type)

orientationnode2 3 orientation node 2 (only spherical type)

system1 3 orientation system 1 (all types)

system2 3 orientation system 2 (all types)

systemid1 3 orientation system ID 1 (all types)

systemid2 3 orientation system ID 2 (all types)



collector 2,3,4 component that owns the element(component pointer)

attributesmax 3 the number of attributes owned by thisentity

RBE3 Elements

Configuration: 56


id 3 ID

config 3 The number, "56"

type 3 element type

dependentnode 3 dependent node (node pointer)

dependentdof 3 dependent degrees of freedom

dependentcoeff 3 dependent coefficient (weighting factor)

independentnodes 3 independent nodes (use with pointerset -pointerset(pointer1,independentnodes,0))

independentnodesmax 3 number of independent nodes

node 3 independent node pointer (use with pointer -pointer1.node.id)

independentdofs 3 independent degrees of freedom

(use with pointersetpointerset(pointer2,independentdofs,0))pointervalue returns the dofs.

independentcoeffs 3 independent coefficients


(use with pointerset -pointerset(pointer3,independentcoeffs,0))pointervalue returns the coefficient.


Bar2 Elements

Configuration: 60


id 3 ID


type 3 element type



localyx 3 x component of local y axis vector

localyy 3 y component of local y axis vector

localyz 3 z component of local y axis vector

localzx 3 x component of local z axis vector

localzy 3 y component of local z axis vector

localzz 3 z component of local z axis vector

dofsa 3 active dofs at end a

dofsb 3 active dofs at end b

offsetax 3 x component of offset vector at end a

offsetay 3 y component of offset vector at end a

offsetaz 3 z component of offset vector at end a

offsetbx 3 x component of offset vector at end b

offsetby 3 y component of offset vector at end b

offsetbz 3 z component of offset vector at end b

length 3 length of bar






directionnodeused 3 If directionnodeused is 1, then theorientation of the bar is defined bydirectionnode and directionnodeydir.

directionnode 3 direction node for the bar (node pointer).

If directionnodeydir is 1, then the directionnode defines the local y axis. Otherwise,direction node defines the local z axis.directionnode is optional, and can only be usedif directionnodeused is one.

directionnodeydir 3 Equals 1 if directionnode defines the local y axisof the bar. Otherwise, directionnode defines thelocal z axis.

Bar3 Elements

Configuration: 63


id 3 ID


type 3 element type



node3 3 third node (node pointer)

localyx 3 x component of local y axis vector

localyy 3 y component of local y axis vector

localyz 3 z component of local y axis vector

localzx 3 x component of local z axis vector

localzy 3 y component of local z axis vector

localzz 3 z component of local z axis vector

dofsa 3 active dofs at end a

dofsb 3 active dofs at end b

offsetax 3 x component of offset vector at end a


offsetay 3 y component of offset vector at end a

offsetaz 3 z component of offset vector at end a

offsetbx 3 x component of offset vector at end b

offsetby 3 y component of offset vector at end b

offsetbz 3 z component of offset vector at end b

length 3 length of bar





directionnodeused 3 if directionnodeused is 1, then theorientation of the bar is defined bydirectionnode and directionnodeydir.

directionnode 3 direction node for the bar (node pointer). Ifdirectionnodeydir is 1, then the directionnode defines the local y axis. Otherwise,direction node defines the local z axis.directionnode is optional, and can only beused if directionnodeused is 1.

directionnodeydir 3 equals 1 if directionnode defines the local yaxis of the bar. Otherwise, directionnodedefines the local z axis.


Rod Elements

Configuration: 61


id 3 ID


type 3 element type



length 3 length of rod





Gap Elements

Configuration: 70


id 3 ID


type 3 element type







vectorid 3 ID of the vector associated with the spring element

vector 3 The vector associated with the spring element


Tria3, Master3, and Slave3 Elements

Configuration: 103 (tria3), 123 (master3), and 133 (slave3)


id 3 ID

config 3 The number, “103” - tria3

The number, “123” - master3

The number, “133” - slave3

type 3 element type




normalx 3 normal in the x direction

normaly 3 normal in the y direction

normalz 3 normal in the z direction

area 3 area

longestaltitude 3 longest distance from node to non-adjoining face

shortestaltitude 3 shortest distance from node to non-adjoining face

shortestside 3 length of the shortest side of the element

longestside 3 length of the longest side of the element



warpage 3 element warpage (see check elems panel for details)

aspect 3 element aspect ratio (see check elems panel fordetails)

skew 3 element skew angle (see check elems panel fordetails)

jacobian 3 element jacobian (see check elems panel for details)

minangle 3 minimum interior angle

maxangle 3 maximum interior angle


For Configuration 123 and 133 only:


baseelementid 3 ID of the element that is attached

baseelementface 3 face of the element that is attached

baseelementdirection 3 direction of the element normal wrt baseelement:

0, when interface elements have normalspointing in the same direction as the baseelement

1, when interface elements have normalspointing in the opposite direction of the baseelement

baseelementtype 3 type of the element that is attached:

1 shell

2 tetra

3 penta

4 hexa

group 3 group that owns the element (group pointer)



Tria6 Elements

Configuration: 106


id 3 ID


type 3 type




node4 3 fourth node (node pointer)

node5 3 fifth node (node pointer)

node6 3 sixth node (node pointer)




area 3 area

longestaltitude 3 longest distance from node to non-adjoining face

shortestaltitude 3 shortest distance from node to non-adjoining face












Quad4, Tetra4, Master4 and Slave4 Elements

Configuration: 104 (quad4), 124 (master4), 134 (slave4), and 204 (tetra4)


id 3 ID

config 3 The number, “104” - quad4

The number, “124” - master4

The number, “134” - slave4

The number, “204” - tetra4

type 3 element type





normalx 3 normal in the x direction (for plate elements)

normaly 3 normal in the y direction (for plate elements)

normalz 3 normal in the z direction (for plate elements)

area 3 area (for plate elements)

longestdiagonal 3 longest element diagonal

shortestdiagonal 3 shortest element diagonal



volume 3 volume (for tetra elements)










largestfacearea 3 The number, “204”

For Configuration 124 and 134 only:


baseelementid 3 ID of the element that is attached

baseelementface 3 face of the element that is attached

baseelementdirection 3 direction of the element normal wrt baseelement:

0 when interface elements have normals pointingin the same direction as the base element

1 when interface elements have normals pointingin the opposite direction of the base element

baseelementtype 3 type of the element that is attached:

1 shell

2 tetra

3 penta

4 hexa

group 3 group that owns the type (group pointer)





Quad8 Elements

Configuration: 108


id 3 ID


type 3 type







node7 3 seventh node (node pointer)

node8 3 eighth node (node pointer)




area 3 area














Penta6 Elements

Configuration: 206


id 3 ID


type 3 element type







volume 3 volume

largestfacearea 3 area of the largest face on a solid element



Hex8 Elements

Configuration: 208


id 3 ID


type 3 element type










volume 3 volume




Tetra10 Elements

Configuration: 210


id 3 ID


type 3 element type









node9 3 ninth node (node pointer)

node10 3 tenth node (node pointer)

volume 3 volume


longestaltitude 3 longest distance from node to non-adjoining side

shortestaltitude 3 shortest distance from node to non-adjoining side



warpage 3 warpage

aspect 3 aspect ratio

skew 3 skew


jacobian 3 jacobian

minangle 3 minimum angle

maxangle 3 maximum angle

Penta15 Elements

Configuration: 215


id 3 ID


type 3 element type











node11 3 eleventh node (node pointer)

node12 3 twelfth node (node pointer)

node13 3 thirteenth node (node pointer)

node14 3 fourteenth node (node pointer)

node15 3 fifteenth node (node pointer)

volume 3 volume





Hex20 Elements

Configuration: 220


id 3 ID


type 3 element type











node11 3 eleventh node (node pointer)

node12 3 twelfth node (node pointer)

node13 3 thirteenth node (node pointer)

node14 3 fourteenth node (node pointer)

node15 3 fifteenth node (node pointer)

node16 3 sixteenth node (node pointer)

node17 3 seventeenth node (node pointer)

node18 3 eighteenth node (node pointer)

node19 3 nineteenth node (node pointer)

node20 3 twentieth node (node pointer)

volume 3 volume





Components

Data Name LevelValue

id 3 ID

name 3 name

material 3 material collector (material pointer)

materialid 3 material collector ID

dictionary 3 component dictionary (dictionary pointer)

dictionarymax 3 number of entries in the dictionary

color 3 color


Properties


id 3 ID of the property

name 3 name of the collector



dictionary 3 collector dictionary (dictionary pointer)

dictionarymax 3 number of items in the dictionary


Materials


id 3 ID of the material

name 3 name of the collector





System Collectors


id 3 ID of the system collector

name 3 name of the system collector

color 3 color of the system collector



Load Collectors


id 3 ID of the load collector

name 3 name of the load collector

color 3 color of the load collector

dictionary 3 dictionary of the collector (dictionary pointer)



Vector Collectors


id 3 ID of the vector collector

name 3 name of the vector collector

color 3 color of the vector collector

dictionary 3 dictionary of the vector collector (pointer)


attributesmax 3 number of attributes owned by this entity


Groups - Data Names

All groups contain the following data:


id 3 ID

name 3 name

config 3 group configuration

type 3 group type



dictionary 3 component dictionary (dictionary pointer)


color 3 color

masterdefinition 3 0 for entities, 1 for components, 2 forboxes, 3 for all, 4 for sets

masterboxxmin 3 minimum global x value for master box

masterboxymin 3 minimum global y value for master box

masterboxzmin 3 minimum global z value for master box

masterboxxmax 3 maximum global x value for master box

masterboxymax 3 maximum global y value for master box

masterboxzmax 3 maximum global z value for master box

mastercomponentlist 3 a pointer to the master component IDscontained in the group

mastercomponentlistmax 3 number of master components in the group

mastersetlist 3 a pointer to the master set IDs contained inthe group

mastersetlistmax 3 number of master sets in the group

slavedefinition 3 0 for entities, 1 for components, 2 forboxes, 3 for all, 4 for sets

slaveboxxmin 3 minimum global x value for slave box

slaveboxymin 3 minimum global y value for slave box

slaveboxzmin 3 minimum global z value for slave box

slaveboxxmax 3 maximum global x value for slave box


slaveboxymax 3 maximum global y value for slave box

slaveboxzmax 3 maximum global z value for slave box

slavecomponentlist 3 a pointer to the slave component IDscontained in the group

slavecomponentlistmax 3 number of slave components in the group

slavesetlist 3 a pointer to the slave set IDs contained inthe group

slavesetlistmax 3 number of slave sets in the group


Groups with config 5 (Rigid Walls) contain the following additional data:


basenode 3 pointer to the basenode of the rigid wall

geometrytype 3 1 for infinite plane,2 for finite plane,

3 for infinite prism, 4 for finite prism, 5 forcylinder, 6 for sphere, 7 for MADYMO Plane, 8for MADYMO Ellipse

madymoid 3 ID of the associated MADYMO entity

midpointx 3 x value of the midpoint of finite plane geometrytype (returns 0.0 for other geometry)

midpointy 3 y value of the midpoint of finite plane geometrytype (returns 0.0 for other geometry)

midpointz 3 z value of the midpoint of finite plane geometrytype (returns 0.0 for other geometry)

pointax 3 x value of Point A on finite plane as defined inPAM-CRASH manual

pointay 3 y value of Point A on finite plane as defined inPAM-CRASH manual

pointaz 3 z value of Point A on finite plane as defined inPAM-CRASH manual

motiontype 3 0 for none, 1 for velocity, 2 for displacement

lengthx 3 length of the rigid wall in the local x direction

lengthy 3 length of the rigid wall in the local y direction

lengthz 3 length of the rigid wall in the local z direction

radius 3 radius of a cylinder or sphere


normalx 3 x component of the normal unit vector

normaly 3 y component of the normal unit vector

normalz 3 z component of the normal unit vector

xaxisx 3 x component of the local x axis unit vector

xaxisy 3 y component of the local x axis unit vector

xaxisz 3 z component of the local x axis unit vector

motionx 3 x component of motion vector

motiony 3 y component of motion vector

motionz 3 z component of motion vector

normalmotionangle 3 angle between motion and normal vectors

Sets


id 3 ID of the set

name 3 name of the set

color 3 color of the set

type 3 type of set (1 - node, 2 - element, 3 - component)

typename 3 name of the type of set (nodes, elems, comps)

ids 3 a pointer to the IDs

idsmax 3 the maximum number of IDs

element 3 element pointer (use with pointer - pointer1.element.id)

component 3 component pointer (use with pointer -pointer1.component.id)


Cards


id 3 ID of the card


NOTE Most of the information for a card is contained in the attributes owned by the card.


Output Blocks


id 3 ID of the outputblock

name 3 name of the outputblock

color 3 color of the outputblock

type 3 type of outputblock (1 - node, 2 - element)

typename 3 name of the type of outputblock (nodes or elems)



element 3 element pointer (use with pointer - pointer1.element.id)


Load Steps


id 3 ID of the loadstep

name 3 name of the loadstep

color 3 color of the loadstep



loadcollector 3 loadcollector pointer (use with pointer -pointer1.loadcollector.id)


Systems


id 3 ID

type 3 type of system (0 Rec, 1 Cyl, 2 Sph)

originx 3 x coordinate of the origin

originy 3 y coordinate of the origin

originz 3 z coordinate of the origin


globaloriginx 3 global x coordinate of the origin

globaloriginy 3 global y coordinate of the origin

globaloriginz 3 global z coordinate of the origin

xaxisx 3 x component of x axis (unit vector)

xaxisy 3 y component of x axis (unit vector)

xaxisz 3 z component of x axis (unit vector)

globalxaxisx 3 global x component of x axis (unit vector)

globalxaxisy 3 global y component of x axis (unit vector)

globalxaxisz 3 global z component of x axis (unit vector)

yaxisx 3 x component of y axis (unit vector)

yaxisy 3 y component of y axis (unit vector)

yaxisz 3 z component of y axis (unit vector)

globalyaxisx 3 global x component of y axis (unit vector)

globalyaxisy 3 global y component of y axis (unit vector)

globalyaxisz 3 global z component of y axis (unit vector)

globalzaxisx 3 global x component of z axis (unit vector)

globalzaxisy 3 global y component of z axis (unit vector)

globalzaxisz 3 global z component of z axis (unit vector)

position 3 position of system in the database

thetaxy 3 nodal xy orientation angle

thetayz 3 nodal yz orientation angle

thetazx 3 nodal xz orientation angle

localxy 3 local xy orientation angle

localyz 3 local yz orientation angle

localxz 3 local xz orientation angle

setid 3 system set ID

inputsystemid 3 input system ID

collector 2,3,4 system collector (system collector pointer)



Loads

The load entity allows forces and constraints to be placed in the database. Loads are applied in theglobal system except when the reference system has been modified. A constraint, applied at anode, is placed in the global system only if a system does not exist at that node. Conversely, if asystem does exist, the constraint is applied such that the orientation of the constraint is dictated bythe local system. Once a constraint has been applied, HyperMesh does not maintain the properorientation for the constraint as local systems are created or deleted at the node where theconstraint resides. Constraints, concentrated forces, concentrated moments, concentrated fluxes,temperatures, velocities, accelerations, and pressures are supported.

Constraint Loads

Configuration: 3


location 3 node where constraint is applied (node pointer)


comp1 3 value in dof1 (-999999.0 for none)






comp 3 value of the constraint in all components

equalmagnitude 3 set to 1 if all 6 dofs are equal, 0 otherwise

spc 3 set to 1 if active dofs are constraints

collector 2,3,4 collector that owns the load (load collector pointer)


Flux Loads

Configuration: 6


location 3 node where flux is applied (node pointer)

config 3 the number, “6”


flux 3 flux



Pressure Loads

Configuration: 4


location 3 element where pressure is applied(element pointer)


corner1 3 1st node of face (node pointer)

corner2 3 2nd node of face (node pointer)

edgelength 3 length of the loaded edge. This is foredge pressures only. Zero is returnedfor face pressures.

elementtype 3 1 for plate, 2 for tetra, 3 for penta, 4 forhexa

face 3 face number

facearea 3 area of the loaded face

facetype 3 4 for quad, 3 for tria

magnitude 3 magnitude of the pressure applied

pressuretype 3 on face: 0 for pressure, 1 for traction

on edge: 2 for pressure, 3 for traction

node1 3 first node on face

node2 3 second node on face

node3 3 third node on face

node4 3 fourth node on face

comp1 3 x component of the pressure

comp2 3 y component of the pressure

comp3 3 z component of the pressure

vectorx 3 x component of unit force vector

vectory 3 y component of unit force vector

vectorz 3 z component of unit force vector

centerx 3 x component of the center of the


element

centery 3 y component of the center of theelement

centerz 3 z component of the center of theelement

facearea 3 area of the loaded face

collector 2,3,4 collector that owns the load (loadcollector pointer)


Temperature Loads

Configuration: 5


location 3 node where temperature is applied (node pointer)

config 3 the number, “5”

temperature 3 temperature



Forces, Moments, Velocities, and Accelerations

Configuration: 1, 2, 8, 9


location 3 node where load is applied (pointer)

config 3 The number, “1,” for forces

The number, “2,” for moments

The number, “8,” for velocities

The number, “9,” for accelerations

comp1 3 x component of the vector

comp2 3 y component of the vector

comp3 3 z component of the vector

magnitude 3 magnitude of the load vector

vectorx 3 x component of the vector (unit)

vectory 3 y component of the vector (unit)


vectorz 3 z component of the vector (unit)

inputsystem 3 reference system (system pointer)

inputsystemid 3 reference system ID

collectorid 2,3,4 collector that owns the load (load collector pointer)


Equations


id 3 ID

type 3 equation type

constant 3 equation constant

dependentnode 3 dependent node (node pointer)

dependentdof 3 dependent degree of freedom

dependentcoeff 3 dependent coefficient (weighting factor)

independentnodes 3 independent nodes

(use with pointerset -pointerset(pointer1,independentnodes,0))

independentnodesmax 3 number of independent nodes

independentdofs 3 independent degrees of freedom

(use with pointerset -pointerset(pointer2,independentdofs,0))

pointervalue returns the dofs.

independentcoeffs 3 independent coefficients

(use with pointerset -pointerset(pointer3,independentcoeffs,0))

pointervalue returns the coefficient.

collector 2,3,4 collector that owns the equation (load collectorpointer)


Plots


id 3 ID of the plot

name 3 name of the plot

type 3 plot type

title 3 title of the plot

subtitle 3 subtitle of the plot

label 3 label of the plot

xaxistitle 3 title on the x axis

xaxislabel 3 label on the x axis

yaxistitle 3 title on the y axis

yaxislabel 3 label on the y axis

type 3 type of plot

titlecolor 3 title color

titlefont 3 title font

subtitlecolor 3 subtitle color

subtitlefont 3 subtitle font

labelcolor 3 label color

labelfont 3 label font

borderon 3 set to 1 to turn the plot border on

bordercolor 3 color of the plot border

borderwidth 3 width of the plot border

borderxmin 3 x value of upper left plot window

borderymin 3 y value of upper left plot window

borderxmax 3 x value of lower right plot window

borderymax 3 y value of lower right plot window

bordermargin 3 margin between the border and the plot axis

xmin 3 x value of lower left plot axis range

ymin 3 y value of lower left plot axis range

xmax 3 x value of upper right plot axis range

ymax 3 y value of upper right plot axis range


gridlines 3 if the grid lines are on, set to 1

gridxincrement 3 increment of grid lines on x axis

gridyincremen 3 increment of grid lines on y axis

mindivisions 3 minimum divisions allowed

maxdivisions 3 maximum divisions allowed

gridcolor 3 color of the grid lines

gridxlabel 3 x grid label frequency

gridylabel 3 y grid label frequency

gridwidth 3 width of the grid lines

labelsformat 3 format of the labels

labelsplaces 3 width of the label field

labelscolor 3 color of the labels

labelsfont 3 font used on the labels

margin 3 margin between labels and grid lines

axistitlecolor 3 color of the axis titles

axistitlefont 3 font used for the axis titles

legendxloc 3 x location of the legend

legendyloc 3 y location of the legend

legendfont 3 font used on the legend

curves 3 pointer to curves

numberofcurves 3 number of the curves on the plot

xaxistype 3 x axis type (0 - linear, 1 - log, 2 - decibel)

xaxisgrids 3 grid lines per decade for the x axis

xaxistics 3 grid labels per decade for the x axis

xaxisdynamicrange 3 dynamic range for (x, y) axis offsetting

xaxisformat 3 x axis format ("f" for fixed, "e" for exponential,"a" for auto)

yaxistype 3 y axis type (0 - linear, 1 - log, 2 - decibel)

yaxisgrids 3 grid lines per decade for the y axis

yaxistics 3 grid labels per decade for the y axis

yaxisdynamicrange 3 dynamic range for (x, y) axis offsetting

yaxisformat 3 y axis format ("f" for fixed, "e" for exponential,"a" for auto)


legendon 3 set to 1 if the legend is being displayed

legendidson 3 set to 1 if IDs are shown in the legend


extended 3 1 indicates plot is an extended (dual) plot.

mode 3 5 indicates phase/magnitude plot

2 indicates real/imaginary plot

This field only has meaning if extended=1.

vonmises 3 flags a plot as complex vonmises.

Curves


id 3 ID of the curve

name 3 name of the curve

title 3 curve title

linetype 3 line style used to draw the line

markertype 3 marker type used to indicate points on the curve

color 3 color used to draw the curve

width 3 width of the curve

scalex 3 x scale factor

scaley 3 y scale factor

points 3 pointer to points in curve (pointervalue is curve point)

numberofpoints 3 number of points in the curve

xkind 3 type of source for x data (0 - file, 1 - math expression)

xpath 3 File path and name, or math expression for x data

xtype 3 type of the x component

xreq 3 name of the x request

xcomp 3 name of the x request component

ykind 3 type of source for y data (0 - file, 1 - math expression)

ypath 3 File path and name, or math expression for y data

ytype 3 type of the y component

yreq 3 name of the y request


ycomp 3 name of the y request component


Dictionaries


pointer.name 3 name of the dictionary item

pointer.type 3 type of the dictionary item

pointer.typename 3 type name of the dictionary item

pointer.string 3 string value of the dictionary item

pointer.value 3 value of the dictionary item

pointer.active 3 flag indicating the dictionary's activity

Assemblies


id 3 ID of the assembly

name 3 name of the assembly

color 3 color of the assembly

components 3 pointer to components in anassembly(pointervalue is component ID)

numberofcomponents 3 number of components in the assembly


Blocks


id 3 ID of the block

name 3 name of the block

color 3 color of the block

mini 3 minimum i coordinate

maxi 3 maximum i coordinate

minj 3 minimum j coordinate

maxj 3 maximum j coordinate

mink 3 minimum k coordinate


maxk 3 maximum k coordinate

divi 3 number of divisions in the i direction

divj 3 number of divisions in the j direction

divk 3 number of divisions in the k direction

wallsmax 3 total number of walls

idivisions 3 pointer to divisions in i direction(pointervalue is divisioncoordinate)

jdivisions 3 pointer to divisions in j direction(pointervalue is divisioncoordinate)

kdivisions 3 pointer to divisions in k direction(pointervalue isdivision coordinate)

blockcell 3 pointer to block cell (pointervalue is wall ID)

blockwall 3 pointer to block wall

pointer.wallcolor 3 color of the wall from blockwall pointer

pointer.wallid 3 ID of the wall from blockwall pointer

pointer.wallname 3 name of the wall from blockwall pointer


Lines - Data Names


id 3 ID of the line

collector 3 collector that owns the line (component pointer)

geomid 3 internal ID in geometry database


Points - Data Names


id 3 ID of the point

collector 3 collector that owns the point (component pointer)

geomid 3 internal ID in geometry database



x 3 The x coordinate of the point

y 3 The y coordinate of the point

z 3 The z coordinate of the point

Surfaces - Data Names


id 3 ID of the surface

collector 3 collector that owns the surface (component pointer)


geomid 3 internal geometric ID

Titles


id 3 ID of the title

type 3 type of the title

color 3 color of the title

name 3 name of the title

text 3 text displayed in the title

font 3 font used to display the title (1-4)

anchorpoint 3 anchor corner of the title

anchorangle 3 angle from vertical for the title pointer

distance 3 distance from the entity to the border

entityid 3 ID of the entity

typename 3 name of the entity to which the title points

borderon 3 1 if the border is on, else 0

bordercolor 3 color of the border

borderwidth 3 width of the border

borderxmin 3 minimum x value of the border

borderxmax 3 maximum x value of the border

borderymin 3 minimum y value of the border


borderymax 3 maximum y value of the border


Global Variables


counter1 all 1st counter variable

counter2 all 2nd counter variable

counter3 all 3rd counter variable

counter4 all 4th counter variable

















pi all value = PI(3.1415926535...)

pointer1 all 1st pointer variable

pointer2 all 2nd pointer variable

pointer3 all 3rd pointer variable

pointer4 all 4th pointer variable








variable1 all 1st variable

variable2 all 2nd variable

variable3 all 3rd variable

variable4 all 4th variable

















version all the version of HyperMesh

date all the date at output

time all the time at output

machine all the platform running HyperMesh

user all the user running HyperMesh


Vectors - Data Names


id 3 ID of the vector entity

basenode 3 node to which the vector is attached (pointer)

farnode 3 node at the vector tip (if two-node method is used forvector creation; otherwise all values return zero.)

basenodeid 3 ID of the base node

farnodeid 3 ID of the far node; 0, if not used.

xcomp 3 x component of the vector

ycomp 3 y component of the vector

zcomp 3 z component of the vector

magnitude 3 magnitude of the vector

system 3 local coordinate system in which the vector is defined

systemid 3 local coordinate systemid in which the vector is defined

collector 2,3,4 collector that owns the vector

(vector collector pointer)


Using Template Commands

Template commands instruct HyperMesh how to format data and user-defined text for output.Template file commands begin with an asterisk, *, and end with parentheses,.(). Some commandscontain parameters in parentheses, depending on the requirements of the command

Template Commands

*addblock()

Adds a block to a link.

Syntax *addblock(<name>)

Argument <name>

*after()

Indicates that the commands following are processed on the *after() level.

Syntax *after()

*aftercollector()

Indicates that the commands following are processed on the *aftercollector() level.

Syntax *aftercollector()

*assemblies()

Starts an assembly output block. All the assemblies in the HyperMesh database are outputaccording to the user-defined format in this block.

Syntax *assemblies()

Example To output the components in an assembly, the *pointerset()command must be used to retrieve the component IDs:


*counterset(counter1,0)

*loopif([counter1 != numberofcomponents])

*pointerset(pointer1,components,counter1)

*field(integer,pointer1.pointervalue,0)

*counterinc(counter1)

*endloop()

Comments Requires an *output() command at the end of the block.

*before()

Indicates that the commands following are processed on the *before() level.

Syntax *before()

*beforecollector()

Indicates that the commands following are processed on the *before() collector level.

Syntax *beforecollector()

*begincardmenu()

Indicates the beginning of the control cards list.

Syntax *begincardmenu()

Comments Only *cardmenuitem() commands are valid between the*begincardmenu() and *endcardmenu() commands.


*beginlink()

Starts a link.

Syntax *beginlink(<type>,<name>)

Arguments <type>

<name>

Comments Links can be used to tie output blocks together.

*beginmenu()

Indicates the beginning of the description used for the card previewer.

Syntax *beginmenu()

Comments Must be accompanied by the *endmenu() command.

*blocks()

Starts a finite difference block output block. All the blocks in the HyperMesh database are outputaccording to the user-defined format in this block.

Syntax *blocks()

Example To output the locations of the i, j, or k divisions of a block, the*pointerset() command must be used:


*loopif([counter1 != divi])

*pointerset(pointer1,idivisions,counter1)

*field(real,pointer1.pointervalue,8)


*endloop()

To output the wall data for a block, the following commands maybe used:


*loopif([counter1 != wallsmax])


*pointerset(pointer1,blockwall,counter1)

*field(integer,pointer1.wallid,8)

*field(string,pointer1.wallname,0)

*field(integer,pointer1.wallcolor,8)


*endloop()


*cardmenuitem()

Specifies the name and tag attribute for a control card.

Syntax *cardmenuitem(<button text>,<attribute name>)

Arguments <button text> The text that is displayed to you in the controlcards menu. Should be less than 60 charactersin length.

<attribute name> The tag attribute for a control card entity. Thismust have an accompanying*card(<attribute name>) block in thetemplate file.

Comments The *cardmenuitem() commands specify the list that appears in the controlcards menu. If the list is too large to display, previous/next and first/last buttonsare added to the menu so you can page through all options.

The control card buttons are displayed with different colors, depending on theirstatus and their existence in the database. Items with gray text do not exist inthe database. Items with red text exist in the database, but are inactive and arenot written to a file when exporting data. Items with green text exist in thedatabase and are active; and are output when exporting data. Only oneinstance of each type of control card can exist in the database.

*cards()

Starts a control card output block.

Syntax *cards(<card name>)

Argument <card name> The name of the card to output.

Example To output the CTRL_TITLE card the following commands may be used:

*cards("CTRL_TITLE")


*format()

*string("TITLE / ")

*string(" ")

*fieldleft(string,$TITLE_VAL,48)

*end()

*output()

Comments Requires a *output() at the end of the block.

*codename()

Sets a unique solver number to be used for identifying attributes.

Syntax *codename(<solver>,<identifier>)

Arguments <solver> The name of the solver.

<identifier> A unique number identifying the solver.

Comments The *codename() command must occur before the first*defineattribute() command. All attributes created with this template aremarked with this solver identifier.

Solver identifiers 0-63 are reserved for HyperMesh officially supportedtemplates. Solver identifiers 64-127 are available for user-defined templates. Iftwo templates are to share a set of attributes, they should have both the samesolver identifier and the exact set of *defineattribute() commands.

*components()

Starts a component output block. The components in the HyperMesh database are outputaccording to the user-defined format in this block.

Syntax *components(<property name>,<material name>)

Arguments <property name> Used as a key to determine if the propertycards defined by this component are needed.If an element has been output that requiresthe property, the component the elementbelongs to is marked for that property.

<material name> Used as a key to determine if the materialcards defined by this material are needed. Ifa component has been output that requires amaterial, the material collector to which thatcomponent collector points is marked for that


material.

Example If the auto properties flag is turned off when a model is translated, then the usermust define a dictionary item that is given the name <property name> and setit active:

*elements(104,1,"CQUAD4","NAST_PSHELL")

.

.

.

*output()

*components("NAST_PSHELL","MATERIAL")

*define("NAST_PSHELL",none,0.0,1)

.

.

.

*output()

Comments *components() should create the property cards for 2-D and 3-D elements.

Requires an *output() command at the end of the block.

*compressreal()

Changes how trailing zeros for real numbers are written to the output deck.

Syntax *compressreal(<flag>)

Argument <flag> If a <flag> is 1, then trailing zeros are written asblanks.

Comments Using *compressreal(1) causes HyperMesh to write numbers such as0.0000 as 0.0.

*counterinc()

Increments a counter.

Syntax *counterinc(<counter>)

Argument <counter> Value from counter1 to counter20 indicating thecounters to be incremented.


*counterset()

Sets the initial value of the global counter.

Syntax *counterset(<counter>,<value>)

Arguments <counter> Value from counter1 to counter20 indicating thecounter(s) to set to the next parameter.

<value> Value of the counter.

Comments Counters can be useful to specify continuation cards on some analysis codes.For an example, see the NASTRAN template file in HyperMesh.

*cubiclines()

Starts a line output block in parametric cubic format. All of the lines in the database are outputaccording to the user-defined format in the block following the *cubiclines() command.

Syntax *cubiclines(<configuration>)

Argument <configuration>

Comments Requires an *output() at the end of the block.

*curves()

Starts a curve output block. The curves in the HyperMesh database are output according to theuser-defined format in this block.

Syntax *curves()

Example To output the x and y data values for each curve, the followingcommands could be used:


*loopf([counter1 != numberofpoints*2])

*pointerset(pointer1,points,counter1)



*pointerset(pointer1,points,counter1)




*endloop()


*define()

Defines a dictionary item.

Syntax *define(<name>,<type>,<value>,<active>)

Arguments <name> The name of the dictionary item.

<type> The type of the dictionary item.

<value> The initial value assigned to the data item. This shouldbe a number except if the item type is string.

<active> Determines the activity of the dictionary item.

Comments The available types are listed below:

none No value is associated with the item.

string The item has a string assigned to it.

Integer The item has an integer assigned to it.

real The item has a real value assigned to it.

-1 Always active.

0 Not active but user can toggle.

1 Active and user can toggle.

Items whose activity is set to -1 appear white on the dictionary edit menu. Ifthe activity is set to 0 or 1, the menu item appears in cyan, and you maychoose to star the item.


*defineattribute()

Defines an attribute for a solver

Syntax *defineattribute(<name>,<identifier>,<type>,<behavior>)

Arguments <name> The attribute name (maximum of 31characters).

<identifier> The number associated with the attribute.The z can be in the range of 1 to 8192.

<type> The attribute type. Legal values are:

integer Attribute contains an integer

arrayofinteger Attribute contains array of integer numbers

arrayofinteger2d Attribute contains an 2d array ofinteger numbers

real Attribute contains a floating pointnumber

arrayofreal Attribute contains an array of floatingpoint numbers

arrayofreal2d Attribute contains an 2d array offloating point numbers

string Attribute contains a string

arrayofstring Attribute contains an array of strings

entity Attribute contains a reference to anentity (its ID and type)

<behavior> Determines how attributes are treatedwhen the entity that owns it is changed.This field has not been implemented. Theonly value for <behavior> is none.

Comments All entities in the HyperMesh database may point to attributes. Attributes aredefined with the *defineattribute command.


*elementareacalculation()

Determines how to calculate the area of an element.

Syntax *elementareacalculation(<type>,<num>)

Arguments <type> The element type. Only “quad4” is supported.

<num> Can be 1 (one point gaussian quadrature) or 4 (fourpoint gaussian quadrature).

*elementresultstore()

Stores an element value for the current element.

Syntax *elementresultstore(<value>)

Argument <value> The element value to be stored.

Example *function("HM_CALC_TIMESTEP",variable16,variable17,variable18,variable19,variable20)

*elements(60,0,"BEAM","")

... put result into variable1

*elementresultstore(variable1)

*output()

*return()

Comments This command can be used in the template function, HM_CALC_TIMESTEP, tostore the initial time step for each element. When time steps have been saved,an assigned plot can be created in the check elements panel.

This function must be called in the *format() section of an *elements()block.


*elements()

Starts an element output block. The elements in the HyperMesh database whose configuration andtype are equal to the parameters are output according to the user-defined format defined in thisblock.

Syntax *elements(<configuration>,<type>,<user name>,<property name>)

Arguments <configuration> Defines the HyperMesh element that should beoutput using this block definition. See the previoustable describing element configurations and valuesdefined for each element. If the <config> suppliedis 0, HyperMesh outputs all elements of thespecified config. The possible values are listedbelow:

Config Element Output

0 Any element

1 Mass

2 Plot

3 Weld

5 Rigid

20 Spring

21 Spring

50 Bar (use 60 instead)

51 Rod (use 61 instead)

52 Beam (use 60 instead)

55 Rigidlink

56 RBE3

60 Bar2

63 Bar3

61 Rod

70 Gap

103 Tria3


104 Quad4

106 Tria6

108 Quad8

123 Master3

124 Master4

133 Slave3

134 Slave4

135 Slave1

204 Tetra4

206 Penta6

208 Hex8

210 Tetra10

215 Penta15

220 Hex20

<type> Defines the element type that should beoutput using this block definition. Thepossible values are user-defined so that moreelement types can be defined by the user. Tochange the type of an element in HyperMesh,see the elem types panel.

If <type> supplied is 0 (zero), HyperMeshoutputs all elements of the givenconfiguration.

<user name> A 32-character string enclosed in doublequotes holding the name of the element asdefined by the user. The name is displayedby the elem types panel to the user forselection.

<property name> A 32-character string enclosed in doublequotes holding the name of the property thatthe elements require. The name is used bythe collectors panel to load the dictionariesdefined in this block, and also to link to the*components() and *properties()command.



*else()

Used to define the false block of an if-statement.

Syntax *else()

*enabledatabase()

Used to scan for entities in the HyperMesh database.

Syntax *enabledatabase(<flag>)

Argument <flag> The flag can be set to all or selected.

If you set the flag to all, the entity output commands(such as *nodes()) scan all entities in the database,even if you select displayed on the export orsummary panels.

If you set the flag to selected, and you select displayedon the export or summary panels, the entity outputcommands scan the database for the displayedcommands only.

Comments When writing export and summary templates, it may be necessary to scanthe entire database before processing the displayed entities. To do this,use *enabledatabase(all). To scan the database for only theentities that you selected (this can be all or displayed), use*enabledatabase(selected). *enabledatabase() should beused outside of any other command blocks and can be used more thanonce.

*end()

Places an end-of-line character in the data deck being generated.

Syntax *end()

Comments This command ends the current line and places the outputcursor at the beginning of the next line in the output file.


*endcardmenu()

Indicates the end of the control cards list.

Syntax *endcardmenu()

*endif()

Used to define the end of an if-block.

Syntax *endif()

*endlink()

Ends a link.

Syntax *endlink()

*endloop()

Indicates the end of a block that was initialized with the *loopif() command.

Syntax *endloop()

*endmenu()

Indicates the ending of the description used for the card previewer.

Syntax *endmenu()

Comments Must be accompanied by the *beginmenu()command.

*endsegments()

Ends a segment block.

Syntax *endsegments()


*entitypointerset()

Sets the initial value of a specified entity.

Syntax *entitypointerset(<entity type>, <entity id>, <pointernumber>, <pointer>, <value>)

Arguments <entity type> The type of entity, such as sets, elems,or nodes, to which <entity id>refers.

<entity id> The ID of the entity you want toreference.

<pointer number> Value from pointer1 to pointer10,indicating which of the 10 possiblepointers to use as the <value>parameter.

<pointer> Points to the data object that isaccessed. Only certain data types mayuse pointers. These are described inthe template commands in which theyare valid.

<value> The value of the pointer.

Comments *entitypointerset() can be used on any entity specified by <entitytype> and <entity id>.

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

Syntax *equations(<type>, <user name>)

Arguments <type> The user-defined type that is output.

<user name> The user-defined name for <type>.

Example The following example outputs equations in a format similar to ABAQUS:

*equations(0,"EQUATION")

*format()

*string("*EQUATION") *end()

*counterset(counter1,[independentnodesmax+1])


*field(integer,counter1,0)

*end()

*field(integer,dependentnode.id,0)

*string(",")

*field(integer,dependentdof,0)

*string(",")

*field(real,dependentcoeff,0)

*string(",")


*loopif([counter1 < independentnodesmax])

*pointerset(pointer1,independentnodes,counter1)


*string(",")

*pointerset(pointer1,independentdofs,counter1)


*string(",")

*pointerset(pointer1,independentcoeffs,counter1)



*endloop()

*end()

*output()

*errormessage()

Displays an error message on the menu bar.

Syntax *errormessage (<string>)

Arguments <string> String to be displayed

Example The example below displays an error for each quad4 that has a jacobian lessthan .7:

*elements(104,0,"","")


*format()

*if([jacobian < .7])

*errormessage("jacobian less than .7")

*endif()

*output()

Comments Each time *errormessage() is called, it overwrites the last error message. Ifthe right mouse button is pressed while printing an error message, HyperMeshstops processing the template.

*field()

Places a formatted value from the database into the output file.

Syntax *field(<type>,<data name>,<width>)

Arguments <type> Either integer, unsigned, real, exponential, string,hexadecimal, or quoted. For simplicity, the first letter isrequired; all others are optional but recommended.

<data name> The name of the data to be accessed.

<width> The width of the formatted field. In the case of real,HyperMesh uses scientific notation in order to makethe value printed fit.

*fieldleft()

Places a left-justified, formatted value from the database into the output file.

Syntax *fieldleft(<type>,<data name>,<width>)



<width> Width of the formatted field. In the case of real,HyperMesh uses scientific notation in order to makethe value printed fit.


*fieldright()

Places a right-justified, formatted value from the database into the output file.

Syntax *fieldright(<type>,<data name>,<width>)



<width> The width of the formatted field. In the case of real,HyperMesh uses scientific notation in order to makethe value printed fit.

*format()

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

Syntax *format()

*function()

Starts a function block.

Syntax *function(<name>,<variables>)

Arguments <name> The name of the function. Names should not beginwith HM_ (these are reserved for use by HyperMesh.

<variables> The variables to be returned to HyperMesh (variable1 -variable20). The number of variables depends on thefunction. Functions can be used by HyperMesh tocalculate information needed in some panels.

Example For example, the mass panel calls the function HM_ELEMENT_MASS to calculatethe area (first variable) volume (second variable) and mass (third variable) of aset of elements:

*function("HM_ELEMENT_MASS,variable1,variable2,variable3)

*elements(1,1,"MASS","")

*before()

*variableset(variable1,0) // Area


*variableset(variable2,0) // Volume

*variableset(variable3,0) // Mass

*format()

*variableset(variable3,[variable3 +

@magnitude($MASS_ADDMX,$MASS_ADDMY,$MASS_ADDMZ)])

*output()

*return()

*geometryoverride()

Overrides the lines option on the export data panel and activates lines for output.

Syntax *geometryoveride()

*globaldefaults()

Used to specify that each real, integer, and string attribute is modified as per the*menudefaultvalue().

Syntax *globaldefaults()

Comments Any default value not overridden by a*menudefaultvalue() fills the field with the number ofblanks equal to the width parameter in the *menufield()command when the field has the status off.*menudefaultvalue() can still be used to specify adifferent default value for individual fields when needed.

*groups()

Starts a group output block. The groups in the HyperMesh database whose configuration and typeare equal to the parameters are output according to the user-defined format in this block.

Syntax *groups(<configuration>,<type>,<user name>)

Arguments <configuration> Defines the HyperMesh group that should beoutput using this block definition. The possiblevalues are:

ConfigGroup Output


1 Interface with master andslave elements

2 Interface with masterelements and slave nodes

3 Interface with slaveelements

4 Interface with slave nodes

5 Rigid walls

<type> Defines the group type that should be outputusing this block definition. The possible valuesare user-defined so that more types can bedefined by the user. When groups are built, thetemplate file is read automatically to determinethe type of the group.

<user name> A 32-character string enclosed in double quotesholding the name of the group as defined by theuser. The name is used by the appropriatepanels and displayed to the user for selection.


*if()

Used to conditionally execute branches of code.

Syntax *if([<expression>])

Argument <expression> Relational expression.

Example This command is useful for testing and acting on a condition. For example, usersmay wish to output only nodes having a z value of zero. The following is anexample of this situation:

*nodes()

*format()

*if([z == 0.0])

<instructions for node format>

*endif()

*output()

Comments Requires an *endif() command.


The expression is required to be enclosed in square brackets.

The following operators are available:

==, = equal

!= not equal

<= less than or equal

< less than

>= greater than or equal

> greater than

% modulus

*include()

Includes a file from the include directory.

Syntax *include(<filename>)

Argument <filename> The file identified by must be in the include directorywhere the template is located.

Comments *include() can be used to insert a series of template commands that areused by multiple templates.

*include()files can reference other *include() files in the same directory,but make sure you do not create an infinite *include() loop.

*lines()

Starts a line output block. All of the lines in the database are output according to the user-definedformat in the block following the *lines() command.

Syntax *lines(<configuration>)

Argument <configuration>



*loadcols()

Starts a load collector output block.

Syntax *loadcols(<name>)

Argument <name>


*loads()

Starts a load output block. The loads in the HyperMesh database whose configuration is equal tothe parameter configuration, and whose type is equal to the parameter type are output according tothe user-defined format in this block.

Syntax *loads(<config>,<type>,<user name>)

Arguments <config> Defines the configuration of the load that is outputusing this block definition and has the followingpossible values:

ConfigLoad Output

0 Any load

1 Forces

2 Moments

3 Constraints

4 Pressures

5 Temperatures

6 Fluxes

8 Velocities

9 Accelerations

If the config supplied is 0 (zero), all loads of thegiven type are output.

<type> Defines the type of load being defined. The <type>parameter allows users to define multiple types ofloads per configuration. If the type supplied is 0(zero), all loads of the given config are output.


<user name> Defines the name of the load being defined.


*loadsteps()

Starts a loadsteps output block.

Syntax *loadsteps()

Comments Each loadstep contains a list of IDs for the load collectorswithin that step.

Requires a *output() at the end of the block.

*loopif()

Conditionally executes a block of code while a condition is true.

Syntax *loopif([<expression>])

Argument <expression> A relational expression.

Example If <expression> evaluates to a nonzero value, then the statements containedwithin the loop block are executed. The example below shows the usage of theloop:


*loopif([counter1 <= 5])

*end()


*endloop()

*markfailed()

Marks an element as failed when used in the check elements panel (user subpanel)

Syntax *markfailed()

Example To mark quads that have a side shorter than .1, the followingcommands may be used:


*elements(104,0,"","")

*format()

*if([shortestside < .1])

*markfailed()

*endif()

*output()

Comments The command must only be used in a template file used withthe user subpanel of the check elements panel.

It is used to mark an element that has failed a user-definedelement check (the element will be highlighted). It can only beused within a *elements block. The element is also put inthe user mark.

*materials()

Starts a material output block. The material in the HyperMesh database is output according to theuser-defined format in this block.

Syntax *materials(<material name>)

Argument <material name> Used as a key to determine if the materialcards defined by this material are needed. If acomponent or property collector has beenoutput that requires a material, the materialcollector to which that component or propertycollector points is marked for that material.

*menuentitypointerset()

Sets the initial value of a specified entity.

Syntax *menuentitypointerset(<entity type>, <entity id>, <pointernumber>, <pointer>, <value>)

Arguments <entity type> The type of entity, such as sets, elems, ornodes, to which <entity id> refers.

<entity id> The ID of the entity you want to reference.

<pointer number> Value from pointer1 to pointer20, indicatingwhich of the 20 possible pointers to use as the<value> parameter.


<pointer> Points to the data object that is accessed. Onlycertain data types may use pointers. These aredescribed in the template commands in whichthey are valid.

<value> The value of the counter.

Comments *menuentitypointerset() can be used on any entity specified by<entity type> and <entity id>.

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

Syntax *nodes(<configuration>)

Argument <configuration> Defines the type of node to output in this block.Since HyperMesh only allows one type of node,this parameter is ignored but is allowed forfuture compatibility.

Comments The following commands are available to sort nodes within the templatesystem:

*sortnodes(byinputsystem)

*sortnodes(byoutputsystem)

*sortnodes(byid)

*sortnodes(none)

The first three commands turn sorting on until it is turned off with*sortnodes(none).

This command requires an *output() at the end of the block.

*nomenu()

Specifies that the card image definition is in a following block.

Syntax *nomenu()

Comments The *nomenu() command must be the first command tofollow an entity block header.


*output()

Outputs the data defined in the preceding block.

Syntax *output()

Comments Requires a preceding block definition.

*outputblocks()

Starts an outputblocks block.

Syntax *outputblocks()

Example *outputblocks contain a list of element or node IDs. Anexample is shown below:

*outputblocks()

*format()

*if([type == 1])


*loopif([counter1 <= idsmax])

*pointerset(pointer1,ids,[counter1-1])

*string("NOD: ")



*endloop()

*endif()

*if([type == 2])


*loopif([counter1 <= idsmax])

*pointerset(pointer1,ids,[counter1-1])

*string("ELE: ")



*endloop()

*endif()


*output()

*plots()

Starts a plot output block. The plots in the HyperMesh database are output according to the user-defined format in this block.

Syntax *plots()

Example To output the IDs of the curves in a plot, the followingcommands should be used:


*loop([counter1 != numberofcurves])

*pointerset(pointer1,curves,counter1)



*endloop()


*pointerset()

Sets the initial value of a pointer.

Syntax *pointerset(<pointer number>,<pointer>,<value>)

Arguments <pointer number> Value from pointer1 to pointer10 indicating which ofthe 10 possible pointers should be set to the <value>parameter.

<pointer> The pointer to the data object to be accessed. Onlycertain data types may use pointers. These aredescribed in the template commands in which theyare valid.

<value> The value of the pointer.

Example For example, to output all the dictionary entries for a component, the followingcommands could be used while in the component block:


*loopif([counter1 != dictionarymax])


*pointerset(pointer1,dictionary,counter1)

*field(string,pointer1.name,0)

*field(integer,pointer1.type,0)

*field(string,pointer1.string,0)

*field(real,pointer1.value,8)


*endloop()

*points()

Starts a points output block.

Syntax *points()


*properties()

Starts a property output block. The properties in the HyperMesh database are output according tothe user-defined format in this block.

Syntax *properties(<property name>,<material name>)

Arguments <property name> Used as a key to determine if the property cardsdefined by this property are needed. If anelement has been output that requires aproperty, the property collector to which thatelement points is marked for that property.

<material name> Used as a key to determine if the material cardsdefined by this material are needed. If aproperty has been output that requires amaterial, the material collector to which thatproperty collector points is marked for thatmaterial.

Comments If the auto properties flag is turned off when a model is translated, then the usermust define a dictionary item that is given the name <property name> andset it active:

*elements(60,1,"CBAR","NAST_PBAR")

.


.

.

*output()

*properties("NAST_PBAR","NAST_MAT1")

*define("NAST_PBAR",none,0.0,1)

.

.

.

*output()

*properties() should create the property cards for elements of type 21, 60,and 61.

*quote()

Writes a quotation (") character.

Syntax *quote()

*rangeadd()

Add a number to a list so that ranges can be found with @rangecount(), @rangestart(), and@rangeadd().

Syntax *rangeadd(<number>)

Argument <number> The integer number to add to the list.

Example *elements(104,0,"","")

*format()

*rangeadd(id)

*after()


*loopif([counter1 <= @rangecount()])

*string("start of range = ")

*field(integer,[@rangestart(counter1)],0)


*end()

*field(integer,[@rangeend(counter1)],0)

*end()


*endloop()

*rangereset()

*output()

Comments Use *rangeadd() to add numbers to a list. Once all numbers have beenadded, @rangecount() returns the number of ranges (e.g. 1-5, 10-20) thatare in the list. Use the functions @rangestart() and @rangeend() to getthe actual ranges.

*rangereset()

Resets the list of numbers stored with *rangeadd().

Syntax *rangereset()


*format()

*rangeadd(id)

*after()





*end()

*string("end of range = ")


*end()


*endloop()

*rangereset()


*output()

Comments Use *rangeadd() to add numbers to a list. Once all numbers havebeen added, @rangecount returns the number of ranges (e.g. 1-5,10-20) that are in the list. Use the functions @rangestart() and@rangeend() to get the actual ranges. *rangereset() removesall numbers from the list.

*realprecision()

Sets the number of significant figures after the decimal point for real numbers.

Syntax *realprecision (<int digits>)

Argument <digits> The number of significant figures to be used for all realvalues after the command in the template file. A zero(default) uses all available spaces in the field width.

Comments This command results in values being rounded, according to IEEEspecifications, to fit in the specified precision.

Enabling the *compressreal() toggle truncates trailing zeros that areprodcued by this setting.

*return()

Ends a function block

Syntax *return()

*scalefieldwidth()

Scales the width of a field.

Syntax *scalefieldwidth(<field type>, <scalefactor>)

Arguments <field type> Specifies which field type to scale. Validvalues are “integer”, “real”, and “string”.

<scalefactor> The scale factor to apply to each field of<field type>. Typically, this value is 1or 2.

Example To print the node IDs and globalx values with a width of 16 instead of 8:


*nodes()

*before()

*variableset(variable1,2)

*scalefieldwidth(real,variable1)

*scalefieldwidth(integer,variable1)

*format()

*string("*")


*string("*")

*end()

*string("*")

*fieldleft(real,globalx,8)

*string("*")

*end()

*output()

Comments This command is typically used to write a deck that contains double precisionnumbers which have twice the field width specified by the *field command.

*segments()

Starts a segment output block.

Syntax *segments()

Comments Requires an *endsegments() command.

*setcollector()

Sets the current collector based on the last *pointerset() command. This is commonly usedwith loadsteps. You can also use this command with sets that contain components.

Syntax *setcollector()

Example The loadsteps entity contains the ids of loadcollectors for that step. Tooutput the loads within each loadcollector:

*loadsteps()


*format()

*string("SUBCASE")


*end()


*loopif([counter1 < idsmax ])

*pointerset(pointer1,ids,counter1)

*setcollector()

*loads(3,1,"SPC")

*before()


*format()

*if([counter2 == 0])

*string("SPC")


*end()

*endif()


*output()


*endloop()

*output()

*sets()

Starts a set output block. The sets in the HyperMesh database are output in the user-definedformat contained within this block.

Syntax *sets()

Example To output all the sets and their IDs, the following commands could beused while in the set block:

*format()


*if([type == 1])

*string("node set")

*else()

*string("elemen set")

*endif()

*field(string,name,0)

*end()


*loopif([counter1 != idsmax])

*pointerset(pointer1,ids,counter1)


*end()


*endloop()


*sortelements()

Changes the order that elements are output in the *elements() block.

Syntax *sortelements (<sort type>)

Argument <sort type> bymaterialid sort elements by material. Allelements in one material areoutput together.

none sorting is not performed. Theelements are output in the orderthey are listed in the database.

Example The following example outputs a list of element IDs sorted by material:

*elements(104,0,"","")

*before()


*sortelements(bymaterialid)


*format()

*if([variable1 != collector.materialid])

*string("elements in material")

*field(integer,collector.materialid,0)

*end()

*variableset(variable1,collector.materialid)

*endif()

*string("id = ")


*end()

*output()

*sortloads()

Changes the order that loads are output in the *loads() block.

Syntax *sortloads(<sort type>)

Argument <sort type> bycomp1 sort loads by comp1

bycomp2 sort loads by comp2




bycomp6 sort loads by comp 6

bycomps sort loads by all components

none sorting is not performed

Example The following example outputs all forces in the same x direction, followed by thesame y direction and then the same z direction:

*loads(1,0,"")

*sortloads(bycomp1)

*before()



*format()

*if([comp1 != variable1])

*end() *end()

*string("FORCE x = ") *field(real,comp1,0) *end()

*variableset(variable1,comp1)

*endif()

*string(" ") *field(integer,id,0) *string(" ")

*after()

*end()

*output()

*loads(1,0,"")

*sortloads(bycomp2)

*before()


*format()


*end() *end()

*string("FORCE y = ") *field(real,comp2,0) *end()


*endif()


*after()

*end()

*output()

*loads(1,0,"")

*sortloads(bycomp3)

*before()


*format()



*end() *end()

*string("FORCE z = ") *field(real,comp3,0) *end()


*endif()


*after()

*end() *end()

*output()

*sortnodes()

Changes the order that nodes are output in the *nodes() block.

Syntax *sortnodes(<sort type>)

Argument <sort type> byid sort nodes by ID

byinputsystem sort nodes byinputsystem ID

byoutputsystem sort nodes byoutputsystem ID

none sorting is not performed.The nodes are output inthe order they are listedin the database.

Example The following example outputs nodes sorted by their ID:

*nodes()

*sortnodes(byid)

*format()

*string("id = ")


*end()

*output()


*string()

Outputs a string to the output file.

Syntax *string(<string>)

Argument <string> A string of characters. If the string contains a space,an asterisk, or a comma, the string must be enclosedby double quotes.

*stringtablereset()

Resets the string lookup table.

Syntax *stringtablereset()

*stringtablestore()

Stores an entry into the string lookup table.

Syntax *stringtablestore(<key>,<value>)

Arguments <key> Assigned to a string lookup table entry and is used bythe @stringlookup() function to find stored entries.<key> can be a data name or a literal string enclosedin double quotes.

<value> The value assigned to an entry in the string lookuptable and is returned by @stringlookup().

Example The example below stores the string shells in the string lookup table with a valueof 10:

*stringtablestore("shells",10)

The example below saves component names with a value of 1 in the string table:

*components("","")

*format()

*stringtablestore(name,1)

*output()


*surfaces()

Starts a surface output block.

Syntax *surfaces()


*systcols()

Starts a system collector output block.

Syntax *systcols()


*systems()

Starts a system output block. All of the systems in the database are output according to the user-defined format in the block following the *systems() command.

Syntax *systems()

Comments Requires an *output() at the end of the output block definition.

*tablereset()

Resets the lookup table.

Syntax *tablereset()

*tablestore()

Stores an entry in the lookup table.

Syntax *tablestore(<key>,<value>)

Arguments <key> Assigned to a lookup table entry and is used by the@lookup() function to find stored entries.

<value> The value assigned to an entry in the lookup table andis returned by @lookup().


*text()

Starts a block that contains text.

Syntax *text()


This block provides an easy method of outputting a series ofstrings.

*titles()

Starts a title output block. All of the titles in the database are output according to the user-definedformat in the block following the *titles() command.

Syntax *titles()

Comments Requires an *output() at the end of the output blockdefinition.

*variableset()

Sets a variable to a specific value.

Syntax *variableset(<variable>,<value>)

Arguments <variable> A value from variable1 to variable20 indicating which ofthe 20 possible variables should be set to the nextparameter.

<value> The value of the variable.

Example Variables can be used to hold real or integer values. For example, to add thevalue of variable5 to the current value of variable1, the following command couldbe used:

*variableset(variable1,[variable1+variable5])


*vectorcols()

Starts a vector collector output block.

Syntax *vectcols(<name>)

Argument <name> The name of the output block.


*vectors()

Starts a vectors output block.

Syntax *vectors()


*vectortablereset()

Resets the vector lookup table.

Syntax *vectortablereset(<type>,<tolerance>)

Arguments <type> The type of the vector lookup table. This determineshow the vectors in the lookup table are comparedagainst the key values sent by the @vectorlookup()function. Set this to 0, if the vectors represent nodelocations in space and the distance between the twonodes is the criteria for vectors being equal. Set this to1, if the vectors represent vectors and the anglebetween the two vectors is the criteria for vectors beingequal.

<tolerance> The tolerance used to determine if a vector in thelookup table is equal to a key vector.


*vectortablestore()

Stores an entry into the vector lookup table.

Syntax *vectortablestore(<key>,<x comp>,<y comp>,<zcomp>,<value>)

Arguments <key> The key assigned to the lookup table entry. This isused by the @vectorlookup() function to find storedentries.

<x comp> The x component of the vector assigned to a lookuptable entry. This is used by the @vectorlookup()function to find stored entries.

<y comp> The y component of the vector assigned to a lookuptable entry. This is used by the @vectorlookup()function to find stored entries.

<z comp> The z component of the vector assigned to a lookuptable entry. This is used by the @vectorlookup()function to find stored entries.

<value> The value assigned to an entry in the lookup table.This value is returned by @vectorlookup().

*writegeometry()

Outputs the Altair geometry database in an internal ASCII format.

Syntax *writegeometry(<string>)

Arguments <string> A small string to be inserted at the beginning of eachline to serve as a comment character.

Comments This format is designed to be read in with the hminlib functionHM_writegeomdata().


Using Template Functions

The HyperMesh template functions allow you to query information in the database, such as the@count function, perform mathematical functions, and query user-defined tables. A template functionbegins with the at symbol, @, and is followed by the variable arguments in parentheses. Templatefunctions are placed between square brackets, [ ].

Using a Template Function Command - Example

The following example program finds the length of all weld elements and prints them to a file.

*elements(3,0,"","")

*format()


*string(" ")

*field(real,[@magnitude(

node1.x - node2.x,

node1.y - node2.y,

node1.z - node2.z)],10)

*end()

*output()

Template Functions

@acos()

Trigonometric arc cosine of x, the result is expressed in radians between 0 and π .

Syntax @acos(<x>)

Argument <x> Value of type real.


@asin()

Trigonometric arc sine of x, the result is expressed in radians between -π /2 and π /2.

Syntax @asin(<x>)


@atan()

Trigonometric arc tangent of x, the result is expressed in radians between -π /2 and π /2.

Syntax @atan(<x>)


@atan2()

Trigonometric arc tangent of x/y, with the result is expressed in radians between -π and π .

Syntax @atan2(<x>,<y>)

Arguments <x> Value of type real, and should be expressed in radians.

<y> Value of type real, and should be expressed in radians.

@attributearray2dcols()

Returns the number of columns in a 2-D array attribute.

Syntax @attributearray2dcols(attribute)

Argument <attribute> The name of the attribute (must start with '$').


@attributearray2drows()

Returns the number of rows in a 2-D array attribute.

Syntax @attributearray2drows(attribute)


@attributearray2dvalue()

Returns the value of a 2-D array attribute.

Syntax @attributearray2dvalue(attribute,row,column)

Arguments <attribute> The name of the attribute (must start with '$')

<row> The row number (starting at 1)

<column> The column number (starting at 1).

@attributearraylength()

Returns the length of a 1-D array attribute.

Syntax @attributearraylength(attribute)


@attributearrayvalue()

Returns the value of 1-D array attribute.

Syntax @attributearrayvalue(attribute,index)

Arguments <attribute> The name of the attribute (must start with '$')

<index> Index into the array (starting at 1)


@attributeindexarray2dcols()

Returns the number of rows for a 2-D array attribute on an entity.

Syntax @attributeindexarray2dcols(<entity index>)

Argument <entity index> The index of the attribute owned by thecurrent entity (starting at 1).

@attributeindexarray2drows()

Returns the number of rows for a 2-D array attribute on an entity.

Syntax @attributeindexarray2drows(<entity index>)


@attributeindexarray2dvalue()

Returns the value of a 2-D array attribute on an entity.

Syntax @attributeindexarray2dvalue(<entity index>,<row>,<col>)

Arguments <entity index> The index of the attribute owned by thecurrent entity (starting at 1).

<row> and <col> Indices into the attribute array (both startat 1).

@attributeindexarraylength()

Returns the length of a 1-D array attribute on an entity.

Syntax @attributeindexarraylength(<entity index>)

Argument <entity index> The index of the attribute owned by the currententity (starting at 1).


@attributeindexarrayvalue()

Returns the value of a 1-D array attribute on an entity.

Syntax @attributeindexarrayvalue(<entity index>,<array index>)

Arguments <entity index> The index of the attribute owned by the currententity (starting at 1).

<array index> The index into the attribute array (starting at 1)

@attributeindexbehavior()

Returns the behavior of an attribute on an entity.

Syntax @attributeindexbehavior(<entity index>)


@attributeindexentityid()

Returns the entity ID of an entity attribute on an entity.

Syntax @attributeindexentityid(<entity index>)


@attributeindexentitytype()

Returns the entity type (number) of an entity attribute on an entity.

Syntax @attributeindexentitytype(<entity index>)



@attributeindexentitytypename()

Returns the entity type (string) of an entity attribute on an entity.

Syntax @attributeindexentitytypename(<entity index>)


@attributeindexidentifier()

Returns the identifier of an attribute on an entity.

Syntax @attributeindexidentifier(<entity index>)


@attributeindexsolver()

Returns the solver of an attribute on an entity.

Syntax @attributeindexsolver(<entity index>)


@attributeindexstatus()

Returns the status of an attribute on an entity.

Syntax @attributeindexstatus(<entity index>)



@attributeindextype()

Returns the type of attribute on an entity.

Syntax @attributeindextype(<index>)

Argument <index> The index of the attribute owned by the current entity(starting at 1). The return types are:

1 integer

2 double

3 string

4 1-D integer array

5 1-D double array

6 entity

7 (not supported)

8 (not supported)

9 2-D integer array

10 2-D double array

11 string array

Example If you want to print the types of all attributes on nodes:

*nodes()

*format()


*loopif([counter1 <= attributesmax])

*field(integer,[@attributeindextype(counter1)],5)

*end()

*coutnerinc(counter1)

*endloop()

*output()


@attributeindexvalue()

Returns the value of an attribute on an entity.

Syntax @attributeindexvalue(<entity index>)


@attributereferencecount()

Returns the number of times an entity is referenced by an attribute.

Syntax @attributereferencecount(<entity type>, <id>)

Arguments <entity type> The type of entity referenced.

<id> The entity ID.

Example If you want to output only curves that are referenced, such as by a material orload, use an *if statement as follows:

*curves()

*format()

*if([@attributereferencecount(curves,id) > 0)])

*string(“Load Curve #”)


*end()

*endif()

*output()

The block above writes out only referenced curves, and those generated viapost-processing operations are omitted (if they are not pointed to by an attribute).


@checkfile()

Checks for a file.

Syntax @checkfile(<file name>)

Argument <file name> File name to be checked.

Example *text()

*if([@checkfile(\tmp\file)=1])

*string(“file exists”)

*else()

*string(“file does not exist”)

*endif()

*output()

Comments Return 1 if the file exists. On a PC, use backslashes for the path (\tmp\file).On UNIX, use forward slashes for the path (/tmp/file).

@controlcardattributedefined()

Returns 1 if an attribute exists, 0 otherwise

Syntax @controlcardattributedefined(<ctrl card name>, <attributename>)

Arguments <ctrl card name>

<attribute name>

Comments If a control card or attribute is not defined, a 0 is returned.

@cos()

Trigonometric cosine of x, where x is expressed in radians.

Syntax @cos(<x>)

Argument <x> A value of type real.


@count()

Counts the entities in the database.

Syntax @count(<entity type>, <config>, <type>)

Arguments <entity type> The type of entity to be counted. This parametermay be set to any of the entities in the database.

<config> The configuration number of the entities to becounted. This parameter is used only if <entitytype> is set to elements or loads. If set to zero,the entities are counted regardless of theirconfiguration.

<type> The type number of the entities to be counted.This parameter is used only if <entity type> isset to elements. If set to zero, all of the entitiesare counted regardless of their type.

Comments If the displayed option is selected (active) on the export data panel, the valuereturned by @count() includes only those entities that are currently displayed.

@defaultstatus()

Returns the default status of an attribute.

Syntax @defaultstatus(<attribute name>)

Comments If the attribute is set to the default value (grayed out in the card previewer), thefunction returns 1; otherwise, it returns 0.

@defined()

Tests to see if a dictionary item is defined.

Syntax @defined(<dictionary item>)

Argument <dictionary item> The name of a dictionary item. Thisfunction returns 1 if the dictionary itemis active or 0 if the dictionary item isnot active. If the dictionary item doesnot exist, the function returns 0.

Comments This function allows dictionary items to be set as a toggle that the user canturn off and on. During translation, @defined() can be used to see if theitem has been toggled on or off.


@dofs()

Extracts individual degrees of freedom from an integer and returns the status

Syntax @dofs(<dof>,<position>)

Arguments <dof> Generally an integer beam end release code thatreturns 1 or 0 (on or off) if the integer in<position> is contained within the <dof> field.

<position>

Example @dofs(123,1) = 1, @dofs(456,1) = 0

@entitygettype()

Gets the user-assigned type of an entity. The user-assigned entity type is set in the template.

Syntax @entitygettype(<entity type>, <entity id>)

Arguments <entity type> The type of entity to be retrieved,such as elems. This parametermay be set to any entity type.

<entity id> The ID of the entity.

@entityincollector()

Returns the number of entities in a collector.

Syntax @entityincollector(<entity type>, <config>, <type>)

Arguments <entity type> Defines the type of entity to becounted.

<config> Defines the configuration number ofthe entities being counted. If set to0, entities are counted regardless oftheir configuration.

<type> Defines the type number of theentities being counted. If set to 0,entities are counted regardless oftheir type.


@entitymaxid()

Returns the maximum ID in use from a type of entity.

Syntax @entitymaxid(<entity type>)

Argument <entity type> The type of the entity.

@enum()

Returns the value of an enumeration.

Syntax @enum(<enum name>,<enum index>)

Arguments <enum name> The name of the enumeration.

<enum index> The index into the enumeration (starting at1).

@exists()

Indicates if a pointer is pointing to an entity or if it is set to NULL.

Syntax @exists(<pointer>)

Argument <pointer> A pointer to an entity. If the pointeris pointing to an entity, the functionreturns 1. If not, the function returns0.

@exp()

Exponential of x.

Syntax @exp(<x>)


Example @exp(2) = e2 = (2.718281828...)2 = 7.389056...


@fabs()

Absolute value of x.

Syntax @fabs(<x>)


@getcollectorname()

Retrieves the name of a collector.

Syntax @getcollectorname(<collector type>,<collector id>)

Arguments <collector type> The type of collector (such asproperties or components).

<collector id> The ID of the collector.

@getcontrolcardattribute()

Returns the value of an attribute on a control card.

Syntax @getcontrolcardattribute(<controlcard>,<attribute>)

Arguments <control card> The name of the control card.

<attribute> The attribute name.

Comments If a control card and/or attribute is not present, an error occurs. Use@acontrolcardattributedefined() to verify the existence of acontrol card or attribute.


@getentityvalue()

Retrieves the value of an entity.

Syntax @getentityvalue(<entity type>, <entity id>, <dataname>)

Arguments <entity type> The type of entity, such as sets,elems, or nodes, to which <entityid> refers.

<entity id> The ID of the entity you want toreference.

<data name> The data name of the entity. Forexample, ID, name, node1.globalx.

Example To output the name of a set with the ID, 1:

*field (string,[@getentityvalue(sets, 1, name)],32)

Comments The @getentityvalue function allows you to get a value from anentity if you know the entity’s type and ID. It allows you to get a valueof the collector which contains an entity. This function searches thedatabase and may access the data values slower than othercommands, such as *sets().

@log()

Natural logarithm.

Syntax @log(<x>)


Example @log(2) = LN(2) = 0.693147

@log10()

Logarithm of x to the base 10.

Syntax @log10(<x>)


Example @log(100) = Log10(100) = 2.000


@lookup()

Retrieves a value stored in a lookup table.

Syntax @lookup(<key>)

Argument <key> Used to compare the keys found on thelookup table entries. If <key> matches oneof the keys in the lookup table, the functionreturns the value associated with that entry.If a matching key is not found, the functionreturns 0.

@magnitude()

Returns the magnitude of a vector.

Syntax @magnitude(<x comp>, <y comp>, <z comp>)

Argument <x comp>, <y comp>,and <z comp>

The components of the vector to beevaluated.

@pow

Returns the real value of X raised to the power Y.

Syntax @pow(<x>,<y>)

Arguments <x> A value of type real.

<y> A value of type real.

Example @pow(2.0, 3.0) = 2.03 =8.0


@rangecount()

Returns the number of ranges for the numbers used with *rangeadd().

Syntax @rangecount()


*format()

*rangeadd(id)

*after()





*end()



*end()


*endloop()

*rangereset()

*output()

Comments Use *rangeadd() to add numbers to a list. Once all numbers havebeen added, @rangecount() returns the number of ranges (e.g. 1-5,10-20) that are in the list. Use the functions @rangestart() and@rangeend() to get the actual ranges.


@rangestart()

Returns the starting range of a range of numbers.

Syntax @rangestart(<range>)

Argument <range> The range number, starting at 1.


*format()

*rangeadd(id)

*after()





*end()



*end()


*endloop()

*rangereset()

*output()

Comments Use *rangeadd() to add numbers to a list. Once all numbers havebeen added, @rangecount() will return how many ranges, such as1-5, 10-20, are in the list. Use the functions @rangestart() and@rangeend() to get the actual ranges.


@rangeend()

Returns the ending range of a range of numbers.

Syntax @rangeend(<range>)

Argument <range> The range number, starting at 1.


*format()

*rangeadd(id)

*after()





*end()



*end()


*endloop()

*rangereset()

*output()

Comments Use *rangeadd() to add numbers to a list. Once allnumbers have been added, @rangecount() returns howmany ranges , such as 1-5, 10-20, are in the list. Use thefunctions @rangestart() and @rangeend() to get theactual ranges.

@sin()

Trigonometric sine of x, where x is expressed in radians.

Syntax @sin(<x>)



@sqrt()

Returns the square root of a number.

Syntax @sqrt(<x>)

Comments The square root of z is returned. If <x> is negative, an erroris reported.

@stringequal()

Compares two strings, and returns 1 if they are equal; otherwise, 0.

Syntax @stringequal(<string1>,<string2>)

Arguments <string1>

<string2>

@stringlookup()

Retrieves a value stored in a string lookup table.

Syntax @stringlookup(<key>)

Argument <key> Used to compare the keys found inthe string lookup table. <key> canbe a data name or a literal stringenclosed in double quotes.

Example The following example looks for the string “shells” in the string lookuptable.

*if([@stringlookup("shells")])

*string("$ shells found") *end()

*endif()

The following example finds components whose names are in the stringlookup table:

*components("","")

*format()

*if([@stringlookup(name)])

*field(string,name,32) *end()


*endif()

*output()

@tan()

Trigonometric tangent of x, where x is expressed in radians.

Syntax @tan(<x>)


@vectorlookup()

Retrieves a value stored in a vector lookup table.

Syntax @vectorlookup(<key>, <x comp>, <y comp>, <z comp>)

Arguments <key> Used to compare the keysfound on the lookup tableentries.

<x comp>, <y comp>, <zcomp>

The components of the vectorthat are used to compare thevectors found on the lookuptable entries.

Comments If both the keys match, and the vectors are within tolerance, then thisfunction returns the value associated with the matching entry. If amatch is not found, the function returns 0.

@vectorlookupcomponent()

Retrieves a component of the vector stored in a lookup table.

Syntax @vectorlookup(<comp>, <key>)

Arguments <comp> The component of the vector (1 - x, 2- y, 3 - z)

<key> Used to compare the keys found onthe lookup table entries.


@vectorlookupnotkey()

Retrieves a value stored in a vector lookup table.

Syntax @vectorlookupnotkey(<key>,<x comp>,<y comp>,<zcomp>)

Arguments <key> Used to compare the keys foundin the lookup table entries.

<x comp>, <y comp>, <zcomp>

The components of the vectorthat is used to compare thevectors found in the lookup tableentries.

Comments If the input vector matches the vector in the lookup table and the keysdo not match, this function returns the value stored in the lookup table.When looking for a match between vectors, the tolerance set by*vectortablereset() is used. If no match is found, this functionreturns 0.

@xpointlocal()

Transforms a coordinate into a local system and returns the x value of the transformed point.

Syntax @xpointlocal(<system id>, <x>, <y>, <z>)

Arguments <system id> The ID of the system into whichthe point should betransformed.

<x>, <y>, and <z> The coordinates of the point tobe transformed in the globalsystem.

@xpointvectorlocal()

Transforms a vector into a local system and returns the x value of the transformed vector.

Syntax @xpointvectorlocal(<system id>, <x>, <y>, <z>, <vx>,<vy>, <vz>)

Arguments <system i> The ID of the system into whichthe point should be transformed.

<x>, <y>, and <z> The coordinates of the pointwhere the vector is located in theglobal system.


<vx>, <vy>, <vz> The components of the vector tobe transformed.

@ypointlocal()

Transforms a coordinate into a local system and returns the y value of the transformed point.

Syntax @xpointlocal(<system id>, <x>, <y>, <z>)

Arguments <system id> The ID of the system into whichthe point should be transformed.


@ypointvectorlocal()

Transforms a vector into a local system and returns the y value of the transformed vector.

Syntax @ypointvectorlocal(<system id>, <x>, <y>, <z>,<vx>, <vy>, <vz>)

Arguments <system id> The ID of the system into whichthe point should betransformed.

<x>, <y>, and <z> The coordinates of the pointwhere the vector is located inthe global system.

<vx>, <vy>, <vz> The components of the vectorto be transformed.

@zpointlocal()

Transforms a coordinate into a local system and returns the z value of the transformed point.

Syntax @zpointlocal(<system id>, <x>, <y>, <z>)

Arguments <system id> The ID of the system intowhich the point should betransformed.



@zpointvectorlocal()

Transforms a vector into a local system and returns the z value of the transformed vector.

Syntax @zpointvectorlocal(<system id>, <x>, <y>, <z>, <vx>,<vy>, <vz>)

Arguments <system id> The ID of the system into whichthe point should be transformed.

<x>, <y>, and <z> The coordinates of the point wherethe vector is located in the globalsystem.

<vx>, <vy>, <vz> The components of the vector tobe transformed.


Using the Card Previewer Commands

Card images are described by a template file block. To display the card image using the cardpreviewer, specify the appropriate card previewer commands within a *beginmenu()/*endmenu() block. You can use these commands to display entity data and edit solver-specificattributes.

Since you can use the card previewer to view and edit attributes on multiple entities, some data maynot have a common value to display for the selected entities . When this occurs, a large X is drawnthrough the data display area. If the data is an editable field (attribute), select the field and enter avalue that is common to all of the selected entities. If the entities do not share a common value,HyperMesh ignores any logic commands (*menuif() , *menuoption() ,menuoptionenum() etc.) dependent on entities sharing a common value.

Attributes default values are common throughout the card previewer. A default value field has twostates:

State Description

Default = ON In this state, the field label color is yellow and dat a entry isnot allowed.

Default = OVERRIDDEN To override a default value field, pick the yellow field label.The label text color changes to cyan and allows you toenter data in the field.

Card Previewer Error Messages

The following list describes the card previewer error messages and the corresponding solutions.

Message Invalid variable <variable> in *setvariable() command.

Meaning The <variable> specified in the *menusetvariable() command was notbetween variable1 and variable20.

Solution Change the invalid variable to a valid variable name.

Message Attribute id <id> on entity does not match type in template.

Meaning The attribute's type did not match the type specified for the attribute in the template.

Cause The *defineattribute() command in the template may have been modified, adifferent template with the same *codename() was used to edit the entity, or aninvalid entity was created by an input translator.

Solution You must clear the attributes for the solver off of the entity to edit the card.

Message Invalid entity type <type> specified in *menuentitytype().


Meaning A *menuentitytype() command with invalid type was present in the templatefile.

Solution Change the *menentitytype() command's parameter to be a valid entity name.

Message Too many <type> collectors used.

Meaning A maximum of 48 *menuentitytype() commands for the same entity type canbe used in a card image. You have exceeded this limit.

Solution Reduce the number of *menuentitytype() commands for <type> to be lessthan 48.

Message Could not find entity <id> associated with attribute <attribute name>.

Meaning An entity attribute holds an id without an entity.

Cause Entities may have been deleted or renumbered, or the *menuentitytype()command specifying the entity collected by this attribute was changed in thetemplate file.

Solution None. The value is set to 0.

Message No attribute attached to menu item <name>.

Meaning An internal error has occurred while parsing an expression.

Solution Contact HyperMesh support. The data and template file are required to furtherinvestigate the problem.

Message No attribute attached to collector item <id>.

Meaning An internal error has occurred when a collector was selected.


Message Could not find attribute named <name> in *menuoption(), skipping.

Meaning A *menuoption() or *menuoptionenum() command referenced <name> thatdoes not have an *defineattribute() command.

Solution Change the *menuoption() or *menuoptionenum() command to reference avalid attribute name.

Message Could not find enumeration <enumeration> for *menuoptionenum().

Meaning *menuoptionenum() command referenced an <enumeration> that does nothave an existing *enumeration() command.


Solution Change the *menuoptionenum() command to reference a valid enumeration.

Message Enumeration attribute <attribute> contains value <value> beyond limit of<maximum>.

Meaning <attribute> holds a <value> > <maximum>.

Cause Both *menuoptionenum() and *menufield() commands referencing<attribute> may exist in the template file. If this is the case, the user can type in<value> > <maximum>. An input translator may have also created<attribute> with the invalid <value>.

Solution If this occurs in a HyperMesh-developed template, contact HyperMesh support withthe error. User generated templates can ensure that the value is within a certainrange by using *menuif() and *menuattributeset() commands. Here is anexample of how to limit an attribute's value to between 1 and 5.

*menuif([$ATTRIBUTE_NAME < 1])

*menuattributeset($ATTRIBUTE_NAME,1)

*menuendif()

*menuif([$ATTRIBUTE_NAME > 5])

*menuattributeset($ATTRIBUTE_NAME,5)

*menuendif()

Message Could not find attribute named <attribute>, skipping.

Meaning A *menufield() command referenced the attribute named <attribute> forwhich no *defineattribute() command exists.

Solution Change the *menufield() command to reference a valid attribute name.

Message Default value specified for always on attribute <attribute>.

Meaning A *menudefaultvalue() command modifies <attribute> that does not havea valid on/off value. The *menudefaultvalue() command will be ignored.

Cause The *menudefaultvalue() command in the template may have been addedafter the template was used on the current database, a different template with thesame *codename() was used to edit the entity, or <attribute> was createdwith an invalid status by an input translator.

Message Failed to created attribute <attribute>.

Meaning An internal error has occurred in the card editor.



Message Initial value expression for <attribute> could not be evaluated.

Meaning The expression specified in *menuinitialvalue() returned an error code. The<attribute> is created with the value 0 or a zero length string, depending onstring.

Cause This error should only occur if you using the card editor on multiple entities.

Solution If you need the *menuinitialvalue() command to be executed, abort theediting on the current set of entities and edit them one at a time.

Message Initial value for <attribute> only valid for integer, real, or string.

Meaning A *menuinitialvalue() command references an attribute that was not of typeinteger, real, or string.

Solution Remove the *menuinitialvalue() command that references <attribute>.

Message Attribute <attribute> has different entity type (<entity>) than template.

Meaning A *menuentitytype() command conflicts with the entity type stored on<attribute>.

Cause The *menuentitytype() command modifying <attribute> in the templatemay have been changed after the template was used on the current database, twoor more *menufield() commands referencing <attribute> with differing*menuentitytype() commands exists in the template file, a different templatewith the same *codename() was used to edit the entity, or <attribute> wascreated with an invalid entity type by an input translator.

Solution If a user-generated input translator is being used, make sure that that attribute'sentity type created by the translator matches that of the template file. Also checkfor and remove multiple *menufield()/*menuentitytype() commandsreferencing the same attribute in the block.

Message Failed to created entity attribute <attribute>.



Message Enumerated and legal input specified for <attribute>, legal ignored.

Meaning Both *menulegalvalue() and *menuenum() commands modify the same*menufield() command. The *menulegalvalue() commands are ignored.

Solution Remove either the *menuenum() command or all of the *menulegalvalue()modifiers from the *menufield() in question.


Message Enumerated and restricted input specified for <attribute>, restrictedignored.

Meaning Both *menurestrictedvalue() and *menuenum() commands modify the same*menufield() command. The *menurestrictedvalue() commands areignored.

Solution Remove either the *menuenum() command or all *menurestrictedvalue()modifiers from the *menufield() in question.

Message Restricted and legal input specified for <attribute>, restricted ignored.

Meaning Both *menurestrictedvalue() and *menulegalvalue() commands modifythe same *menufield() command. The *menurestrictedvalue()commands are ignored.

Solution Remove either all *menulegalvalue() commands or all*menurestrictedvalue() modifiers from the *menufield() in question.

Message menulegalvalue unsupported for storage type of <attribute>.

Meaning A *menulegalvalue() command modifies a *menufield() command thatreferences an attribute that is not of type real, integer, or string.

Solution Remove the *menulegalvalue() modifier from the *menufield() command.

Message Illegal unsigned integer value returned for <data>.

Meaning An expression or data member value could not be displayed as an unsignedinteger. The string ”ERROR” is displayed in red for this field.

Solution Change the display type of this *menufield() command to real or exponential.

Message Illegal integer value returned for <data>.

Meaning An expression or data member value could not be displayed as an integer. Thestring “ERROR” is displayed in red for this field.


Message Illegal hexadecimal value returned for <data>.

Meaning An expression or data member value could not be displayed as an hexadecimalnumber. The string “ERROR” is displayed in red for this field.


Message No string value returned for <data>.


Meaning An expression or data member value could not be displayed as a string. The string“ERROR” is displayed in red for this field.

Solution Change the display type of this *menufield() command to something other thanstring.

Message beginrepeat - Expression <expression> could not be evaluated, skippingrepeat block.

Meaning <expression> could not be evaluated for multiple entities.

Solution Reduce set of entities to use card editor until <expression> is resolvable.

Message Illegal repeat value return for <expression>.

Meaning A *beginrepeat() or *beginrepeat2d() command containing<expression> returned a value too large or too small. The repeat block isskipped.

Solution It is possible to get this error with valid data. Usually it is caused by a bad*menupointerset() command.

Message Illegal repeat 2d value return for <expression>.

Meaning A *beginrepeat() or *beginrepeat2d() command containing<expression> returned a value too large or too small. The repeat block isskipped.

Solution It is possible to get this error with valid data. Usually it is caused by a bad*menupointerset() command.

Message Invalid pointer name <pointer> in *menupointerset() command, ignoring.

Meaning The <pointer> specified in the *menupointerset() command was notbetween pointer1 and pointer20.

Solution Change the invalid pointer to a valid pointer name.

Message Invalid counter name <counter> in *menucounterset() command,ignoring.

Meaning The <counter> specified in the *menucounterset() command was notbetween counter1 and counter20.

Solution Change the invalid counter to a valid counter name.

Message Error evaluating data for <counter>, setting to 0.

Meaning The expression in a *menucounterset() command could not be evaluated for


this set of entities.

Solution Reduce the set of entities you are editing until the expression in*menucounterset() command can be evaluated.

Message Invalid variable name <variable> in *menuvariableset() command,ignoring.

Meaning The <variable> specified in the *menuvariableset() command was notbetween variable1 and variable20.

Solution Change the invalid variable to a valid variable name.

Message Error evaluating data for <variable>, setting to 0.

Meaning The expression in a *menuvariableset() command could not be evaluated forthis set of entities.

Solution Abort editing the current set of entities, reduce the set of entities you are editinguntil the expression in *menuvariableset() command is evaluated.

Message Unable to find attribute <attribute> in *menuattributeset() command.

Meaning A *menuattributeset() command references an illegal attribute name.

Solution Change the attribute referenced by the *menuattributeset() command.

Message Could not find selected item <id>.


Solution Contact HyperMesh support. The current model and template file are required tofurther investigate the problem.

Message Could not find tag attribute <attribute>.

Meaning A *cardmenuitem() command references an attribute that has no*defineattribute() command.

Solution Change <attribute> so that it references a valid attribute, or add a*defineattribute() command for <attribute>.

Message menuenum references undefined enumeration <name>.

Meaning An enumeration called <name> was not previously defined in the template file.

Solution Change <name> to match a valid enumeration name.


Message Output command reached before *beginmenu() for this entity.

Meaning The *output() command for this entity block, signifying the end of the block, wasreached before a *beginmenu() command. Either the *beginmenu()does notexist in this entity block, or it was placed after the *output() command.

Solution Add or move the *beginmenu()/*endmenu() section before the *format()command for this block.

Message 2d array attribute <attribute> found outside of *repeat2d block().

Meaning Attributes of type arrayofreal2d and arrayofinteger2d can only be referenced in a*beginrepeat2d()/*endrepeat2d() section.

Solution Move the reference to <attribute> into a *beginrepeat2d()/*endrepeat2d() section.

Message 2d array attribute <attribute> not resized properly (out of bounds).

Meaning An internal error has occurred in the card editor causing the array attribute to havethe wrong size.


Message Unknown attribute type <type number> found in attribute table.

Meaning An internal error has occurred in HyperMesh.


Message *endmenu() command not reached for this entity.

Meaning The end of the template file was reached before the *endmenu() command.

Solution Add a *endmenu() command to match the last *beginmenu() command intemplate file.

Message *menuif() missing menuelse()/menuendif() command, aborting.

Meaning The end of the template file was reached before a *menuelse() or*menuendif() command for a *menuif() statement.

Solution Add a *menuendif() command to match the *menuif() command. Since the*menuif() commands can be nested, it may not be obvious which *menuif() ismissing a *menuelse() or *menuendif() command.

Message *menuendif() command not found to terminate *menuelse() block.


Meaning The end of the template file was reached before a *menuendif() command wasfound to terminate a *menuif() and *menuelse() statement.

Solution Add a *menuendif() command to match the *menuif()/*menuelse()commands. Since the *menuif() commands can be nested, it may not beobvious which *menuif()/*menuelse() block is missing a *menuendif()command.

Message Menu does not own pointer returned by strrgy.



Message Option attribute <attribute> not of type integer.

Meaning <attribute> referenced in a *menuoption() or *menuoptionenum()command was not an integer attribute.

Solution Changed the *menuoption() or *menuoptionenum() command so that itreferences an integer attribute.

Message Negative optioncount reached in case search block, aborting.

Meaning Too many *menuoptionend() commands exist in this block. There should beone *menuoptionend() command per *menuoption() or*menuoptionenum() command.

Solution Locate and remove the extra *menuoptionend() commands.

Message Invalid attribute <attribute> referenced in *beginrepeat() command.

Meaning The name <attribute> does not match a name in a *defineattribute()command.

Solution Change <attribute> to match the name of a valid attribute.

Message *beginrepeat() attribute <attribute> is not type integer.

Meaning Attributes specified in the *beginrepeat() command must be of type integer.

Solution Change the *beginrepeat() command to reference an integer attribute.

Message No *endrepeat() for zero length array.

Meaning The end of the template file was reached before a *endrepeat() command wasfound to match a *beginrepeat().


Solution Add a *endrepeat() command to match the *beginrepeat() command.

Message *endrepeat() found without matching *beginrepeat().

Meaning An extra *endrepeat() command exists in this block. There should be one*endrepeat() command per *beginrepeat() command.

Solution Locate and remove the extra *endrepeat() command.

Message *beginrepeat2d() found outside of *beingrepeat() block.

Meaning All *beginrepeat2d() commands must occur within a*beginrepeat()/*endrepeat() block.

Solution Move the *beginrepeat2d()/*endrepeat2d() block so that it occurs in a*beginrepeat()/*endrepeat() block.

Message Invalid attribute <attribute> referenced in *beginrepeat2d() command.

Meaning The name <attribute> does not match a name in a *defineattribute()command.

Solution Change <attribute> to match the name of a valid attribute.

Message *beginrepeat2d() attribute <attribute> is not type integer.

Meaning Attributes specified in the *beginrepeat2d() command must be of type integer.

Solution Change the *beginrepeat2d() command to reference an integer attribute.

Message No *endrepeat() for zero length array.

Meaning The end of the template file was reached before a *endrepeat() command wasfound to match a *beginrepeat().

Solution Add an*endrepeat() command to match the *beginrepeat() command.

Message *endrepeat2d() found without matching *beginrepeat2d().

Meaning An extra *endrepeat2d() command exists in this block. There should be one*endrepeat2d() command per *beginrepeat2d() command.

Solution Locate and remove the extra *endrepeat2d() command.


Card Previewer Commands

*begincardmenu()

Indicates the beginning of the control cards list.

Syntax *begincardmenu()

Comments Only *cardmenuitem() commands are valid between the*begincardmenu() and *endcardmenu() commands.

*beginmenu()

Indicates the beginning of the description used for the card previewer.

Syntax *beginmenu()

Comments Must be accompanied by the *endmenu() command.

*beginrepeat()

Repeats execution of a block of code a specified number of times.

Syntax *beginrepeat(<expression>)

Argument <expression> A relational expression or an attribute.

Example *beginrepeat($ARRAY_LENGTH)

*repeatwrap(80)

*repeatcounter(1)

*menufield(Array,integer,$ARRAY_ATTRIBUTE,10)

*endrepeat()

Comments The *repeatwrap() command can be used to automatically begin new lines.If used, it must be the first command following the *beginrepeat().

The *repeatcounter() command can be used to store the current repeatvalue in a counter. If no *repeatcounter() command is specified, therepeat value is not stored in any counter.

All *menufield() commands that reference attributes can only reference thefollowing types in a *beginrepeat() block: arrayofinteger,arrayofreal, arrayofstring.


The *beginrepeat() command must be accompanied by a *endrepeat()command.

*beginrepeat2d()

Repeats execution of a block of code a specified number of times.

Syntax *beginrepeat2d(<expression>)

Argument <expression> Either a relational expression or an attribute.

Example *beginrepeat($ARRAY_LENGTH)

*repeatwrap(80)

*repeatcounter(1)

*menufield(Array,integer,$ARRAY_ATTRIBUTE,10)

*beginrepeat2d($ARRAY2D_LENGTH)

*repeatcounter(2)

*menufield(Array2d,integer,$ARRAY2D_ATTRIBUTE,10)

*endrepeat2d()

*endrepeat()

Comments The *beginrepeat2d() command must always occur with a*beginrepeat() /*endrepeat() block.

The *repeatwrap() command can be used to automatically begin new lines.If used, it must be the first command following the *beginrepeat2d(). If a*repeatwrap() command is specified following a *beginrepeat()command, that same value is used for the *beginrepeat2d() block.

The *repeatcounter() command can be used to store the current repeatvalue in a counter. If no *repeatcounter() command is specified, therepeat value is not stored in any counter.

All *menufield() commands that reference attributes can only reference thefollowing types in a *beginrepeat2d() block: arrayofinteger2d orarrayofreal2d.

The *beginrepeat2d() command must be accompanied by a*endrepeat2d() command.


*endcardmenu()

Indicates the end of the control cards list.

Syntax *endcardmenu()

*endmenu()

Indicates the ending of the description used for the card previewer.

Syntax *endmenu()

Comments Must be accompanied by the *beginmenu() command.

*endrepeat()

Terminates the code block to be executed by *beginrepeat().

Syntax *endrepeat()

*endrepeat2d()

Terminates the code block to be executed by *beginrepeat2d().

Syntax *endrepeat2d()

*enumeration()

Creates an enumeration.

Syntax *elementareacalculation(<enum name>,<str1>,<str2>,...)

Arguments <enum name> The name of the enumeration.

<str1>,<str2> The members of the enumeration.


*globaldefaults()

Used to specify that each real, integer, and string attribute is modified as per the*menudefaultvalue().

Syntax *globaldefaults()

Comments Any default value not overridden by a *menudefaultvalue() fills thefield with the number of blanks equal to the width parameter in the*menufield() command when the field has the status off.*menudefaultvalue() can still be used to specify a different defaultvalue for individual fields when needed.

*menuattributeset()

Sets the value of attribute.

Syntax *menuattributeset(<attribute>,<expression>)

Arguments <attribute> The name of the attribute to hold the value.

<expression> An expression defining the value.

Comments *menuattributeset() can only be used for integer, real, entity, or stringattributes.

*menucase()

The *menucase() command specifies a block of card image template commands that areexecuted when an attribute has the value matching the *menucase() command.

Syntax *menucase(<value>)

Argument <value> Must be an integer value.

Comments *menucase() commands must occur in consecutive, incremental order.

The values 0 and 1 are the only legal values for a *menuoption() command.

The values 1 to N are legal for a *menuoptionenum() command where N isthe number of values in the enumeration referenced by *menuoptionenum().


*menucounterset()

Sets the value of the local counter.

Syntax *menucounterset(<counter>,<value>)

Arguments <counter> Value from counter1 to counter20 indicatingwhich of the 20 possible counters should be setto the <value> parameter.

<value> Value of the counter.

Comments Unlike the *counterset() command that sets a global value for the entireoutput section of the template, the *menucounterset() command is valueonly for the local scope of an entity as specified by the *beginmenu() and*endmenu() commands.

*menudefaultvalue()

Modifies an attribute field so that it has an on/off status.

Syntax *menudefaultvalue(<string>)

Argument <string> The text that is displayed when the status of theattribute is off.

Example *menufield("MISC",integer,$INT_ATTRIBUTE,10)

*menudefaultvalue("XXXXXXXXXX")

*menufield("MISC 2",real,$REAL_ATTRIBUTE,8)

*menudefaultvalue("no value")

Comments <string> should be equal in length to the <width> in the *menufield()command.

This command must follow a *menufield() command that references aninteger, real, or string attribute. If multiple entities are being displayed in thecard previewer and the status of any attribute on different entities conflict, thetitle is displayed in red and the value for this attribute is displayed as a large X.The title must be selected to make all entities have the same status for thisattribute, which is off. The title for the field can be selected to change the on/offstatus for the attribute.

If the attribute is off, the title is displayed in yellow and the string specified in the*menudefaultvalue() command is displayed. If the attribute is on, the titleis displayed in cyan and an input field is displayed. When the attribute is on,you can select the input field and type in a value for this *menufield().

An attribute's status can be accessed in the output section of the template file


using the @defaultstatus() command.

*menuelse()

Used to define the false block of a *menuif() statement.

Syntax *menuelse()

*menuendif()

Used to define the end of an *menuif() block.

Syntax *menuendif()

*menuentitytype()

Modifies an attribute field so that the selection must be an ID of an existing entity in the HyperMeshdatabase.

Syntax *menuentitytype(<entity>)

Argument <entity>

Comments <entity> must be a valid HyperMesh entity type.

The *menuentitytype() command cannot modify a*menufield() along with a *menuenum(), a*menurestrictedvalue() , a *menulegalvalue() , or a*menudefaultvalue() command.

This command follow a *menufield() command that references anentity attribute. This changes the appearance of the field in the cardpreviewer to a collector of the specified type.


*menuenum()

Modifies an attribute field so that its value is displayed as and restricted to an enumeration's values.

Syntax *menuenum(<enumeration>)

Argument <enumeration> The name of a previously defined enumeration.Instead of an input field, the field appears as abutton. When selected, the enumeration'svalues is displayed in a pop-up. After selected,the position of the value in the enumeration isstored in the attribute (1 to N).

Comments The *menuenum() command can only be used to modify integer attributes.

The *menuenum() command cannot modify a *menufield() along with a*menuentitytype() , a *menurestrictedvalue() , a*menulegalvalue() , or a *menudefaultvalue() command.

*menufield()

Places a formatted value from the database into the card image.

Syntax *menufield(<description>,<type>,<data name>,<width>)

Arguments <description> A string that is displayed along with the value.The length of the string should not be longerthan <width>.

<type> Either integer, unsigned, real, exponential, string,or hexadecimal.


<width> The width of the formatted field. In the case ofreal, HyperMesh uses scientific notation in orderto make the value displayed fit in the specifiednumber of characters.


*menuif()

Used to conditionally execute branches in the card image.

Syntax *menuif(<expression>)

Argument <expression> A relational expression.

Comment Requires an *menuendif() command.

The expression is required to be enclosed in square brackets.

The following operators are available:

==, = equal

!= not equal

<= less than or equal

< less than

>= greater than or equal

> greater than

If multiple entities are being displayed and an *menuif() returns conflictingresults for the <expression>, the entire *menuif()/ *menuelse() /*menuendif() block is skipped.

*menuinitialvalue()

Sets the initial value of an attribute if the attribute does not currently exist on the entity.

Syntax *menuinitialvalue(<value>)

Argument <value> Can be an expression for real or integer attributes, or astring for string attributes

Comments May be combined with *menulegalvalue() , *menuenum()or*menurestrictedvalue() modifiers. If the attribute already exists on theentity, its value is not changed by the command. This command must follow a*menufield() command that references an integer, real, or string attribute.


*menulegalvalue()

Modifies an attribute field so that a selection must be made from a list.

Syntax *menulegalvalue(<string>)

Argument <string> The string that is added to the list you can select fromfor this *menufield(). The length of <string> incharacters should be less than or equal to the <width>specified in the *menufield() command.

Example Below is an example of the *menulegalvalue() command modifying each oftthe three attribute types:

*menufield("INT FIELD",integer,$INT_ATTRIBUTE,10)

*menulegalvalue(1)

*menulegalvalue(2)

*menulegalvalue(4)

*menulegalvalue(8)

*menufield("REAL FIELD",real,$REAL_ATTRIBUTE,10)

*menulegalvalue(1.1)



*menufield("STRING FIELD",string,$STRING_ATTRIBUTE,10)

*menulegalvalue("String 1")

*menulegalvalue("String 2")

*menulegalvalue("Last String")

Comments If the *menufield() attribute is of type integer, the <string> specified in the*menulegalvalue() command is converted to an integer and stored in theattribute.

If the *menufield() attribute is of type real, the <string> specified in the*menulegalvalue() command is converted to a real number and stored inthe attribute.

If the *menufield() attribute is of type string, the <string> specified in the*menulegalvalue() command is copied to the attribute.

The *menulegalvalue() cannot modify a *menufield() along with a*menuenum() command or a *menurestrictedvalue() command.

Multiple *menulegalvalue() commands may be applied to the same*menufield() command.


*menulineend()

Ends the current line in the card image.

Syntax *menulineend()

Comments Card images always require at least 1 *menulineend()command. The next command that displays a field displays itin column 1 on the next line.

*menuoption()

Specifies that the value of an attribute can only be 0 or 1.

Syntax *menuoption(<attribute>)

Argument <attribute> The name of the integer attribute that holds thevalue. The value stored in <attribute> is either0 (off) or 1 (on).

Example *menuoptionenum($Option_Attribute)

*menucase(0)

*menustring("Option is off")

*menucase(1)

*menustring("Option is on")

*menuoptionend()

Comments You must have a *menucase() for both values, 0 and 1. All of the commandsbetween the *menucase() statement that is equal to the value stored in<attribute> and the next *menucase() or *menuoptionend() statementare executed.

The attribute's value is displayed in the options (bottom) portion of the menu asa diamond toggle.

*menuoptionend()

Terminates a *menuoption() or *menuoptionenum() command.

Syntax *menuoptionend()


*menuoptionenum()

Specifies that the value of an attribute is defined by a previously defined *enumeration()command.

Syntax *menuoptionenum(<attribute>,<enumeration>)

Arguments <attribute> The name of the integer attribute that holdsthe value.

<enumeration> The name of a previously definedenumeration. The value stored in<attribute> is converted to an integerbased on the selection's place in theenumeration and have a value from one to N(where N is the number of items in theenumeration).

Example *enumeration(Numbers,One,Two,Three)

*menuoptionenum($Numbers_Attribute,Numbers)

*menucase(1)

*menustring("One (1)")

*menucase(2)

*menustring("Two (2)")

*menucase(3)

*menustring("Three (3)")

*menuoptionend()

Comments For each value specified in the *enumeration() statement that<enumeration> references, you must have a *menucase() statement. All ofthe commands between the *menucase() statement that is equal to the valuestored in <attribute> and the next *menucase() or *menuoptionend()statement are executed.

The attribute's value is displayed in the options (bottom) portion of the menu asa selector. You can choose from the values in the enumeration.


*menupointerset()

Sets the initial value of a pointer.

Syntax *menupointerset(<pointer number>,<pointer>,<value>)

Arguments <pointer number> A value from pointer1 to pointer20indicating which of the 20 possiblepointers should be set to the <value>paramater.

<pointer> The pointer to the data object to beaccessed. Only certain data types mayuser pointers. These are described in thetemplate commands where they are valid.

<value> The value of the counter.

Example For example, to display all the dependent node IDs on a rigid link element, thefollowing commands could be used while in a rigid link card description:

*beginrepeat(dependentnodesmax)

*repeatcounter(1)

*menupointerset(pointer1,dependentnodes,[counter1 - 1])

*menufield(dnod,integer,pointer1.pointervalue,8)

*endrepeat()

Comments Unlike the *pointerset() command that sets a global value for the entireoutput section of the template, the *menupointerset() command is valueonly for the local scope of an entity as specified by the *beginmenu() and*endmenu() commands

*menurestrictedvalue()

Modifies an attribute field so that it alerts you when a value is outside of a specified range.

Syntax *menurestrictedvalue(<restriction>,<value>)

Arguments <restriction> Must be one of the following: >, >=, <=,or <.

<value> The value that is used for comparisonwith value entered by you.

Example The following is an example on how to restrict a real attribute to values > 0.0 and<= 1.0:


*menufield("MISC",real,$REAL_ATTRIBUTE,10)

*menurestrictedvalue(>,0.0)

*menurestrictedvalue(<=,1.0)

Comments *menurestrictedvalue() cannot modify a *menufield() along with a*menuenum() or a *menulegalvalue() command.

This command must follow a *menufield() command that references aninteger or real attribute. If you specify a value outside of the range specified bythe *menurestrictedvalue() value, an error message is displayed and thevalue is displayed in red. Multiple *menurestrictedvalue() commandsmay be applied to the same *menufield() command, but if to restricted thesame boundary, only the last one is used.

*menustring()

Displays a string in the card image.

Syntax *menustring(<string>)

Argument <string> A string of characters. If the string contains a space,an asterisk, or a comma, the string must be enclosedby double quotes.

*menuvariableset()

Sets a variable to a specific value.

Syntax *menuvariableset(<variable>,<value>)

Arguments <variable> A value from variable1 to variable20 indicating theparameter.

<value> The value of the variable.

Example Variables can be used to hold real or integer values. For example, to add thevalue of variable5 to the current value of variable1, the following command couldbe used:

*menuvariableset(variable1,[variable1+variable5])

Comments Unlike the *variableset() command that sets a global value for the entireoutput section of the template, the *menuvariableset() command is valueonly for the local scope of an entity as specified by the *beginmenu() and*endmenu() commands.


*nomenu()

Specifies that the card image definition is in the following block.

Syntax *nomenu()

Comments The *nomenu() command must be the first command to followan entity block header.

*repeatcounter()

Specifies a counter to store the current repeat value for a *beginrepeat() or*beginrepeat2d() command.

Syntax *repeatcounter(<counter number>)

Argument <counter number> An integer value between 1 and 20indicating which of the 20 possiblecounters should be hold the currentrepeat value.

*repeatwrap()

Sets the right margin that no field goes beyond in a *beginrepeat() /*endrepeat() block.

Syntax *repeatwrap(<column>)

Argument <column> The right hand margin beyond which no field isdisplayed. If a field's length would place it beyond<column>, it is placed in column 1 of the next line.

Comments If used, the *repeatwrap() command must be the first command to follow a*beginrepeat() or *beginrepeat2d() command.

Templates

Documents

Transcript of Templates