forensicFoam

OpenFOAM code to model atmospherics, buoyant flows concerned with small/medium scale pollutant dispersion.

THIS IS A WORK IN PROGRESS .....

DO NOT USE IT YET

June 2024

SNM

Installation

Download the latest version on the master branch using GitHub CLI

$ gh repo clone salvadornm/forensicFoam

or Download the latest release from GitHub

The code has been tested in OpenFoam10, check OpenFOAM to have a summary.

Visualization

Paraview, this will be installed by default if OpenFOAM is downloaded and installed. Is the option used in most OpenfFOAM tutorials. It can be invoked by typing paraFoam in the command line inside the directory to see the results.

VisIt To see the results, open the system/controlDict file in the folder to see. The number of options in Visit is less than Paraview (for example only scalars are opened) but is often simpler.

Documentation Editing

For help editing the documentation visit mkdocs.org. To generate the docs locally 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

$ pip-compile requirements.in