PeleC: An adaptive mesh refinement solver for compressible reacting flows

Documentation | Nightly Test Results | Citation

Getting Started

• To compile and run PeleC, one needs a C++ compiler that supports the C++17 standard. A hierarchical strategy for parallelism is supported, based on MPI, MPI + OpenMP, or MPI + GPU (CUDA/HIP/DPC++). The code should work with all major MPI and OpenMP implementations. PeleC should build and run with no modifications to the make system if using a Linux system with the GNU compilers, version 7 and above. CMake, although used mostly for testing, is also an option for building the code.

To build PeleC and run a sample 3D flame problem:

1. Have PeleC use the default submodules for AMReX, PelePhysics, and SUNDIALS in its own repo by simply performing:

   git clone --recursive [email protected]:AMReX-Combustion/PeleC.git
   cd PeleC/Exec/RegTests/PMF
   make TPLrealclean && make realclean && make TPL && make -j
   ./Pele3d.xxx.yyy.ex example.inp
   

Dependencies

PeleC is built on the AMReX and PelePhysics libraries. PeleC also requires the SUNDIALS ODE solver library.

Development model

To add a new feature to PeleC, the procedure is:

1. Create a branch for the new feature (locally):

   git checkout -b AmazingNewFeature
   

2. Develop the feature, merging changes often from the development branch into your AmazingNewFeature branch:

   git commit -m "Developed AmazingNewFeature"
   git checkout development
   git pull                     [fix any identified conflicts between local and remote branches of "development"]
   git checkout AmazingNewFeature
   git rebase development        [fix any identified conflicts between "development" and "AmazingNewFeature"]
   

3a. Build and run the full test suite using CMake and CTest (See the Build directory for an example script). Please do not introduce warnings. PeleC is checked against clang-tidy and cppcheck in the CI. To use cppcheck and clang-tidy locally use these CMake options:

-DPELEC_ENABLE_CLANG_TIDY:BOOL=ON
-DPELEC_ENABLE_CPPCHECK:BOOL=ON

3b. Run clang-tidy by using an LLVM compiler and making sure clang-tidy is found during configure. Then make will run clang-tidy along with compilation. Once verifying cppcheck was found during configure, using the make cppcheck target should run its checks on the compile_commands.json database generated by CMake. More information on these checks can be seen in the CI files used for GitHub Actions in the .github/workflows directory.

3c. To easily format all source files before commit, use the following command:

find Source Exec \( -name "*.cpp" -o -name "*.H" \) -exec clang-format -i {} +

4. Push feature branch to PeleC repository:

   git push -u origin AmazingNewFeature [Note: -u option required only for the first push of new branch]
   

5. Submit a pull request through [email protected]:AMReX-Combustion/PeleC.git, and make sure you are requesting a merge against the development branch

6. Check the CI status on Github and make sure the tests passed for merge request

Test Status

Nightly test results for PeleC against multiple compilers and machines can be seen on its CDash page.

Documentation

The full documentation for Pele exists in the Docs directory; at present this is maintained inline using Sphinx Sphinx. With Sphinx, documentation is written in Restructured Text. reST is a markup language similar to Markdown, but with somewhat greater capabilities (and idiosyncrasies). There are several primers available to get started. One gotcha is that indentation matters. To build

$ cd Docs && mkdir build && cd build && sphinx-build -M html ../sphinx .

Citation

To cite the PeleC software and refer to its computational performance, use the following journal article:

@article{PeleC_IJHPCA,
  author = {Marc T {Henry de Frahan} and Jon S Rood and Marc S Day and Hariswaran Sitaraman and Shashank Yellapantula and Bruce A Perry and Ray W Grout and Ann Almgren and Weiqun Zhang and John B Bell and Jacqueline H Chen},
  title = {{PeleC: An adaptive mesh refinement solver for compressible reacting flows}},
  journal = {The International Journal of High Performance Computing Applications},
  volume = {37},
  number = {2},
  pages = {115-131},
  year = {2022},
  doi = {10.1177/10943420221121151},
  url = {https://doi.org/10.1177/10943420221121151}
}

Additionally, to cite the application of PeleC to compressible reacting flows, use the following Combustion and Flame journal article:

@article{Sitaraman2021,
  author = {Hariswaran Sitaraman and Shashank Yellapantula and Marc T. {Henry de Frahan} and Bruce Perry and Jon Rood and Ray Grout and Marc Day},
  title = {Adaptive mesh based combustion simulations of direct fuel injection effects in a supersonic cavity flame-holder},
  journal = {Combustion and Flame},
  volume = {232},
  pages = {111531},
  year = {2021},
  issn = {0010-2180},
  doi = {https://doi.org/10.1016/j.combustflame.2021.111531},
  url = {https://www.sciencedirect.com/science/article/pii/S0010218021002741},
}

Acknowledgment

This research was supported by the Exascale Computing Project (ECP), Project Number: 17-SC-20-SC, a collaborative effort of two DOE organizations -- the Office of Science and the National Nuclear Security Administration -- responsible for the planning and preparation of a capable exascale ecosystem -- including software, applications, hardware, advanced system engineering, and early testbed platforms -- to support the nation's exascale computing imperative.