Variable Format for ANSYS Macros

Naming Convention for ANSYS Parameters

[ Rev D 03/13/2003 J. Judd ]

Table of Contents (TOC):

Purpose To Be Done

Conventions: General Letter Case Part Name Type / Subtype Number

Purpose:

Define a format for naming variables in ANSYS macros to provide the following:

Minimize overlap of variable names between parts
Easy recognition of variables meaning in terms of: part referenced , type of variable, sub type of variable, number group, etceteras.

General Convention: TOC

Six to eight alphanumeric letters in the format ## $$ %% where

## = abbreviation of part name.

$$ = abbreviation of parameter type and possibly subtype.

%% = parameter number ranging from 00 to 99.

8 alphanumeric characters are allowed for each variable, therefore any one of the groups (e.g. ##, $$, or %%) could have one additional alphanumeric character per variable.

Letter Case Conventions: TOC

Upper and lower case letters are used to visually differentiate between the alpha character groups (e.g. ## and $$) and to differentiate between the type and subtype within the $$ group.

## Use lowercase letters for all characters.

$$ First character is uppercase and the second character may be upper or lower case.

%% Usually use numeric character but if use alpha character then choose lower case.

Specific Conventions: TOC

## Part Name

Try to use only two letters. [Example: hs = housing sleeve]
Try not to repeat among other parts.

%% Number TOC

Suggest 00 for global signifigance; 01 up for specific; and 99 down for temporary definitions.

Suggest using ‘tens’ place for category as appropriate. [For example: hsCV10 represents entire left half of model while hsCV20 represents right half. Within left half could have bottom portion = hsCV11 and top portion = hsCV12. ]

See Type / SubType list below for specific conventions for specific parameter types

$$ Type / SubType TOC

c_	Prefix for conversion variables (see unitconv.mac)
CS	coordinate system number (e.g. __ in ‘Local’ command). Use first % for coordinate system type, 0=cartesian, 1=cylindrical, 2=spherical. Use second, etc % for iterative number where 0 is reserved for the part’s main CS. Ex. stCS10 = main cylindrical CS for stator. Ex. stCS01 = a global CS for stator which is referenced (clocal) to the main stator CS, stCS00.
CSn	Active CS number used to define part's local CS (e.g. in CLOCAL command). Note: without a partname refers to a CS counter, with partname refers to CS number.
CSx	X dimension to part's coordinate system from CSn in terms of CSn. If no CSn assume in reference to global CS.
CSy, CSz, CSxy, CSyz, CSzx	similar to CSx but for Y, Z, rotXY, rotYZ, and rotZX.
CV	component group - volume Note: without a number refers to a macro (e.g. hscv.mac creates component volumes, all lowercase due to ANSYS/UNIX difficulty in reading uppercase macro names.)
CA, CL, CK, CN, CE	similar to CV but for areas, lines, keypoints, nodes, and elements respectively.
Da	Dimension ANGULAR
Dc	Dimension CHAMFER.
Do	Similar to Dx but for other dimensions that are not in direction of part’s CS axes.
Dr	Dimension in RADIAL direction
Dx	Dimension in part’s X axis direction from unspecified origin (e.g. length from/to shown by dimension arrows on drawing). See Px etc. for alternative.
Dy, Dz	Similar to Dx but for dimension in part’s Y and Z axis direction respectively.
ETn	arbitrary local Element Type number (i.e. ITYPE in ET command) Note: without a partname refers to a counter, with partname refers to part.
ESd	Element size number divisions (e.g. esize,,ndiv)
ESs	Element size size (e.g. esize,size)
Fatt	Flag for geometry attribute assignment (e.g. vatt, aatt). No %% number required.
Fgeom	Flag for geometry creation. No %% number required.
Fmsh	Flag for meshing. No %% number required.
LSa	Line Element Size - angle size (e.g. lesize,,,ang)
LSd	Line Element Size - number divisions (e.g. lesize,,,,ndiv)
LSr	Line Element Size - space ratio (e.g. lesize,,,,,ratio)
LSs	Line Element Size - size (e.g. lesize,,size)
MPn	material property number (e.g. ‘mat’ in ‘MP’ command) Note: without a partname refers to a counter, with partname refers to part.
NUXY	‘Minor Poisson’s Ratio’ for material identified by part name. [Ex: ssNUXY = poisson’s ratio for stainless steel]
EX, DENS, etc.	Similar to NUXY but for other material property types.
PARMf	Parameter file's filename. Must be string character. (ex. hsPARMf='375a069a') Note: a prefix number is not required.
PF	Parameter File. Designates the array file for storing part parameters. Note: a prefix number is not required.
Px	Dimension in part’s X axis direction from origin of part’s CS to specified point. (e.g. dimension is always assumed to be from origin of CS to point specified and no dimension line is required on drawings). See Dx etc. for alternative.
Py, Pz	Similar to Px but for dimension in parts Y and Z axis direction respectively.
SC	Section (e.g. section for beam elements).
SCn	Active SC number used to define section numbers Note: without a partname refers to a SC counter, with partname refers to SC number.
r_	Prefix for report macros

TOC

To Be Done (TBD):

Under ‘Letter Case Convention’ explain how NT and Unix treat case differently in ANSYS for variables, character arrays, and macro name.

Add option and flag variables

(Items planned for functional expansion or correction. Official list is in comments database.) TOC