Skip to content

Commit 4c162bc

Browse files
authored
Update README.md
1 parent de76a56 commit 4c162bc

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,64 @@ The shock-droplet interaction case above was run via
6969
where `8` is the number of cores the example will run on.
7070
You can visualize the output data, located in `examples/3d_shockdroplet/silo_hdf5`, via Paraview, Visit, or your other favorite software.
7171

72+
## What else can this thing do
73+
74+
MFC has many features.
75+
They are organized below, just click the drop-downs!
76+
77+
<details>
78+
<summary>Physics</summary>
79+
80+
* 1-3D
81+
* Compressible
82+
* Multi- and single-component
83+
* 4, 5, and 6 equation models for multi-component/phase features
84+
* Multi- and single-phase
85+
* Phase change via p, pT, and pTg schemes
86+
* Grids
87+
* 1-3D Cartesian, Cylindrical, Axi-symmetric.
88+
* Arbitrary grid stretching for multiple domain regions available.
89+
* Complex/arbitrary geometries via immersed boundary methods
90+
* STL geometry files supported
91+
* Sub-grid Euler-Euler multiphase models for bubble dynamics and similar
92+
* Viscous effects (high-order accurate representations)
93+
* Ideal and stiffened gas equations of state
94+
* Acoustic wave generation (one- and two-way sound sources)
95+
</details>
96+
97+
<details>
98+
<summary>Numerics</summary>
99+
100+
* Shock and interface capturing schemes
101+
* First-order upwinding, WENO3 and 5.
102+
* Reliable handling of high density ratios.
103+
* Exact and approximate (e.g., HLL, HLLC) Riemann solvers
104+
* Boundary conditions: Periodic, reflective, extrapolation/Neumann, slip/no-slip, non-reflecting characteristic buffers, inflows, outflows, and more.
105+
* Runge-Kutta orders 1-3 (SSP TVD)
106+
* Interface sharpening (THINC-like)
107+
</details>
108+
109+
<details>
110+
<summary>Large-scale and accelerated simulation</summary>
111+
112+
* GPU compatible on NVIDIA (P/V/A/H100, etc.) and AMD (MI200+) hardware
113+
* Ideal weak scaling to 100% of leadership class machines
114+
* \>10K GPUs on [OLCF Summit](https://www.olcf.ornl.gov/summit/) (V100-based)
115+
* \>60K GPUs on world's first exascale computer, [OLCF Frontier](https://www.olcf.ornl.gov/frontier/) (MI250X-based)
116+
* Near roofline behavior
117+
</details>
118+
119+
<details>
120+
<summary>Software robustness and other features</summary>
121+
122+
* [Fypp](https://fypp.readthedocs.io/en/stable/fypp.html) metaprogramming for code readability, performance, and portability
123+
* Continuous Integration (CI)
124+
* Regression test cases on CPU and GPU hardware with each PR. Performed with GNU, Intel, and NVIDIA compilers.
125+
* Benchmarking to avoid performance regressions and identify speed-ups
126+
* Continuous Deployment (CD) of [website](https://mflowcode.github.io) and [API documentation](https://mflowcode.github.io/documentation/index.html)
127+
</details>
128+
129+
72130
## Citation
73131

74132
If you use MFC, consider citing it:

0 commit comments

Comments
 (0)