opencfd/openfoam-default

OpenFOAM Docker镜像文档

镜像概述

本镜像基于Ubuntu LTS系统构建，集成OpenFOAM计算流体力学（CFD）工具包及"give-me-everything"扩展套件，包含OpenFOAM运行时环境、完整源代码、开发工具链及官方教程资源。旨在为用户提供开箱即用的OpenFOAM开发、仿真与学习环境，简化部署流程并确保环境一致性。

核心功能与特性

1. 完整运行时环境

• 预安装OpenFOAM应用程序及依赖运行时库，支持直接执行CFD求解器（如icoFoam、simpleFoam等）及后处理工具（paraFoam）。

2. 源代码与开发工具

• 包含OpenFOAM完整源代码，便于用户查看、修改及二次开发。
• 集成编译构建工具链（如gcc、cmake、make等），支持源代码编译与自定义求解器开发。

3. 教程资源

• 内置OpenFOAM官方教程案例，覆盖基础到高级CFD仿真场景（如翼型绕流、管道流动等），可直接运行学习。

使用场景与适用范围

1. 科学研究与工程仿真

适用于学术研究或工业界的CFD仿真任务，可直接运行OpenFOAM求解器进行流体动力学模拟。

2. 开发与调试

提供完整源代码及编译环境，支持自定义求解器、函数库的开发与调试。

3. 学习与培训

内置教程案例，适合OpenFOAM初学者通过实践掌握仿真流程与工具使用。

4. 多环境一致性部署

通过Docker容器化，确保不同操作系统（Linux、Windows、macOS）下的OpenFOAM环境一致性，避免依赖冲突。

使用方法与配置说明

1. 获取镜像

请通过官方渠道获取镜像（具体镜像名称及版本请参考OpenFOAM官方文档），或使用指定镜像源拉取：

bash
docker pull docker.xuanyuan.run/[镜像仓库地址]/openfoam-give-me-everything:latest

2. 启动容器

基础运行命令

使用以下命令启动交互式容器，默认进入bash终端：

bash
docker run -it --rm \
  -v $(pwd):/workspace \  # 挂载当前目录至容器内/workspace（可自定义路径）
  --name openfoam-container \
  [镜像名称]:latest \
  /bin/bash

• -it：交互式终端模式
• --rm：容器退出后自动删除
• -v：挂载主机目录至容器，用于数据持久化及文件交换

使用官方启动脚本

OpenFOAM提供专用启动脚本openfoam-docker，简化容器配置：

1. 下载脚本：

   bash
   wget https://dl.openfoam.com/source/latest/openfoam-docker
   chmod +x openfoam-docker
   

2. 运行脚本启动容器（自动处理镜像拉取、权限配置等）：

   bash
   ./openfoam-docker
   

3. 容器内操作

运行OpenFOAM求解器

容器启动后，可直接执行OpenFOAM命令，例如运行 tutorials 中的案例：

bash
cd $FOAM_TUTORIALS/incompressible/simpleFoam/pitzDaily  # 进入教程目录
blockMesh  # 生成网格
simpleFoam  # 运行求解器
paraFoam  # 启动后处理（需配置X11转发，见注意事项）

编译自定义代码

若需修改源代码或开发自定义求解器，进入源代码目录编译：

bash
cd $FOAM_SRC/finiteVolume  # 示例：进入finiteVolume库目录
wmake  # 编译修改后的代码

Docker部署示例

docker run 高级配置示例

挂载多个目录并设置工作目录：

bash
docker run -it --rm \
  -v $(pwd)/cases:/workspace/cases \  # 挂载仿真案例目录
  -v $(pwd)/src:/workspace/src \      # 挂载自定义源代码目录
  -e FOAM_RUN=/workspace/cases \      # 设置FOAM_RUN环境变量（工作目录）
  -w /workspace \                     # 设置容器工作目录
  [镜像名称]:latest \
  /bin/bash

docker-compose 配置示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  openfoam:
    image: docker.xuanyuan.run/[镜像名称]:latest
    container_name: openfoam-workspace
    volumes:
      - ./cases:/workspace/cases
      - ./src:/workspace/src
    environment:
      - FOAM_RUN=/workspace/cases
      - FOAM_SRC=/workspace/src
    tty: true
    stdin_open: true

启动服务：

bash
docker-compose up -d
docker exec -it openfoam-workspace /bin/bash  # 进入容器

配置参数与环境变量

核心环境变量

容器内预定义以下OpenFOAM环境变量（可通过-e参数覆盖）：

• FOAM_RUN：默认仿真工作目录（通常为$HOME/OpenFOAM/$USER-$FOAM_VERSION/run）
• FOAM_SRC：OpenFOAM源代码根目录（通常为/opt/openfoam/src）
• FOAM_TUTORIALS：教程资源目录（通常为/opt/openfoam/tutorials）
• WM_PROJECT_DIR：OpenFOAM安装根目录

路径说明

• 应用程序：$FOAM_APPBIN（如icoFoam、simpleFoam等求解器）
• 运行时库：$FOAM_LIBBIN
• 用户配置：$FOAM_ETC

注意事项

1. 图形界面支持：运行paraFoam等图形工具需配置X11转发（Linux/macOS）或使用VNC（Windows），例如：

   bash
   docker run -it --rm -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$DISPLAY [镜像名称]:latest
   

2. 权限管理：容器内默认使用root用户，建议通过-u $(id -u):$(id -g)参数映射主机用户ID，避免文件权限问题。
3. 性能优化：大规模仿真建议配置容器CPU/内存限制（--cpus、--memory参数）以充分利用主机资源。

参考资源

• OpenFOAM官方文档：[***]
• 启动脚本下载：openfoam-docker