PeleC

A compressible AMR combustion code

PeleLM is an adaptive-mesh low Mach number hydrodynamics code for reacting flows.

Getting Started

To build PeleLM:

1. Set the environment variable, BOXLIB_HOME, and clone a copy of BoxLib there

   export BOXLIB_HOME=<location for BoxLib>
   git clone https://github.com/BoxLib-Codes/BoxLib.git ${BOXLIB_HOME}
   

2. Set the environment variable, IAMR_HOME, and clone a copy of IAMR there

   export IAMR_HOME=<location for IAMR>
   git clone git@code.ornl.gov:Pele/IAMR.git ${IAMR_HOME}
   

3. Set the environment variable, PELELM_HOME, and clone a copy of PeleLM there

   export PELELM_HOME=<location for PeleLM>
   git clone git@code.ornl.gov:Pele/PeleLM.git ${PELELM_HOME}
   

4. Move to an example build folder, build an executable

   cd ${PELEC_HOME}/Exec/FlameInABox
   make
   

Dependencies

PeleLM was created as a renamed, LMC, the low Mach code from CCSE (<https://ccse.lbl.gov/index.html>), and is built on the BoxLib library and the IAMR code (see above). BoxLib, the predecessor of AMReX is described at: <https://ccse.lbl.gov/BoxLib/index.html>.

Development model

To add a new feature to PeleLM, 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 merge development        [fix any identified conflicts between "development" and "AmazingNewFeature"]
   

3. Push feature branch to PeleC repository

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

4. Submit a merge request through code.ornl.gov - be sure you are requesting to merge your branch to the development branch.

Documentation

Documentation for PeleLM is under development in the Docs directory. To build

cd ${PELELM_DIR}/Docs/UsersGuide
make