Skip to main content

NaviField 命令行工具箱

NaviField 是给研究生和仿真工程师使用的命令行工具箱。用你自己安装的求解器运行公开算例,它会保存输入副本、原生日志和结果记录。第一次使用可以选下面的悬臂梁,用解析挠度检查整条流程。

NaviField is a local simulation toolbox for students and engineers. Run your own solvers, keep a reproducible record, and check results against public benchmarks. The examples cover a driven cavity, turbulent pipe flow and a cantilever beam.

安装

准备 64 位 Python 3.10 或更新版本。在解压目录打开 Windows 命令提示符(cmd.exe),建议为 NaviField 建独立环境。安装命令会一并安装基础依赖 psutil 和 Pydantic 2。

py -3 -m venv .venv
call .venv\Scripts\activate.bat
python -m pip install .

需要绘图时,可在同一目录安装含 NumPy、PyVista、VTK 和 Matplotlib 的可选依赖组,执行 python -m pip install ".[plots]"。常规运行记录和文字 HTML 报告可用基础安装。命令 navifield 和解压目录里的 navifield.cmd 均可使用。以下示例保留在解压目录中运行。

配置 Windows 求解器

从第三方程序与官方下载地址获取本例需要的程序。梁使用 CalculiX,方腔使用 OpenFOAM,八进程圆管还需要与该构建匹配的 Microsoft MPI。NaviField 提供配置脚本,求解器和 DLL 由各自发行方提供。

梁例只需将 NAVIFIELD_CCX_BIN 设为实际含 ccx.exe 及其配套 DLL 的目录。输入以下命令时,先把尖括号和其中的文字换成自己的路径。

set "NAVIFIELD_CCX_BIN=<CalculiX 的 bin 目录>"
call configure-toolchain.cmd

脚本只设置当前 cmd 会话。NAVIFIELD_PYTHON 是运行示例脚本和 CLI 的 Python 解释器,默认使用已激活虚拟环境的 python.exe;也可自行设为该解释器的完整路径。Linux 上命令行工具可运行,求解器环境需自备。

三步运行公开梁示例

以下命令使用上面已配置的环境,并创建新的案例目录。

1. 创建案例

"%NAVIFIELD_PYTHON%" examples\cli-v01\beam\make_case.py work\beam\case

2. 运行求解器

navifield.cmd run --project work\beam --cwd case --cores 8 --wall-seconds 870 -- ccx -i beam

3. 检查计算并查看记录

"%NAVIFIELD_PYTHON%" examples\cli-v01\beam\check.py work\beam\case
navifield.cmd show --project work\beam --rid r001

一次实际运行的完整终端输出(运行号和墙钟秒数随当次运行变化):

work\beam\case
r001
tip_mean_down_mm=0.190122717; euler_bernoulli_mm=0.19047619; relative_error=0.00185574; limit=0.02
{"run_id": "r001", "state": "completed", "exit_code": 0, "cores": 8, "wall_seconds": 0.779568, "details": ".navifield/records/r001.json"}

该梁例将端面平均挠度与 Euler–Bernoulli 解析值比较,短梁剪切变形可能造成模型差异;它不替代具体工程验收。

其他命令

navifield.cmd run --project work\my-project --cwd case --background --cores 8 --wall-seconds 900 -- solver.exe argument1
navifield.cmd wait --project work\my-project --rid r001
navifield.cmd status --project work\my-project --rid r001
navifield.cmd show --project work\my-project --rid r001
navifield.cmd report --project work\my-project --rid r001
navifield.cmd self-check --project work\my-project --rid r001
navifield.cmd monitor --project work\my-project
navifield.cmd stop --project work\my-project --rid r001

先在项目下创建 case 并放入输入;-- 后每项为程序和参数,不经过 shell。--input 项目相对路径 可重复指定其他项目内输入。运行号以实际输出为准。report 和 self-check 返回 HTML 路径;self-check 可重复 --rid 合看多个运行,并以 --facts、--monitor 或 --absolute-pressure 传入用户明确提供的数据,缺失项不会被推断。

status 和 show 默认返回简短 JSON 及记录/日志路径,status 不修改项目;加 --full 输出完整机器可读结果。wait 通常返回完整一行 JSON;表或残差很多时返回代表性末值及完整 JSON 路径,加 --full 输出全部内容。可加 --timeout 秒、--residual-below 值、--then-stop 或 --stop-on-divergence;停止只是请求,须确认终态。

wait 的退出码为 0(运行成功完成)、3(返回时仍在运行,例如等待超时或刚发出停止请求)、1(其他终态或无法确认状态)。同时读 JSON 的 state 和 reason。

运行监控

wait 和 monitor 只识别 OpenFOAM 样式日志中的残差。其他求解器仍可查看可识别的监测表和日志末尾。网页最多绘制 8 条残差曲线,其余方程列在数值表中。monitor 只监听本机 127.0.0.1:8790,按 Ctrl+C 结束;在其他电脑浏览时可通过 SSH 转发该端口。

网格转换与其他公开例

"%NAVIFIELD_PYTHON%" tools\mesh_convert.py mesh.msh --case work\my-case

案例须先有 system/controlDict 且不存在 constant/polyMesh。转换器默认是 PATH 中的 gmshToFoam,可用 --converter 指定;完整原生日志写入案例的 gmshToFoam.log,已有日志不覆盖,可用 --log 指定新文件。检查退出码、网格质量及边界名称、类型和面数。

方腔与圆管的完整输入生成器及检查脚本位于 examples/cli-v01/cavity 和 examples/cli-v01/pipe。它们分别与 Ghia 等人的 Re=1000 结果及 IAEA 手册的 Blasius 摩擦关系比较;先按案例实际环境依次运行网格生成、网格检查、求解和检查脚本。

方腔:顺序执行

使用 Windows MinGW 版 OpenFOAM。把项目根目录设为含 etc\controlDict 的目录;脚本默认在其 platforms\win64MingwDPInt32Opt\bin 寻找求解器。如果可执行文件在别处,再设 NAVIFIELD_FOAM_BIN。

set "NAVIFIELD_FOAM_ROOT=<OpenFOAM 项目根目录>"
call configure-toolchain.cmd

从解压根目录、激活工具链后执行:

"%NAVIFIELD_PYTHON%" examples\cli-v01\cavity\make_case.py work\cavity\case
navifield.cmd run --project work\cavity --cwd case --wall-seconds 30 -- blockMesh
navifield.cmd run --project work\cavity --cwd case --wall-seconds 30 -- checkMesh -allTopology -allGeometry
navifield.cmd run --project work\cavity --cwd case --wall-seconds 780 -- simpleFoam
navifield.cmd run --project work\cavity --cwd case --wall-seconds 30 -- simpleFoam -postProcess -latestTime
"%NAVIFIELD_PYTHON%" examples\cli-v01\cavity\check.py work\cavity\case
navifield.cmd report --project work\cavity --rid r003

圆管:八进程执行

在上面的 OpenFOAM 环境中,将 NAVIFIELD_MPI_BIN 指向 Microsoft MPI 的 mpiexec.exe 所在目录。若 OpenFOAM 的默认通信库是串行 dummy,而发行目录提供 libPstream.dll-msmpi,用下面的命令在新目录准备并行副本。已配置为 MS-MPI 的发行环境可省略 NAVIFIELD_PARALLEL_BIN。若需要明确指定与启动器匹配的 DLL,可在调用配置脚本前设置 NAVIFIELD_MPI_DLL 为所安装的 msmpi.dll 完整路径。

set "NAVIFIELD_MPI_BIN=<Microsoft MPI 的 Bin 目录>"
set "NAVIFIELD_PARALLEL_BIN=%CD%\work\openfoam-msmpi-bin"
call configure-toolchain.cmd

首次配置会从你自己的 OpenFOAM 安装复制可执行目录,在副本中启用随安装提供的 MS-MPI 变体;以后同一路径将复用。更换 OpenFOAM 或 MPI 版本时,请指定新的并行目录。

本例依次生成网格、分区、八进程求解并重构:

"%NAVIFIELD_PYTHON%" examples\cli-v01\pipe\make_case.py work\pipe\case
navifield.cmd run --project work\pipe --cwd case --wall-seconds 20 -- blockMesh
navifield.cmd run --project work\pipe --cwd case --wall-seconds 20 -- checkMesh -allTopology -allGeometry
navifield.cmd run --project work\pipe --cwd case --wall-seconds 20 -- decomposePar
navifield.cmd run --project work\pipe --cwd case --cores 8 --wall-seconds 800 -- mpiexec -n 8 simpleFoam -parallel
navifield.cmd run --project work\pipe --cwd case --wall-seconds 20 -- reconstructPar -latestTime
"%NAVIFIELD_PYTHON%" examples\cli-v01\pipe\check.py work\pipe\case
navifield.cmd report --project work\pipe --rid r004

若希望把本次求解的残差和监测表绘成曲线,可在安装绘图依赖后运行 navifield.cmd report --project work\pipe --rid r004 --plots。实际运行号以各命令输出为准。圆管比较前还应检查流动发展、质量守恒及壁面 y+。

已知局限

  • 停止采用进程树终止请求,求解器可能不会写出最新场或安全检查点;状态 unknown 不是成功。
  • OpenFOAM 残差低于阈值、程序退出0或自检有结果,都不等于结果可交付。仍需检查物理输入、网格、监控量、守恒、网格敏感性及适用参考。
  • 运行时仅复制不超过1 MiB的案例文件;大文件记录大小和时间,复制失败会提示。监测表单位不自动推断。
  • 梁的解析解、方腔的文献数据和圆管经验关联分别有适用条件;单一网格不能证明网格无关。报告和自检列事实及缺项,不作工程通过判定。

OpenFOAM® 为其商标持有方的商标;本项目与其无关联,未获其认可。许可证和依赖状态见 LICENSE、NOTICE、THIRD_PARTY_NOTICES.md。

Metadata

Release files for navifield 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for navifield 0.1.0
File Size Uploaded Provenance Actions
navifield-0.1.0.tar.gz 98.5 kB Without provenance Details for navifield-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for navifield 0.1.0
File Interpreter ABI Platform Actions
navifield-0.1.0-py3-none-any.whl Python 3 none any Details for navifield-0.1.0-py3-none-any.whl

Total release size: 206.4 kB

Security for navifield 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page