Skip to content

Commit a5b4924

Browse files
committed
Merge branch 'master' of https://github.com/MFlowCode/MFC into amdgpu
2 parents 311504b + 98d91e1 commit a5b4924

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
![MFC Banner](doc/res/banner.png)
1+
<p align="center">
2+
<img src="doc/res/banner.png" alt="MFC Banner" width="500"/></center>
3+
</p>
24

35
<p align="center">
46
<a href="http://dx.doi.org/10.1016/j.cpc.2020.107396">
@@ -24,19 +26,25 @@
2426
</a>
2527
</p>
2628

27-
Welcome to MFC! The MFC is a fully-documented parallel simulation software for multi-component, multi-phase, and bubbly flows.
29+
Welcome to the home of MFC!
30+
MFC simulates compressible multi-component and multi-phase flows, amongst other things.
31+
It scales ideally to tens of thousands of GPUs.
32+
MFC is a Fortran codebase that makes use of metaprogramming to keep the codebase readable and compact.
33+
Please contact the developers, like [Spencer](mailto:[email protected]), if you have any questions.
34+
We have an active Slack channel to help ease in new MFC users and support development.
2835

29-
Documentation is available on [our website](https://mflowcode.github.io/) and in markdown format at [doc/landing/readme.md](doc/landing/readme.md).
36+
MFC has both API and high-level documentation.
37+
It is available on [the website](https://mflowcode.github.io/) and in markdown format at [doc/landing/readme.md](doc/landing/readme.md).
3038

31-
The paper that describes the MFC's capabilities:
39+
If you use MFC, consider citing it:
3240
* <a href="https://doi.org/10.1016/j.cpc.2020.107396">
3341
S. H. Bryngelson, K. Schmidmayer, V. Coralic, K. Maeda, J. Meng, T. Colonius (2021) Computer Physics Communications 4655, 107396
3442
</a>
3543

3644
```
3745
@article{Bryngelson_2021,
3846
title = {MFC: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver},
39-
author = {Spencer H. Bryngelson and Kevin Schmidmayer and Vedran Coralic and Jomela C. Meng and Kazuki Maeda and Tim Colonius},
47+
author = {Spencer H. Bryngelson and Kevin Schmidmayer and Vedran Coralic and Jomela C. Meng and Kazuki Maeda and Tim Colonius},
4048
journal = {Computer Physics Communications},
4149
doi = {10.1016/j.cpc.2020.107396},
4250
year = 2021,
@@ -53,5 +61,5 @@ MFC is under the MIT license (see [LICENSE](LICENSE) file for full text).
5361

5462
<p align="justify">
5563
MFC development was supported by multiple current and past grants from the US Office of Naval Research (ONR), the US National Institute of Health (NIH), and the US National Science Foundation (NSF).
56-
MFC computations utilize the Extreme Science and Engineering Discovery Environment (XSEDE), under allocations TG-CTS120005 (PI Colonius) and TG-PHY210084 (PI Bryngelson) and OLCF Summit under allocation CFD154 (PI Bryngelson).
64+
MFC computations utilize the Extreme Science and Engineering Discovery Environment (XSEDE, now ACCESS), under allocations TG-CTS120005 (PI Colonius) and TG-PHY210084 (PI Bryngelson) and OLCF Summit under allocation CFD154 (PI Bryngelson).
5765
</p>

doc/res/banner.png

-124 KB
Loading

doc/res/icon.ico

249 KB
Binary file not shown.

0 commit comments

Comments
 (0)