# funlbm

**Repository Path**: farfarfun/funlbm

## Basic Information

- **Project Name**: funlbm
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-08
- **Last Updated**: 2026-10-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# funlbm

基于 PyTorch 的三维格子玻尔兹曼方法（LBM）数值模拟库，支持流固耦合的颗粒仿真、
多种离散速度模型（D3Q13/D3Q15/D3Q19/D3Q27）、断点续算与 HDF5/VTK/Tecplot 数据导出。

## 安装

需要 Python 3.10 或更高版本。核心计算依赖 PyTorch；使用 `funlbm.plot` 绘图时还需要可用的
Matplotlib 图形后端（当前实现使用 TkAgg）。

```bash
pip install funlbm
```

## 开发验证

项目使用 pytest 与 Ruff 进行测试和代码检查：

```bash
uv run pytest
uv run ruff check .
uv run ruff format .
```

## 最小可运行示例

在空目录创建 `config.json`：

```json
{
  "max_step": 1,
  "flow": {
    "size": [6, 6, 6]
  },
  "file": {
    "cache_dir": "./data",
    "custom": {
      "per_step": 1
    },
    "checkpoint": {
      "per_step": 1
    }
  },
  "particles": []
}
```

然后运行一次单步模拟：

```bash
funlbm run --config ./config.json
```

运行后会在 `./data/` 生成跟踪数据库、`constant.h5` 和检查点文件。更完整的配置示例见仓库内 [`example/`](example) 目录（`freefall`、`poiseuille` 等场景）。

## 命令行用法

安装后会提供 `funlbm` 命令行工具：

```bash
funlbm run --config ./config.json      # 前台运行一次模拟
funlbm submit --config ./config.json   # 提交任务（本地/HPC 算力平台）
funlbm update                          # 更新到最新版本
```

## 相关链接

[pylbm](https://github.com/pylbm/pylbm)

---

## 关于 farfarfun

[farfarfun](https://github.com/farfarfun) 是一个专注于实用工具库的开源组织，
涵盖云存储、数据处理、AI、多媒体与开发工具链等方向。

- 🏠 组织主页：<https://github.com/farfarfun>
- 📦 PyPI：<https://pypi.org/user/niuliangtao/>
- 📧 联系：farfarfun@qq.com

本项目基于 [MIT](LICENSE) 协议开源。