# ti-sph

**Repository Path**: zoziha/ti-sph

## Basic Information

- **Project Name**: ti-sph
- **Description**: 光滑粒子流体动力学（2D），用于碰撞、砰击数值模拟研究
- **Primary Language**: FORTRAN
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: https://ti-sph.netlify.app/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-10-22
- **Last Updated**: 2023-03-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Ti-SPH 项目

基于光滑粒子水动力学，进行水动力学砰击效应的仿真研究。
本项目很大程度借鉴了LIU的《光滑粒子流体动力学》书后代码。

[![ti-sph](https://img.shields.io/badge/Ti--SPH-v0.3.5-blueviolet)][1]
[![ford](https://img.shields.io/badge/Docs-FORD_|_MDBook-ff69b4)](https://ti-sph.netlify.app/)
[![license](https://img.shields.io/badge/License-BSD--3-important)](LICENSE)
[![wakatime](https://wakatime.com/badge/user/ca8e3153-da86-47e8-ba89-1fac0c842c19/project/3a780599-f34d-4e6f-9306-58785e1e27a5.svg)][4]
[![Builder](https://img.shields.io/badge/Builder-meson^0.50.0-blue)][2]
[![Compiler](https://img.shields.io/badge/Compiler-GFortran^10.3.5-brightgreen)][3]
[![Fortran](https://img.shields.io/badge/Fortran-^2018-purple)](https://fortran-lang.org/)

[1]: https://github.com/zoziha/ti-sph
[3]: https://fortran-lang.org/compilers/
[4]: https://wakatime.com/@zoziha/projects/hnvipavykf

## 开始

获取源码及依赖：

```sh
git clone https://github.com/zoziha/ti-sph
cd ti-sph
```

依赖项：

* HDF5 > 1.10.6，用于数据存储；
* Lua >= 5.3，用于前处理，仅 starter 依赖 Lua。

## 使用 meson 构建

使用 [meson][3] 构建代码：

```sh
> meson setup _build
> meson devenv -C _build
> meson test engine
```

[3]: https://mesonbuild.com/

## 文档

### 用户文档

使用 [MDBook][5] 构建面向用户的帮助手册：

```sh
cd doc
mdbook build
start ./book/index.html
```

_备注：通过在线 Markdown 阅读，点击 [SUMMAY.md](./doc/src/SUMMARY.md) 。_

[5]: https://github.com/rust-lang/mdBook

### 开发文档

使用 [FORD][6] 构建面向开发者的开发文档：

```sh
cd engine
ford FORD-project-file.md
start ./doc/API-html/index.html
```

[6]: https://github.com/Fortran-FOSS-Programmers/ford