Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
blank_issues_enabled: false
contact_links:
- name: Questions & support
url: https://github.com/MFlowCode/MFC/discussions
about: Get help, show results, and discuss ideas
- name: Slack community
url: https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw
about: Join our Slack workspace for real-time discussion







26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature request
about: Propose an enhancement to MFC
title: ''
labels: enhancement
assignees: ''
---

### Problem it solves
<!-- What limitation or use case does this address? -->

### Proposed solution
<!-- Describe the change and where it integrates (modules, scripts, docs). -->

### Alternatives
<!-- Any other approaches considered -->

### Additional context
<!-- Links, references, mockups, examples -->







104 changes: 84 additions & 20 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,91 @@

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "Multicomponent Flow Code"
title: "Multicomponent Flow Code (MFC)"
url: "https://github.com/MFlowCode/MFC"
preferred-citation:
type: article
title: "MFC: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver"
journal: "Computer Physics Communications"
doi: "10.1016/j.cpc.2020.107396"
volume: 266
start: 107396
month: 5
year: 2021
title: "MFC 5.0: An exascale many-physics flow solver"
doi: "10.48550/arXiv.2503.07953"
year: 2025
authors:
- given-names: Spencer H.
family-names: Bryngelson
- given-names: Kevin
family-names: Schmidmayer
- given-names: Vedran
family-names: Coralic
- given-names: Jomela C.
family-names: Meng
- given-names: Kazuki
family-names: Maeda
- given-names: Tim
family-names: Colonius
- given-names: Benjamin
family-names: Wilfong
- given-names: Henry
family-names: Le Berre
- given-names: Anand
family-names: Radhakrishnan
- given-names: Ansh
family-names: Gupta
- given-names: Diego
family-names: Vaca-Revelo
- given-names: Dimitrios
family-names: Adam
- given-names: Haocheng
family-names: Yu
- given-names: Hyeoksu
family-names: Lee
- given-names: Jose Rodolfo
family-names: Chreim
- given-names: Mirelys
family-names: Carcana Barbosa
- given-names: Yanjun
family-names: Zhang
- given-names: Esteban
family-names: Cisneros-Garibay
- given-names: Aswin
family-names: Gnanaskandan
- given-names: Mauro
family-names: Rodriguez Jr.
- given-names: Reuben D.
family-names: Budiardja
- given-names: Stephen
family-names: Abbott
- given-names: Tim
family-names: Colonius
- given-names: Spencer H.
family-names: Bryngelson
references:
- type: article
title: "Method for portable, scalable, and performant GPU-accelerated simulation of multiphase compressible flow"
doi: "10.1016/j.cpc.2024.109238"
journal: "Computer Physics Communications"
volume: 302
start: 109238
year: 2024
authors:
- given-names: A.
family-names: Radhakrishnan
- given-names: H.
family-names: Le Berre
- given-names: B.
family-names: Wilfong
- given-names: J.-S.
family-names: Spratt
- given-names: M.
family-names: Rodriguez Jr.
- given-names: T.
family-names: Colonius
- given-names: S. H.
family-names: Bryngelson
- type: article
title: "MFC: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver"
doi: "10.1016/j.cpc.2020.107396"
journal: "Computer Physics Communications"
volume: 266
start: 107396
month: 5
year: 2021
authors:
- given-names: Spencer H.
family-names: Bryngelson
- given-names: Kevin
family-names: Schmidmayer
- given-names: Vedran
family-names: Coralic
- given-names: Jomela C.
family-names: Meng
- given-names: Kazuki
family-names: Maeda
- given-names: Tim
family-names: Colonius
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,43 @@
</a>
</p>

<p align="center">
<a href="https://mflowcode.github.io/">
<img src="https://img.shields.io/badge/docs-mflowcode.github.io-blue" />
</a>
<a href="https://github.com/MFlowCode/MFC/discussions">
<img src="https://img.shields.io/badge/discussions-join-brightgreen" />
</a>
<a href="https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=MFlowCode%2FMFC">
<img src="https://img.shields.io/badge/Codespaces-Open%20in%201%20click-2ea44f?logo=github" />
</a>
<a href="https://github.com/MFlowCode/MFC/releases">
<img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release&sort=semver" />
</a>
</p>

<p align="center">
<a href="https://star-history.com/#MFlowCode/MFC&Date">
<img src="https://api.star-history.com/svg?repos=MFlowCode/MFC&type=Date" alt="Star History Chart" width="600"/>
</a>
</p>

> **If MFC helps your work, please ⭐ the repo and cite it!**

### Who uses MFC

MFC runs at exascale on the world's fastest supercomputers:
- **OLCF Frontier** (>33K AMD MI250X GPUs)
- **LLNL El Capitan** (>43K AMD MI300A APUs)
- **LLNL Tuolumne**, **CSCS Alps**, and many others

### Try MFC

| Path | Command |
| --- | --- |
| **Codespaces** (fastest) | Click the "Codespaces" badge above to launch in 1 click |
| **Local build** | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |

**Welcome!**
MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do).
It uses metaprogramming and is short (20K lines) and portable.
Expand All @@ -35,6 +72,9 @@ MFC is a 2025 Gordon Bell Prize Finalist.
<a href="https://doi.org/10.48550/arXiv.2503.07953" target="_blank">
<img src="https://img.shields.io/badge/DOI-10.48550/arXiv.2503.07953-thistle.svg"/>
</a>
<a href="https://doi.org/10.5281/zenodo.17049757" target="_blank">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.17049757.svg"/>
</a>
<a href="https://github.com/MFlowCode/MFC/stargazers" target="_blank">
<img src="https://img.shields.io/github/stars/MFlowCode/MFC?style=flat&color=maroon"/>
</a>
Expand Down