Skip to content

Commit

Permalink
Update README.md (#772)
Browse files Browse the repository at this point in the history
  • Loading branch information
sbryngelson authored Dec 24, 2024
1 parent 06f4418 commit e6695af
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,7 @@ The weak scaling of MFC on this machine shows near-ideal utilization.
MFC has many features.
They are organized below. Just click the drop-downs!

<details>
<summary>Physics</summary>
### Physics

* 1-3D
* Compressible
Expand All @@ -126,15 +125,16 @@ They are organized below. Just click the drop-downs!
* Complex/arbitrary geometries via immersed boundary method
* STL geometry files supported
* Surface tension for multiphase cases
* Sub-grid Euler-Euler multiphase models for bubble dynamics and similar
* Sub-grid dynamics
* Euler-Euler particle models for bubble dynamics and similar
* Euler-Lagrange bubble dynamics
* Viscous effects (high-order accurate representations)
* Ideal and stiffened gas equations of state
* Body forces
* Acoustic wave generation (one- and two-way sound sources)
</details>

<details>
<summary>Numerics</summary>
### Numerics

* Shock and interface capturing schemes
* First-order upwinding
Expand All @@ -148,12 +148,12 @@ They are organized below. Just click the drop-downs!
* Slip and no-slip
* Thompson-based characteristic BCs: non-reflecting sub/supersonic buffers, inflows, outflows
* Generalized characteristic relaxation boundary conditions
* Runge-Kutta orders 1-3 (SSP TVD)
* Runge-Kutta orders 1-3 (SSP TVD), adaptive time stepping
* RK4-5 operator splitting for Euler-Lagrange modeling
* Interface sharpening (THINC-like)
</details>

<details>
<summary>Large-scale and accelerated simulation</summary>

### Large-scale and accelerated simulation

* GPU compatible on NVIDIA (P/V/A/H100, GH200, etc.) and AMD (MI200+) hardware
* Ideal weak scaling to 100% of the largest GPU supercomputers
Expand All @@ -162,10 +162,8 @@ They are organized below. Just click the drop-downs!
* Near compute roofline behavior
* RDMA (remote data memory access; GPU-GPU direct communication) via GPU-aware MPI on NVIDIA (CUDA-aware MPI) and AMD GPU systems
* Optional single-precision computation and storage
</details>

<details>
<summary>Software robustness and other features</summary>
### Software robustness and other features

* [Fypp](https://fypp.readthedocs.io/en/stable/fypp.html) metaprogramming for code readability, performance, and portability
* Continuous Integration (CI)
Expand All @@ -174,8 +172,6 @@ They are organized below. Just click the drop-downs!
* Line-level test coverage reports via [Codecov](https://app.codecov.io/gh/MFlowCode/MFC) and `gcov`
* Benchmarking to avoid performance regressions and identify speed-ups
* Continuous Deployment (CD) of [website](https://mflowcode.github.io) and [API documentation](https://mflowcode.github.io/documentation/index.html)
</details>


## Citation

Expand Down

0 comments on commit e6695af

Please sign in to comment.