PyMAPDL language and usage#

本页概述了 Mapdl 类的 PyMAPDL API。更多信息，请参阅 Mapdl module。

APDL command logging#

虽然 ansys-mapdl-core 的设计目的是使通过使用 Python 调用 APDL 会话来控制 APDL 会话变得更容易，但可能有必要使用 PyMAPDL 脚本生成的输入文件再次调用 MAPDL。使用 log_apdl="apdl.log" 参数可以自动启用这一点。启用此参数后，Mapdl 类将把运行的每个命令写入活动的 Mapdl.directory 中名为 "apdl.log" 的日志文件。

例如：

>>> from ansys.mapdl.core import launch_mapdl

>>> ansys = launch_mapdl(log_apdl="apdl.log")
>>> ansys.prep7()
>>> ansys.k(1, 0, 0, 0)
>>> ansys.k(2, 1, 0, 0)
>>> ansys.k(3, 1, 1, 0)
>>> ansys.k(4, 0, 1, 0)

这段代码会将以下内容写入 "apdl.log" 文件：

/PREP7,
K,1,0,0,0
K,2,1,0,0
K,3,1,1,0
K,4,0,1,0

除条件语句、循环或函数外，这允许将 Python 脚本转换为 APDL 脚本。

Use the `lgwrite` method#

另外，如果只需要数据库命令输出，可以使用 Mapdl.lgwrite 方法将整个数据库命令日志写入文件。

Interactive breakpoint 交互式断点#

在大多数情况下，有必要或最好打开 MAPDL GUI。Mapdl 类有 Mapdl.open_gui() 方法，它允许您无缝地打开图形用户界面，而不会丢失工作或重新启动会话。例如

>>> from ansys.mapdl.core import launch_mapdl
>>> mapdl = launch_mapdl()

使用关键点创建正方形区域

>>> mapdl.prep7()
>>> mapdl.k(1, 0, 0, 0)
>>> mapdl.k(2, 1, 0, 0)
>>> mapdl.k(3, 1, 1, 0)
>>> mapdl.k(4, 0, 1, 0)
>>> mapdl.l(1, 2)
>>> mapdl.l(2, 3)
>>> mapdl.l(3, 4)
>>> mapdl.l(4, 1)
>>> mapdl.al(1, 2, 3, 4)

打开图形用户界面

>>> mapdl.open_gui()

从上次中断的地方继续

>>> mapdl.et(1, "MESH200", 6)
>>> mapdl.amesh("all")
>>> mapdl.eplot()

这种方法避免了在交互会话和脚本会话之间来回切换的麻烦。相反，你可以使用一个脚本会话，然后从脚本会话中打开图形用户界面，而不会丢失工作或进度。此外，在图形用户界面中进行的任何更改都不会影响脚本。您可以在图形用户界面中进行实验，而脚本则不受影响。

Run a batch job#

您可以定义一个运行 MAPDL 的函数，而不是通过调用输入文件来运行 MAPDL 批处理。此示例根据扭转载荷下圆柱体的最大应力运行网格收敛研究。

import numpy as np
from ansys.mapdl.core import launch_mapdl


def cylinder_batch(elemsize, plot=False):
    """报告悬臂支撑圆柱体的最大 von Mises 应力"""

    # clear
    mapdl.finish()
    mapdl.clear()

    # cylinder parameters
    radius = 2
    h_tip = 2
    height = 20
    force = 100 / radius
    pressure = force / (h_tip * 2 * np.pi * radius)

    mapdl.prep7()
    mapdl.et(1, 186)
    mapdl.et(2, 154)
    mapdl.r(1)
    mapdl.r(2)

    # Aluminum(铝) properties (or something)
    mapdl.mp("ex", 1, 10e6)
    mapdl.mp("nuxy", 1, 0.3)
    mapdl.mp("dens", 1, 0.1 / 386.1)
    mapdl.mp("dens", 2, 0)

    # Simple cylinder
    for i in range(4):
        mapdl.cylind(radius, "", "", height, 90 * (i - 1), 90 * i)

    mapdl.nummrg("kp")

    # mesh cylinder
    mapdl.lsel("s", "loc", "x", 0)
    mapdl.lsel("r", "loc", "y", 0)
    mapdl.lsel("r", "loc", "z", 0, height - h_tip)
    # mapdl.lesize('all', elemsize*2)
    mapdl.mshape(0)
    mapdl.mshkey(1)
    mapdl.esize(elemsize)
    mapdl.allsel("all")
    mapdl.vsweep("ALL")
    mapdl.csys(1)
    mapdl.asel("s", "loc", "z", "", height - h_tip + 0.0001)
    mapdl.asel("r", "loc", "x", radius)
    mapdl.local(11, 1)
    mapdl.csys(0)
    mapdl.aatt(2, 2, 2, 11)
    mapdl.amesh("all")
    mapdl.finish()

    if plot:
        mapdl.view(1, 1, 1, 1)
        mapdl.eplot()

    # new solution
    mapdl.slashsolu()
    mapdl.antype("static", "new")
    mapdl.eqslv("pcg", 1e-8)

    # Apply tangential pressure 施加切向压力
    mapdl.esel("s", "type", "", 2)
    mapdl.sfe("all", 2, "pres", "", pressure)

    # Constrain bottom of cylinder/rod
    mapdl.asel("s", "loc", "z", 0)
    mapdl.nsla("s", 1)

    mapdl.d("all", "all")
    mapdl.allsel()
    mapdl.psf("pres", "", 2)
    mapdl.pbc("u", 1)
    mapdl.solve()
    mapdl.finish()

    # access results using MAPDL object 使用 MAPDL 对象访问结果
    result = mapdl.result

    # 要访问您可以运行的结果，请执行以下操作：
    # from ansys.mapdl import reader as pymapdl_reader
    # resultfile = os.path.join(mapdl.path, '%s.rst' % mapdl.jobname)
    # result = pymapdl_reader.read_binary(result file)

    # 获取结果 1 处的最大 von Mises 应力
    # Index 0 as it's zero based indexing
    nodenum, stress = result.principal_nodal_stress(0)

    # von Mises 应力是最后一列
    # 必须为 nanmax，因为没有记录壳单元应力
    maxstress = np.nanmax(stress[:, -1])

    # 返回节点数和最大应力
    return nodenum.size, maxstress


# 初始化 MAPDL
mapdl = launch_mapdl(override=True, loglevel="ERROR")

# 调用 MAPDL 反复求解
result_summ = []
for elemsize in np.linspace(0.6, 0.15, 15):
    # 运行批处理并报告结果
    nnode, maxstress = cylinder_batch(elemsize, plot=False)
    result_summ.append([nnode, maxstress])
    print(
        "Element size %f: %6d nodes and maximum vom Mises stress %f"
        % (elemsize, nnode, maxstress)
    )

# Exit MAPDL
mapdl.exit()

下面是脚本的输出结果：

Element size 0.600000:   9657 nodes and maximum vom Mises stress 142.623505
Element size 0.567857:  10213 nodes and maximum vom Mises stress 142.697800
Element size 0.535714:  10769 nodes and maximum vom Mises stress 142.766510
Element size 0.503571:  14177 nodes and maximum vom Mises stress 142.585388
Element size 0.471429:  18371 nodes and maximum vom Mises stress 142.825684
Element size 0.439286:  19724 nodes and maximum vom Mises stress 142.841202
Element size 0.407143:  21412 nodes and maximum vom Mises stress 142.945984
Element size 0.375000:  33502 nodes and maximum vom Mises stress 142.913437
Element size 0.342857:  37877 nodes and maximum vom Mises stress 143.033401
Element size 0.310714:  59432 nodes and maximum vom Mises stress 143.328842
Element size 0.278571:  69106 nodes and maximum vom Mises stress 143.176086
Element size 0.246429: 110547 nodes and maximum vom Mises stress 143.499329
Element size 0.214286: 142496 nodes and maximum vom Mises stress 143.559128
Element size 0.182143: 211966 nodes and maximum vom Mises stress 143.953430
Element size 0.150000: 412324 nodes and maximum vom Mises stress 144.275406

Chain commands in MAPDL#

MAPDL 通过使用分隔符 "$" 允许在一行中执行多个命令。在 PyMAPDL 中，可以有效地将多个命令链在一起，然后发送给 MAPDL 执行，而不是单独执行。当你需要在一个 Python 循环中执行数千条命令，而不需要每条命令的单独结果时，命令链会很有帮助。例如，如果您想沿 X 轴创建 1000 个关键点，您可以运行：

xloc = np.linspace(0, 1, 1000)
for x in xloc:
    mapdl.k(x=x)

但是，由于每条命令都是单独执行并返回响应的，因此将要由 MAPDL 执行的命令分组发送，并让 Mapdl 类通过使用 Mapdl.chain_commands 属性来处理命令分组会更快。

xloc = np.linspace(0, 1, 1000)
with mapdl.chain_commands:
    for x in xloc:
        mapdl.k(x=x)

使用这种方法的执行时间通常比单独运行每条命令快 4 到 10 倍。然后，您可以使用 Mapdl.last_response 属性查看链式命令的最终响应。

Note

分布式 MAPDL 不支持命令链。为提高性能，请使用 mute=True 或 Mapdl.non_interactive 上下文管理器。

Sending arrays to MAPDL#

您可以使用 Mapdl.Parameters 属性直接向 MAPDL 发送 numpy 数组或 Python 列表。这比使用 Mapdl.run() 方法通过 Python 单独向 MAPDL 发送参数要有效得多，因为它在幕后使用了 Mapdl.vread() 方法。

from ansys.mapdl.core import launch_mapdl
import numpy as np

mapdl = launch_mapdl()
arr = np.random.random((5, 3))
mapdl.parameters["MYARR"] = arr

通过索引 Mapdl.Parameters 属性（就像 Python 字典一样），验证数据是否已正确加载到 MAPDL：

>>> array_from_mapdl = mapdl.parameters["MYARR"]
>>> array_from_mapdl
array([[0.65516567, 0.96977939, 0.3224993 ],
       [0.58634927, 0.84392263, 0.18152529],
       [0.76719759, 0.45748876, 0.56432361],
       [0.78548338, 0.01042177, 0.57420062],
       [0.33189362, 0.9681039 , 0.47525875]])

Download a remote MAPDL file#

在 gRPC 模式下运行 MAPDL 时，可以使用 Mapdl 类和 Mapdl.download() 函数列出并下载远程 MAPDL 文件。例如，以下代码列出了远程文件并下载了其中一个：

remote_files = mapdl.list_files()

# 确保结果文件是远程文件之一
assert "file.rst" in remote_files # assert(声明)

# 下载远程结果文件
mapdl.download("file.rst")

Note

该功能仅适用于 MAPDL 2021 R1 及更高版本。

或者，您可以使用 glob 模式或 Mapdl.download() 方法中的文件名列表一次性下载多个文件：

# 使用文件名列表
mapdl.download(["file0.log", "file1.out"])

# 使用 glob 模式匹配文件列表
mapdl.download("file*")

您还可以使用此函数下载 MAPDL 工作目录（Mapdl.directory ）中的所有文件：

mapdl.download_project()

或者按扩展名过滤，如本例所示：

mapdl.download_project(
    ["log", "out"], target_dir="myfiles"
)  # Download the files to 'myfiles' directory

Upload a local MAPDL file#

您可以使用 Mapdl.upload() 方法将本地 MAPDL 文件作为远程 MAPDL 实例上传：

# upload a local file
mapdl.upload("sample.db")

# ensure the uploaded file is one of the remote files
remote_files = mapdl.list_files()
assert "sample.db" in remote_files

Note

该功能仅适用于 MAPDL 2021 R1 及更高版本。

不支持的 MAPDL 命令及其他注意事项#

大多数 MAPDL 命令都已通过 Python 映射到相应的方法中。但是，有些命令不支持，因为它们不适用于交互会话，或者它们需要额外的命令，而这些命令与 MAPDL 服务器处理输入的方式不兼容。

不可用的命令#

由于各种原因，有些命令在 PyMAPDL 中不可用。

其中有些命令在 Python 环境中没有意义。下面是一些例子：

可以用 Python input 代替 *ASK 命令。
可以用 Python if 语句代替 *IF 命令。
可以调用另一个 Python 函数或模块来代替 *CREATE 和 *USE 命令。

其他命令在非图形用户界面会话中没有意义。例如，在非图形用户界面会话中不需要清除图形屏幕的 /ERASE 和 ERASE 命令。

其他命令会被 MAPDL 忽略，但您仍然可以使用它们。例如，可以使用 mapdl.run("/BATCH") 方法运行 /BATCH 命令，该方法会返回以下警告：

*** WARNING ***                         CP =       0.519   TIME= 12:04:16
The /BATCH command must be the first line of input.  The /BATCH command
is ignored.

Table-1 关于无法使用的命令的全面信息

Table 1. Non-available commands.

	MAPDL command	Interactive	Non-interactive	Direct run	Notes
GUI commands	`*ASK`	❌ Not available	❌ Not available	✔️ Works	When used in `mapdl.run()` it automatically assumes the user input is 0. Use Python `input` instead.
	`*VEDIT`	❌ Not available	❌ Not available	➖ MAPDL shows a warning	It requires a GUI session to work.
	`/ERASE`	❌ Not available	❌ Not available	✔️ Works	It does not make sense in a non-GUI session.
	`ERASE`	❌ Not available	❌ Not available	➖ MAPDL shows a warning	It does not make sense in a non-GUI session.
	`HELP`	❌ Not available	❌ Not available	➖ Ignored by MAPDL	It requires a GUI session to work.
	`HELPDISP`	❌ Not available	❌ Not available	➖ Ignored by MAPDL	It requires a GUI session to work.
	`NOERASE`	❌ Not available	❌ Not available	✔️ Works	It does not make sense in a non-GUI session.
Control flow commands	`*CYCLE`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords, in this case `continue`.
	`*DO`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords, in this case `for`.
	`*DOWHILE`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords, in this case `while`.
	`*ELSE`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords, in this case `else`.
	`*ELSEIF`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords, in this case `elif`.
	`*ENDDO`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords.
	`*GO`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords, such as `if` or functions.
	`*IF`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords, in this case `continue`.
	`*REPEAT`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords such as `for` or `while`
	`*RETURN`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python control flow keywords such as `break`, `continue` or `return`
Others commands	`*DEL`	❌ Not available	❌ Not available	✔️ Works	It is recommended to use Python variables (use Python memory) instead of MAPDL variables.
	`/BATCH`	❌ Not available	❌ Not available	➖ Ignored by MAPDL.	It does not make sense in a PyMAPDL session.
	`/EOF`	❌ Not available	❌ Not available	❌ PyMAPDL shows an exception	To stop the server, use `mapdl.exit()`
	`UNDO`	❌ Not available	❌ Not available	➖ MAPDL shows a warning	It does not undo any command.

Note

Interactive（交互式） 是指 MAPDL 中有一个方法，例如 Mapdl.prep7() 方法。
Non-interactive 表示在 Mapdl.non_interactive 上下文块、 Mapdl.input() 方法或 Mapdl.input_strings() 方法中运行。例如
```
with mapdl.non_interactive:
    mapdl.prep7()
```
Direct run 是指使用 mapdl.run() 方法来运行 MAPDL 命令。例如 mapdl.run("/PREP7") 方法。

请注意，使用 mapdl.run() 方法运行这些命令不会导致 MAPDL 退出。但是，它可能会引发异常。

这些 MAPDL 命令也可以使用 mapdl.input() 方法或 mapdl.input_strings() 方法执行。结果应与在正常批处理 MAPDL 会话中运行相同。

不支持的 “交互式” 命令#

以下命令只能在非交互模式下运行（在 Mapdl.non_interactive 块内或使用 mapdl.input() 方法）。

Table-2 提供有关不受支持的“交互式”命令的全面信息。

Table 2. Non-interactive only commands.

	Interactive	Non-interactive	Direct Run	Notes
`*CREATE`	❌ Not available	✔️ Available	➖ Only in `Mapdl.non_interactive`	It is recommended to create Python functions instead.
`CFOPEN`	❌ Not available	✔️ Available	➖ Only in `Mapdl.non_interactive`	It is recommended to use Python functions such as `open`.
`CFCLOSE`	❌ Not available	✔️ Available	➖ Only in `Mapdl.non_interactive`	It is recommended to use Python functions such as `open`.
`*VWRITE`	❌ Not available	✔️ Available	➖ Only in `Mapdl.non_interactive`	If you are working in a local session, it is recommended you use Python function such as `open`.
`LSWRITE`	✔️ Available (Internally running in `Mapdl.non_interactive`)	✔️ Available	➖ Only in `Mapdl.non_interactive`

环境变量#

有几个 PyMAPDL 特定的环境变量可以用来控制 PyMAPDL 和 MAPDL 的行为或启动。下表列出了这些变量：

`PYMAPDL_START_INSTANCE`	Override the behavior of the `ansys.mapdl.core.launcher.launch_mapdl()` function to only attempt to connect to existing instances of PyMAPDL. Generally used in combination with `PYMAPDL_PORT`. Example: export PYMAPDL_START_INSTANCE=True
`PYMAPDL_PORT`	Default port for PyMAPDL to connect to. Example: export PYMAPDL_PORT=50052
`PYMAPDL_IP`	Default IP for PyMAPDL to connect to. Example: export PYMAPDL_IP=123.45.67.89
`ANSYSLMD_LICENSE_FILE`	License file or IP address with port in the format `PORT@IP`. Do not confuse with the `IP` and `PORT` where the MAPDL instance is running, which are specified using `PYMAPDL_IP` and `PYMAPDL_PORT`. This is helpful for supplying licensing for Docker. Example: export ANSYSLMD_LICENSE_FILE=1055@123.45.67.89
`PYMAPDL_MAPDL_EXEC`	Executable path from where to launch MAPDL instances. Example: export PYMAPDL_MAPDL_EXEC=/ansys_inc/v222/ansys/bin/mapdl
`PYMAPDL_MAPDL_VERSION`	Default MAPDL version to launch in case there are several versions availables. Example: export PYMAPDL_MAPDL_VERSION=22.2
`PYMAPDL_MAX_MESSAGE_LENGTH`	Maximum gRPC message length. If your connection terminates when running PRNSOL or NLIST, raise this. In bytes, defaults to 256 MB. Only for developing purposes.

PyMAPDL language and usage#

Overview#

Selecting entities#

Running in non-interactive mode#

How the non-interactive context manager works#

MAPDL macros#

Additional options when running commands#

Running several commands or an input file#

条件语句和循环#

Warnings and errors#

Prompts 提示#

APDL command logging#

Use the `lgwrite` method#

Interactive breakpoint 交互式断点#

Run a batch job#

Chain commands in MAPDL#

Sending arrays to MAPDL#

Download a remote MAPDL file#

Upload a local MAPDL file#

不支持的 MAPDL 命令及其他注意事项#

不可用的命令#

不支持的 “交互式” 命令#

环境变量#

PyMAPDL language and usage#

Overview#

Selecting entities#

Running in non-interactive mode#

How the non-interactive context manager works#

MAPDL macros#

Additional options when running commands#

Running several commands or an input file#

条件语句和循环#

Warnings and errors#

Prompts 提示#

APDL command logging#

Use the lgwrite method#

Interactive breakpoint 交互式断点#

Run a batch job#

Chain commands in MAPDL#

Sending arrays to MAPDL#

Download a remote MAPDL file#

Upload a local MAPDL file#

不支持的 MAPDL 命令及其他注意事项#

不可用的命令#

不支持的 “交互式” 命令#

环境变量#

Use the `lgwrite` method#