Welcome to the documentation for PeleLM

PeleLM is an adaptive-mesh low Mach number hydrodynamics code for reacting flows. PeleLM has an official project homepage, and can be obtained via GitHub. If you need help or have questions, please join the users forum. The documentation pages appearing here are distributed with the code in the Docs folder as “restructured text” files. The html is built automatically with certain pushes to the PeleLM GibHub repository and are maintained online by ReadTheDocs. A local version can also be built as follows

cd ${PELELM_DIR}/Docs
make html

where PELELM_DIR is the location of your clone of the PeleLM repository. To view the local pages, point your web browser at the file ${PELELM_DIR}/Docs/build/html/index.html.

Current docs build status on ReadTheDocs:

Documentation contents:

• PeleLM Quickstart
  • Obtaining PeleLM
  • Building PeleLM
  • Running PeleLM
  • Visualization of the results
• The PeleLM Model
  • Overview of PeleLM
  • The low Mach number flow equations
  • The PeleLM temporal integration
• Setting up a new PeleLM Case
  • Initial Conditions
  • Boundary Conditions
  • Refinement Criteria
• Building with GNU Make
  • Dissecting a Simple Make File
  • Tweaking the Make System
  • Specifying your own compiler / GCC on macOS
• PeleLM control
  • Physical Units
  • Control parameters
• Visualization
  • Amrvis
  • VisIt
  • ParaView
  • yt
  • SENSEI
• Tutorials
  • Tutorial - Non-reacting flow past a cylinder
  • Tutorial - A simple triple flame

Indices and tables

• Index

• Search Page