Welcome to the home of MFC! MFC simulates compressible multi-component and multi-phase flows, amongst other things. It scales ideally to exascale; tens of thousands of GPUs on NVIDIA- and AMD-GPU machines, like Oak Ridge Summit and Frontier. MFC is written in Fortran and makes use of metaprogramming to keep the code short (about 20K lines).
Get in touch with the maintainers, like Spencer, if you have questions! We have an active Slack channel and development team. MFC has high-level documentation, visualizations, and more on its website.
We keep many examples.
Here's one!
MFC can execute high-fidelity simulations of shock-droplet interaction (see examples/3d_shockdroplet)
You can navigate to this webpage to get started using MFC! It's rather straightforward.
We'll give a brief intro. here for MacOS. Using brew, install MFC's modest set of dependencies:
brew install wget make python make cmake coreutils gcc openmpiYou're now ready to build and test MFC! Clone it to a convenient directory via
git clone https://github.com/mflowcode/MFC.git
cd MFCthen build and test!
./mfc.sh build -j 8
./mfc.sh test -j 8And... you're done!
You can learn more about MFC's capabilities via its documentation or play with the examples located in the examples/ directory (some are shown here)!
The shock-droplet interaction case above was run via
./mfc.sh run ./examples/3d_shockdroplet/case.py -n 8where 8 is the number of cores the example will run on.
You can visualize the output data, located in examples/3d_shockdroplet/silo_hdf5, via Paraview, Visit, or your other favorite software.
OLCF Frontier is the first exascale supercomputer. The weak scaling of MFC on this machine is below, showing near-ideal utilization.
MFC has many features. They are organized below, just click the drop-downs!
Physics
- 1-3D
- Compressible
- Multi- and single-component
- 4, 5, and 6 equation models for multi-component/phase features
- Multi- and single-phase
- Phase change via p, pT, and pTg schemes
- Grids
- 1-3D Cartesian, cylindrical, axi-symmetric.
- Arbitrary grid stretching for multiple domain regions available.
- Complex/arbitrary geometries via immersed boundary methods
- STL geometry files supported
- Sub-grid Euler-Euler multiphase models for bubble dynamics and similar
- Viscous effects (high-order accurate representations)
- Ideal and stiffened gas equations of state
- Acoustic wave generation (one- and two-way sound sources)
Numerics
- Shock and interface capturing schemes
- First-order upwinding, WENO3 and 5.
- Reliable handling of high density ratios.
- Exact and approximate (e.g., HLL, HLLC) Riemann solvers
- Boundary conditions: Periodic, reflective, extrapolation/Neumann, slip/no-slip, non-reflecting characteristic buffers, inflows, outflows, and more.
- Runge-Kutta orders 1-3 (SSP TVD)
- Interface sharpening (THINC-like)
Large-scale and accelerated simulation
- GPU compatible on NVIDIA (P/V/A/H100, etc.) and AMD (MI200+) hardware
- Ideal weak scaling to 100% of leadership class machines
- >10K GPUs on OLCF Summit (V100-based)
- >60K GPUs on world's first exascale computer, OLCF Frontier (MI250X-based)
- Near roofline behavior
Software robustness and other features
- Fypp metaprogramming for code readability, performance, and portability
- Continuous Integration (CI)
- Regression test cases on CPU and GPU hardware with each PR. Performed with GNU, Intel, and NVIDIA compilers.
- Benchmarking to avoid performance regressions and identify speed-ups
- Continuous Deployment (CD) of website and API documentation
If you use MFC, consider citing it:
@article{Bryngelson_2021,
title = {{MFC: A}n open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver},
author = {Spencer H. Bryngelson and Kevin Schmidmayer and Vedran Coralic and Jomela C. Meng and Kazuki Maeda and Tim Colonius},
journal = {Computer Physics Communications},
doi = {10.1016/j.cpc.2020.107396},
year = {2021},
pages = {107396},
}Copyright 2021-2024 Spencer Bryngelson and Tim Colonius. MFC is under the MIT license (see LICENSE file for full text).
Multiple federal sponsors have supported MFC development, including the US Department of Defense (DOD), National Institutes of Health (NIH), Department of Energy (DOE), and National Science Foundation (NSF). MFC computations use OLCF Frontier, Summit, and Wombat under allocation CFD154 (PI Bryngelson) and ACCESS-CI under allocations TG-CTS120005 (PI Colonius) and TG-PHY210084 (PI Bryngelson).