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

Readme update #19

Merged
merged 2 commits into from
Jan 26, 2024
Merged
Changes from all 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
24 changes: 23 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ PeleMP: Multiphysics solver for the Pele code suite
|AMReX Badge|
|Exascale Computing Project Badge|

`PeleMP` is the multiphysics code extension for `PeleC`, `PeleLM`, and `PeleLMeX`. Currently provides models for sprays and soot.
`PeleMP` was the multiphysics code extension for `PeleC`, `PeleLM`, and `PeleLMeX`. It provided models for sprays and soot.

WARNING
-------

The physics modules and documentation of PeleMP have been moved to
`PelePhysics <https://github.com/AMReX-Combustion/PelePhysics>`_,
and this repository is now archived. Further development is continuing
within PelePhysics. The test cases have moved to the PeleC and PeleLMeX repositorties.

Getting Started
~~~~~~~~~~~~~~~
Expand All @@ -23,6 +31,20 @@ Detailed instructions are provided in the `Documentation <https://amrex-combusti
export PELEMP_HOME=<path_to_PeleMP>
git clone https://github.com/AMReX-Combustion/PeleMP.git ${PELEMP_HOME}

Citation
~~~~~~~~

To cite the Soot and Spray capabilities from PeleMP, please use the following `Journal of Fluids Engineering article <https://doi.org/10.1115/1.4064494>`_: ::

@article{owen2023pelemp,
title={PeleMP: The Multiphysics Solver for the Combustion Pele Adaptive Mesh Refinement Code Suite},
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},
journal={Journal of Fluids Engineering},
pages={1--41},
year={2023}
}


Dependencies
~~~~~~~~~~~~

Expand Down
Loading