注釈

Go to the end to download the full example code.

Converting APDL scripts to PyMAPDL#

PyMAPDL offers two functions for converting APDL scripts to PyMAPDL scripts,

  • convert_apdl_block(), which works with strings

  • convert_script(), which works with files

This example converts a modified version of the APDL verification example 45.

import tempfile

from ansys.mapdl.core import convert_apdl_block, convert_script

apdl_script = """
/COM,ANSYS MEDIA REL. 2023R2 (05/12/2023) REF. VERIF. MANUAL: REL. 2023R2
/VERIFY,VM45
/PREP7
/TITLE, VM45, NATURAL FREQUENCY OF A SPRING-MASS SYSTEM
C*** VIBRATION THEORY AND APPLICATIONS, THOMSON, 2ND PRINTING, PAGE 6, EX. 1.2-2
ANTYPE,MODAL
MODOPT,LANB,1
ET,1,COMBIN14,,,2     ! TWO-DIMENSIONAL LONGITUDINAL SPRING
ET,2,MASS21,,,4       ! TWO-DIMENSIONAL MASS
R,1,48
R,2,.006477
N,1
N,2,,1
E,1,2
TYPE,2
REAL,2
E,2
OUTPR,ALL,1
OUTRES,ALL,0
D,1,ALL
D,2,UX
FINISH
/SOLU
SOLVE
*GET,FREQ,MODE,1,FREQ
*DIM,LABEL,CHAR,1,2
*DIM,VALUE,,1,3
LABEL(1,1) = '      F,'
LABEL(1,2) = ' (Hz)   '
*VFILL,VALUE(1,1),DATA,13.701
*VFILL,VALUE(1,2),DATA,FREQ
*VFILL,VALUE(1,3),DATA,ABS(FREQ/13.701)
/COM
/OUT,vm45,vrt
/COM,------------------- VM45 RESULTS COMPARISON ---------------
/COM,
/COM,                 |   TARGET   |   Mechanical APDL   |   RATIO
/COM,
*VWRITE,LABEL(1,1),LABEL(1,2),VALUE(1,1),VALUE(1,2),VALUE(1,3)
(1X,A8,A8,'   ',F10.3,'  ',F14.3,'   ',1F15.3)
/COM,-----------------------------------------------------------

/OUT
FINISH
*LIST,vm45,vrt
"""

Convert a string inline#

Calling the convert_apdl_block() function converts the supplied string to a list of translated lines of code.

result = convert_apdl_block(apdl_script)
print(result)

Quality of Life kwargs#

This function also includes several kwargs that cover common use cases when converting from APDL to PyMAPDL, such as adding the necessary Python imports when add_imports is set to True or adding the mapdl.exit() command to the end when auto_exit is set to True.

Some of the most useful kwargs follow.

  • only_commands: Convert the commands without adding any boilerplate such as mapdl=launch... or mapdl.exit.

  • print_com: Change /COM commands to print() commands.

  • clear_at_start: Call the mapdl.clear() method after the launch_mapdl` function.

  • add_imports Add Python import lines at the start of the script.

  • auto_exit: If True, append the mapdl.exit() method to the end of the file.

  • cleanup_output: If True, format output using autopep8 (if you have this Python package installed).

result = convert_apdl_block(
    apdl_script, print_com=True, clear_at_start=True, add_imports=True, auto_exit=True
)
print(result)

Convert from a file#

The convert_script function provides all the same functionality but converts from a file to a list of translated strings. Additionally, it provides an option for saving the result to a file automatically, which the convert_apdl_block() function does not provide.

new_file, filename = tempfile.mkstemp(suffix=".inp")
with open(filename, "w") as f:
    f.write(apdl_script)
result = convert_script(
    filename, print_com=True, clear_at_start=True, add_imports=True, auto_exit=True
)
print("\n".join(result))

Command-line interface#

You can access the convert_script function in the terminal using a CLI (command-line interface). Assuming a virtual environment is activated, you can use the following command to convert a file named mapdl.in to a mapdl.out file.

$ pymapdl convert -f mapdl.dat --print_com --clear_at_start --add_imports --auto_exit --output mapdl.out

You can even build the input on the fly using the echo command:

$ echo -e "/prep7\nblock,0,1,0,1,0,1" | pymapdl convert -oc
mapdl.prep7()
mapdl.block(0, 1, 0, 1, 0, 1)