Chapter 3: Command Dictionary

This chapter contains a dictionary of the ANSYS commands, listed in alphabetical order. The star (*) and slash (/) of the star and slash commands are ignored for alphabetization (for example, the /SHOW command appears between the SHELL and SHPP commands). As in a dictionary, keywords are located at the top of each page (in the printed version only) indicating the first and last commands contained on that page.

The following section documents the components of a command description.

Components of a Command Description

SAMPLECMD, Key

Specifies whether to use automatic time stepping or load stepping.

SOLUTION: Load Step Options

– | Premium | Enterprise | Ent PP | Ent Solver | –

Argument Descriptions

Key

Automatic time stepping key:

OFF -- 

Do not use automatic time stepping

ON -- 

Use automatic time stepping.

Default: No automatic time stepping.

Notes

Specifies whether to use automatic time stepping (or load stepping) over this load step. If Key = ON, both time step prediction and time step bisection will be used. Used only if DTIME (specified on the DELTIM command) is less than the time span or conversely, if NSBSTP (on the NSUBST command) is greater than one.

This command is also valid in PREP7.

Product Restrictions

ANSYS Mechanical Enterprise Key = OFF is only valid with the ANSYS Mechanical Enterprise family of products (ANSYS Mechanical Enterprise, ANSYS Mechanical Enterprise PrepPost, and ANSYS Mechanical Enterprise Solver).

Menu Paths

Main Menu> Preprocessor >Loads> Load Step Opts> Time/Frequenc> Freq and Substps
Main Menu> Preprocessor> Loads> Load Step Opts> Time/Frequenc> Time - Time Step
Main Menu> Solution> Load Step Opts> Time/Frequenc> Freq and Substps
Main Menu> Solution> Load Step Opts> Time/Frequenc> Time - Time Step

Features Documented in ANSYS Commands

The first line of the command description shows the command name followed by the argument names (if any). The second line summarizes the command function. The summary is not intended to be all inclusive:

SAMPLECMD, Key

Specifies whether to use automatic time stepping or load stepping.

Listed on the next line are codes that will help you find other commands in the program with related functionality.

SOLUTION: Load Step Options

– | Premium | Enterprise | Ent PP | Ent Solver | –

"SOLUTION: Load Step Options" is the code in the example above. There is at least one group code for each command. The first portion of the code before the colon (:) tells which of the tables in Command Groupings the command can be found in. These are major groupings, such as PREP7 or APDL commands. In the example above, SOLUTION commands are found in SOLUTION Commands. Most of these major groupings are processors, and in those cases it is implied that the command can be entered only when in that processor. Any exceptions are noted under "Notes" later in the description.

The second portion of the code, after the colon, is the subtable in Command Groupings containing the command. The subtables list commands that relate to each other in function. In the example, the code "Load Step Options" means that other commands related to load step options can be found in that subtable of SOLUTION Commands (Table 2.53: Load Step Options).

If you are viewing this manual in the ANSYS Help System, just click on the code to follow the link to the corresponding table. Then click on any of the commands in the table, to follow the link to its description.

If you are reading the printed version, simply turn to the appropriate table in Command Groupings. The table lists the page number where the command is documented.

The next line displays a series of product codes, which may contain all of the ANSYS product codes:

Pro | Premium | Enterprise | Ent PP | Ent Solver | DYNA

or a subset of them:

– | Premium | Enterprise | Ent PP | Ent Solver | –

For more information on product codes, see Product Codes.

Following this "product code" line is the description of all arguments, if any, of the command:

Key

Automatic time stepping key:

OFF -- 

Do not use automatic time stepping (default).

ON -- 

Use automatic time stepping.

The argument is described and, where necessary, valid choices for the argument are described. Many arguments list defaults, which are the values assumed for that argument if you enter the command but leave the argument blank. On the other hand, shown after the argument descriptions is often another default:

Command Default

No automatic time stepping.

This is the command default. This is the specification assumed by the program if you do not enter the command at all. Only commands that set specifications (specification commands) have defaults listed. Commands that cause some action, such as performing some calculation, are called action commands and simply do not perform the action if the command is not entered. Defaults are not listed for action commands.

Following the default listing are any notes about the command. These notes expand on the summary description given up near the command format, and describe any other behavior, restrictions, suggestions, etc. of that command:

Notes

Specifies whether to use automatic time stepping (or load stepping) over this load step. If Key = ON, both time step prediction and time step bisection will be used. Used only if DTIME (specified on the DELTIM command) is less than the time span or conversely, if NSBSTP (on the NSUBST command) is greater than one.

This command is also valid in PREP7.

If the command behaves differently, or has restrictions, in any of the various ANSYS products, those differences are described in the Product Restrictions section:

Product Restrictions

ANSYS Mechanical Enterprise Key = OFF is only valid with the ANSYS Mechanical Enterprise family of products (ANSYS Mechanical Enterprise, ANSYS Mechanical Enterprise PrepPost, and ANSYS Mechanical Enterprise Solver).

Menu Paths

Main Menu >Preprocessor> Loads> Load Step Opts> Time/Frequenc> Freq and Substps
Main Menu >Preprocessor> Loads> Load Step Opts> Time/Frequenc> Time - Time Step
Main Menu> Solution> Load Step Opts> Time/Frequenc >Freq and Substps
Main Menu> Solution> Load Step Opts> Time/Frequenc> Time - Time Step

These menu paths are intended as guides to help you find the commands in the GUI. Be aware, however, that often the paths are valid only if some other command has been previously issued. For example, you won't be able to follow a path to transient analysis options if you have not selected a transient analysis in the first place.

Not all commands are directly accessible through the menu (although some of them may be generated indirectly by some menu function). Such cases are indicated by the following statement in the menu path listing:

Menu Paths

This command cannot be accessed directly in the menu.


Release 18.2 - © ANSYS, Inc. All rights reserved.