.. libWallModelledLES documentation master file, created by
   sphinx-quickstart on Thu Aug  1 15:40:10 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

libWMLES: An OpenFOAM\ :sup:`®` Library for Wall-Modelled Large-Eddy Simulation
===============================================================================

The libWallModelledLES library, or libWMLES for short, enhances OpenFOAM with
state-of-the-art wall modelling capability. This documentation portal provides a
brief guide to WMLES and detailed instructions on how to install and use the
library.

If you use the library, please cite the following publication:
`DOI 10.1016/j.cpc.2019.01.016 <https://doi.org/10.1016/j.cpc.2019.01.016>`_

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   install
   quickstart
   wallmodelling
   grid_construction
   configuration
   sampling
   troubleshooting
   zzreferences
   api/library_root


.. important::

   This offering is not approved or endorsed by OpenCFD Limited, producer and
   distributor of the OpenFOAM software and owner of the OPENFOAM\ :sup:`®` and
   OpenCFD\ :sup:`®`  trade marks.