Mapdl.ucmd(cmd='', srnum='', **kwargs)[source]#

Assigns a user-defined command name.

APDL Command: /UCMD


User-defined command name. Only the first four characters are significant. Must not conflict with any ANSYS command name or any user “unknown command” macro name.


User subroutine number (1 to 10) programmed for this command. For example, the command /UCMD,MYCMD,3 will execute subroutine USER03 whenever the command MYCMD is entered. Use a blank command name to disassociate SRNUM from its command. For example, /UCMD,,3 removes MYCMD as a command.


Assigns a user-defined command name to a user-programmable (system- dependent) subroutine. This feature allows user-defined commands to be programmed into the ANSYS program. Once programmed, this command can be input to the program like other commands, and can also be included in the ANSYS start-up file. See *ULIB for another way of defining user commands.

Up to 10 subroutines are available for user-defined commands (USER01 to USER10). Users must have system permission, system access, and knowledge to write, compile, and link the appropriate subprocessors into the ANSYS program at the site where it is to be run. All routines should be written in FORTRAN. For more information on FORTRAN compilers please refer to either the ANSYS, Inc. Windows Installation Guide or the ANSYS, Inc. Linux Installation Guide for details specific to your platform or operating system. The USER01 routine is commented and should be listed from the distribution media (system dependent) for more details. Issue /UCMD,STAT to list all user-defined command names. Since a user-programmed command is a nonstandard use of the program, the verification of any ANSYS run incorporating these commands is entirely up to the user. In any contact with ANSYS customer support regarding the performance of a custom version of the ANSYS program, you should explicitly state that a user programmable feature has been used. See the Advanced Analysis Guide for a general description of user- programmable features and Guide to User-Programmable Features for a detailed description of these features.

This command is valid only at the Begin Level.