Skip to content
This repository was archived by the owner on Jun 27, 2024. It is now read-only.

Commit a969040

Browse files
baperry2wjge
andauthored
update readme with citation and pointer to PelePhysics (#24)
* update readme with citation and pointer to PelePhysics * update README --------- Co-authored-by: w0g <gew1@ornl.gov>
1 parent 24b02e4 commit a969040

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,20 @@
44
[![AMReX Badge](https://img.shields.io/static/v1?label=%22powered%20by%22&message=%22AMReX%22&color=%22blue%22)](https://amrex-codes.github.io/amrex/)
55
[![Exascale Computing Project](https://img.shields.io/badge/supported%20by-ECP-blue)](https://www.exascaleproject.org/research-project/combustion-pele/)
66

7+
# WARNING
8+
9+
The production version of PeleRad have been moved to [PelePhysics](https://github.com/AMReX-Combustion/PelePhysics) and this repository is now only for experimental developments.
10+
Further development is continuing within PelePhysics. The tests are in PelePhysics, while the example cases are part of PeleLMeX.
11+
712
## Table of Contents
813
- [Description](#description)
914
- [Installation](#installation)
1015
- [Usage](#usage)
1116
- [License](#license)
17+
- [Citation](#citation)
1218

1319
## Description
14-
PeleRad is a module for modeling radiative transfer in reacting flows. It supports GPU performance portability and adaptive mesh refinement through AMReX and is coupled to PeleLMeX.
20+
PeleRad was a module for modeling radiative transfer in reacting flows. It supports GPU performance portability and adaptive mesh refinement through AMReX and is coupled to PeleLMeX.
1521

1622
## Installation
1723
1. Clone the repository: `git clone https://github.com/AMReX-Combustion/PeleRad.git`
@@ -22,7 +28,7 @@ To build with the PeleLMeX flow solver, GNUMake is prefered.
2228
One example script to build a test case on Frontier is provided in the '/scripts' folder.
2329

2430
To run the script:
25-
'./build_PeleLMeX_Fontier.sh'
31+
'./build_PeleLMeX_Fontier.sh'
2632

2733
## Usage
2834
PeleRad is designed for modeling radiative transfer in reacting flows. To activate and use PeleRad in conjunction with PeleLMeX, follow these steps:
@@ -35,4 +41,14 @@ PeleRad is designed for modeling radiative transfer in reacting flows. To activa
3541
The license file is located at
3642
https://github.com/AMReX-Combustion/PeleMP/blob/master/license.txt
3743

38-
44+
## Citation
45+
To cite PeleMP, please use the following [Journal of Fluids Engineering article](https://doi.org/10.1115/1.4064494):
46+
```
47+
@article{owen2023pelemp,
48+
title={PeleMP: The Multiphysics Solver for the Combustion Pele Adaptive Mesh Refinement Code Suite},
49+
author={Owen, Landon D and Ge, Wenjun and Rieth, Martin and Arienti, Marco and Esclapez, Lucas and S Soriano, Bruno and Mueller, Michael E and Day, Marc and Sankaran, Ramanan and Chen, Jacqueline H},
50+
journal={Journal of Fluids Engineering},
51+
pages={1--41},
52+
year={2023}
53+
}
54+
```

0 commit comments

Comments
 (0)