You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-37Lines changed: 10 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,40 +21,13 @@
21
21
22
22
DeepFlame is a deep learning empowered computational fluid dynamics package for single or multiphase, laminar or turbulent, reacting flows at all speeds. It aims to provide an open-source platform to combine the individual strengths of [OpenFOAM](https://openfoam.org), [Cantera](https://cantera.org), and [PyTorch](https://pytorch.org/) libraries for deep learning assisted reacting flow simulations. It also has the scope to leverage the next-generation heterogenous supercomputing and AI acceleration infrastructures such as GPU and FPGA.
23
23
24
-
The neural network models used in the tutorial examples can be found at– [AIS Square](https://www.aissquare.com/). To run DeepFlame with DNN, download the DNN model [DFODE](https://www.aissquare.com/models/detail?pageType=models&name=DF-ODENet_DNNmodel&id=197) into the case folder you would like to run.
24
+
The neural network models used in the tutorial examples can be found at– [AIS Square](https://www.aissquare.com/). To run DeepFlame with DNN, download the DNN model [DF-ODENet](https://www.aissquare.com/models/detail?pageType=models&name=DF-ODENet_DNNmodel&id=197) into the case folder you would like to run.
25
25
26
26
## Documentation
27
27
Detailed guide for installation and tutorials is available on [our documentation website](https://deepflame.deepmodeling.com).
28
28
29
29
## Features
30
-
New in v1.6 (2025/5/30):
31
-
- Add a new solver, dfSteadyFoam, a steady-state compressible flow solver. It supports turbulence and uses the SIMPLE algorithm to efficiently compute steady solutions
32
-
- Extend energy model to support sensible enthalpy (hs) in addition to absolute enthalpy (ha) and internal energy (ea). Furthermore, T, h and cp can now be computed independently of Cantera, improving flexibility and removing external dependencies. `CANTERA_THERMO` is added in bashrc to control method to calculate h, cp and update T. `CANTERA_THERMO=1`(current default) means using Cantera and `CANTERA_THERMO=0` means using deepflame.
33
-
- Improve install.sh by displaying system architecture (e.g., x86_64) after build for clearer platform information
34
-
- Switch to sphinx-book-theme and update documentation build environment (Ubuntu 24.04, Python 3.12) for better appearance and compatibility
35
-
- Add 2D Riemann problem example case
36
-
37
-
New in v1.5 (2025/1/8):
38
-
- Provide a new boundary condition, totalFlowRateAdvectiveDiffusion (adopted from OpenFOAM v7), which accounts for diffusion effects at the boundary
39
-
- Develop a new solver, `dfBuoyancyFoam`(adopted from fireFoam in OpenFOAM v7), a transient, compressible solver designed to model turbulent reacting flows incorporating buoyancy effects
40
-
- Add radiation models, which are integrated into the current `dfBuoyancyFoam` solver, and can be incorporated into other solvers if needed
41
-
- Add new combustion models (including infinitelyFastChemistry and eddyDissipationModel) to the `dfBuoyancyFoam` solver
42
-
- Imply DeepFlame on Arm architecture platforms
43
-
44
-
New in v1.4 (2024/8/22):
45
-
- Reorganize the update order of mass, velocity and temperature for Lagrangian particles and introduce the liquidEvaporationSpalding model as new evaporation model.
46
-
- Add source terms for liquid phase in the `dfLowMachFoam` solver
47
-
- Incorporate Euler-Lagrangian source terms into the `dfHighSpeedFoam` solver to facilitate numerical simulations of two-phase supersonic reactive flows
48
-
- Provide new flux schemes (including HLLC and HLLCP) for `dfHighSpeedFoam` solver (adopted from detonationFoam ) and do some modifications
49
-
- Add lagrangianExtraFunctionObjects function (adopted from lagrangianExtraFunctionObjects ) in submodules to write to disk in the old positions file format
50
-
- Introduce new cases to evaluate the accuracy of `dfHighSpeedFoam` solver and provide two-phase 1D/2D detonation cases
51
-
- Add AUSMDV scheme as new flux scheme for `dfHighSpeedFoam`
52
-
- add compatibility of neural network inference for chemical source terms with the Baidu PaddlePaddle framework
53
-
- Adjust original examples referring to the modification of solvers
54
-
- Add 2D aachenBomb case in test
55
-
- Update PaddlePaddle options for DNN model development and inference in document homepage
56
-
57
-
New in v1.3 (2023/12/30):
30
+
New in v1.3.0 (2023/12/30):
58
31
- Complete the full-loop GPU implementation of the `dfLowMachFoam` solver, enabling efficient execution of all computations on GPU
59
32
- Introduce `DF-ODENet` model, which utilizes sampling from canonical combustion simulation configurations to reduce training costs and improve computational efficiency
60
33
- Support Large Eddy Simulation (LES) and two-phase combustion simulation capabilities
@@ -63,7 +36,7 @@ New in v1.3 (2023/12/30):
63
36
- Modify Cantera's approach to transport property calculations to support real fluid thermophysical property calculation of multi-component reactive flows and integrate neural networks for updating real fluid thermophysical properties
64
37
- Add new example cases and update the documentation homepage to provide more comprehensive installation and usage instructions
65
38
66
-
New in v1.2 (2023/06/30):
39
+
New in v1.2.0 (2023/06/30):
67
40
- Enable GPU acceleration for fast and efficient discrete matrix construction for solving partial differential equations
68
41
- Introduce `DeePFGM` model: a neural network-based approach to replace the flamelet database of the FGM model and reduce memory requirement
69
42
- Support real fluid density calculation with Cantera's PR/RK equation of state and updated the calculation of isentropic compression coefficient (psi)
@@ -75,7 +48,7 @@ New in v1.2 (2023/06/30):
75
48
- Implement mechanism file detection function to verify the validity of the mechanism file input
76
49
- Capture and report Cantera errors for better error handling and user experience
77
50
78
-
New in v1.1 (2023/03/31):
51
+
New in v1.1.0 (2023/03/31):
79
52
- Add FGM model
80
53
- Add GPU-compatible linear solver [AmgX](https://github.com/NVIDIA/AMGX) (adopted from [petsc4Foam](https://develop.openfoam.com/modules/external-solver) and [FOAM2CSR](https://gitlab.hpc.cineca.it/openfoam/foam2csr))
81
54
- Add new load balancing algorithm
@@ -85,28 +58,28 @@ New in v1.1 (2023/03/31):
85
58
- Reconstruct `dfChemistryModel`
86
59
- Update chemical and mixing time scale models in PaSR combustion model
87
60
88
-
New in v1.0 (2022/11/15):
61
+
New in v1.0.0 (2022/11/15):
89
62
- Add support for the parallel computation of DNN using libtorch on multiple GPUs
90
63
- Add TCI model
91
64
92
-
New in v0.5 (2022/10/15):
65
+
New in v0.5.0 (2022/10/15):
93
66
- Add support for the parallel computation of DNN via single and multiple GPUs
94
67
- Add access for utilising PyTorch
95
68
96
-
New in v0.4 (2022/09/26):
69
+
New in v0.4.0 (2022/09/26):
97
70
- Adapt combustion library from OpenFOAM into DeepFlame
98
71
-`laminar`; `EDC`; `PaSR` combustion models
99
72
100
-
New in v0.3 (2022/08/29):
73
+
New in v0.3.0 (2022/08/29):
101
74
- 1/2/3D adaptive mesh refinement (2/3D adopted from [SOFTX_2018_143](https://github.com/ElsevierSoftwareX/SOFTX_2018_143) and [multiDimAMR](https://github.com/HenningScheufler/multiDimAMR))
102
75
- Add Sigma/dynSmag LES turbulence models
103
76
- Add functionObjects/field library
104
77
- New example reactiveShockTube for `dfHighSpeedFoam`
105
78
106
-
New in v0.2 (2022/07/25):
79
+
New in v0.2.0 (2022/07/25):
107
80
- Dynamic load balancing for chemistry solver (adopted from [DLBFoam](https://github.com/blttkgl/DLBFoam-1.0))
108
81
109
-
From v0.1 (2022/06/15):
82
+
From v0.1.0 (2022/06/15):
110
83
- Native Cantera reader for chemical mechanisms in `.cti`, `.xml` or `.yaml` formats
111
84
- Full compatiblity with Cantera's `UnityLewis`, `Mix` and `Multi` transport models
112
85
- Zero-dimensional constant pressure or constant volume reactor solver `df0DFoam`
0 commit comments