2.4. APDL Commands

These commands make up the ANSYS Parametric Design Language (APDL). The commands are grouped by functionality.

Table 2.18 Parameter Definition

These APDL commands are used to define parameters and their values.
*AFUN	Specifies units for angular functions in parameter expressions.
*ASK	Prompts the user to input a parameter value.
*DEL	Deletes a parameter (GUI).
*DIM	Defines an array parameter and its dimensions.
*GET	Retrieves a value and stores it as a user-named parameter.
/INQUIRE	Returns system information to a parameter.
PARRES	Reads parameters from a file.
PARSAV	Writes parameters to a file.
*SET	Assigns values to user-named parameters.
*STATUS	Lists the current parameters and abbreviations.
*TAXIS	Defines table index numbers.
*TREAD	Reads data from an external file into a table array parameter.
*VFILL	Fills an array parameter.
*VGET	Retrieves values into an array parameter.
*VREAD	Reads data and produces an array parameter vector or matrix.

Table 2.19 Macro Files

These APDL commands are used to build and execute command macros.
*CFCLOS	Closes the "command" file.
*CFOPEN	Opens a "command" file.
*CFWRITE	Writes an ANSYS command (or similar string) to a "command" file.
*CREATE	Opens (creates) a macro file.
/DFLAB	Changes DOF labels for user custom elements.
*END	Closes a macro file.
/MAIL	Mails file to specifed address.
/MKDIR	Creates a directory.
*MSG	Writes an output message via the ANSYS message subroutine.
/PMACRO	Specifies that macro contents be written to the session log file.
/PSEARCH	Specifies a directory to be searched for "unknown command" macro files.
/RMDIR	Removes (deletes) a directory.
/TEE	Writes a list of commands to a specified file at the same time that the commands are being executed.
*ULIB	Identifies a macro library file.
*USE	Executes a macro file.

Table 2.20 Abbreviations

These APDL commands can be used to define abbreviations for longer commands, and to create user-defined commands.
*ABBR	Defines an abbreviation.
ABBRES	Reads abbreviations from a coded file.
ABBSAV	Writes the current abbreviation set to a coded file.
/UCMD	Assigns a user-defined command name.

Table 2.21 Array Parameters

These APDL commands are used to operate on parameter arrays (i.e., vectors and matrices).
/DIRECTORY	Put the file names in the current directory into a string parameter array.
*MFOURI	Calculates the coefficients for, or evaluates, a Fourier series.
*MFUN	Copies or transposes an array parameter matrix.
*MOPER	Performs matrix operations on array parameter matrices.
*MWRITE	Writes a matrix to a file in a formatted sequence.
*SREAD	Reads a file into a string array parameter.
*TOPER	Operates on table parameters.
*VABS	Applies the absolute value function to array parameters.
*VCOL	Specifies the number of columns in matrix operations.
*VCUM	Allows array parameter results to add to existing results.
*VEDIT	Allows numerical array parameters to be graphically edited.
*VFACT	Applies a scale factor to array parameters.
*VFUN	Performs a function on a single array parameter.
*VITRP	Forms an array parameter by interpolation of a table.
*VLEN	Specifies the number of rows to be used in array parameter operations.
*VMASK	Specifies an array parameter as a masking vector.
*VOPER	Operates on two array parameters.
*VPLOT	Graphs columns (vectors) of array parameters.
*VPUT	Restores array parameter values into the ANSYS database.
*VSCFUN	Determines properties of an array parameter.
*VSTAT	Lists the current specifications for the array parameters.
*VWRITE	Writes data to a file in a formatted sequence.

Table 2.22 Process Controls

These APDL commands can be used to control the order in which other commands are processed.
*CYCLE	Bypasses commands within a do-loop.
*DO	Defines the beginning of a do-loop.
*ELSE	Separates the final if-then-else block.
*ELSEIF	Separates an intermediate if-then-else block.
*ENDDO	Ends a do-loop and starts the looping action.
*ENDIF	Ends an if-then-else.
*EXIT	Exits a do-loop.
*GO	Causes a specified line on the input file to be read next.
*IF	Conditionally causes commands to be read.
*REPEAT	Repeats the previous command.
*RETURN	Returns input stream to a higher level.
/WAIT	Causes a delay before the reading of the next command.