From e6695af000deb7b1ba3ca0e7793663625f6f764e Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Mon, 23 Dec 2024 22:17:09 -0500 Subject: [PATCH] Update README.md (#772) --- README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 867dfe307..beeaf092d 100644 --- a/README.md +++ b/README.md @@ -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! -
-Physics +### Physics * 1-3D * Compressible @@ -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)
-
-Numerics +### Numerics * Shock and interface capturing schemes * First-order upwinding @@ -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) -
-
-Large-scale and accelerated simulation + +### 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 @@ -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 -
-
-Software robustness and other features +### Software robustness and other features * [Fypp](https://fypp.readthedocs.io/en/stable/fypp.html) metaprogramming for code readability, performance, and portability * Continuous Integration (CI) @@ -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) -
- ## Citation