diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..c57b4f1c6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Propose an enhancement to MFC +title: '' +labels: enhancement +assignees: '' +--- + +### Problem it solves + + +### Proposed solution + + +### Alternatives + + +### Additional context + + + + + + + + diff --git a/CITATION.cff b/CITATION.cff index e1c3947a4c..05fb733d87 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -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 diff --git a/README.md b/README.md index b5d0152979..aafc401a1e 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,43 @@

+

+ + + + + + + + + + + + +

+ +

+ + Star History Chart + +

+ +> **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. @@ -35,6 +72,9 @@ MFC is a 2025 Gordon Bell Prize Finalist. + + +