Cerisse

A high-order adaptive mesh refinement solver for Large Eddy Simulation of compressible turbulent reactive flows

Created by:

Enson Un

Salvador Navarro-Martinez

Getting the code

  1. Clone the repository with all submodules bash git clone --recursive git@github.com:salvadornm/cerisse.git
  2. Or clone the bare repository (and install Submodules later) bash git clone git@github.com:salvadornm/cerisse.git
  3. Or download latest release from comand line bash wget https://github.com/cerisse/archive/refs/tags/v01.zip
  4. Or download a release from here

Folder layout

EB_CNS/         # main code
├───Examples/      # simple example cases
├───Exec/          # more advanced test cases
├───Source/        # source code
└───Tools/         # useful tools
Submodules/     # required modules
├───amrex/         # AMR data structure, backends
├───PelePhysics    # EoS, transport, reaction
└───sundials/      # chemical integrators
docs/           # documentation folder

Pre-requisites

  1. C++ compiler A compiler with C++17 standard is required. Examples include gcc > 8, clang >7 and more

  2. GNU Makefile It will usually be installed by default in most systems (Mac OS/Linux)

  3. MPI libraries (optional) required for parallel simulations. Similarly CUDA/OPenMPI may be required for more advanced parallelization strategies.

  4. cmake (optional) required for some installation options (mostly related to GPU and chemistry). Easy to install, version required >3.2

  5. AMReX AMR libraries AMREX It will be installed if not present. Check Quickrun for installation within Cerisse (recommended)

  6. PelePhysics Based on PeleC It will be installed if not present. Check Quickrun for installation within Cerisse (recommended)

  7. Visualization Cerisse/AMREx/PeleC format is supported by VisIt, Paraview, yt (allows Python) and check for more options AMReX Visualization

Installation

Download the latest version on the master branch using GitHub CLI

$ gh repo clone salvadornm/cerisse

or Download the latest release from GitHub

Documentation Editing

For help editing the documentation visit mkdocs.org. To generate the docs locally type in the parent directory: mkdocs serve and point the browser to 127.0.0.1.8000

You will need to install the python-markdown-math extension for rendering equations and the markdown-callouts extension for correctly displaying the warning and note blocks. All requirements can be installed automatically using

$ pip install -r docs/requirements.txt

You may need to install

$ pip install pip-tools

if you add new markdown extensions, edit the requirements.in file under docs/

$ pip-compile requirements.in