Continuously evolving documentation in OpenFOAM®

Continuously evolving documentation in OpenFOAM®

We are pleased to announce a suite of new documentation for OpenFOAM available via the The OpenFOAM website, marking a significant commitment to its continued maintenance and development by its sponsors and ESI-OpenCFD, originator of OpenFOAM.

To experienced OpenFOAM users the code itself is the best source of documentation. However, many users are not confident in understanding C++ code and find navigating the code base particularly challenging.

The learning curve to become a proficient OpenFOAM user is often referred to as steep, typically exposing users to the world of linux and working within a terminal environment for the first time. This has been hindered by the lack of high quality, up-to-date documentation.

The OpenFOAM guides had seen little attention since OpenCFD first released OpenFOAM in 2004,until the release of OpenFOAM v3.0+ in 2015 when we refactored the material, e.g. leading to the release of a tutorial guide, and added more content, e.g. more complete summaries for applications, libraries and boundary conditions.

We provided an initial step to ease navigation through the code using Doxygen’s modules system in OpenFOAM-2.2.0 which we continued to develop in later releases, with the most significant update coming in the release of OpenFOAM v3.0+ where many new entry points and functionality groups were introduced.

Our latest efforts complement and extend the code documentation by adding more complete descriptions of the functionality, images and videos, leading to a more up-to-date and easy to navigate system.

Where to find it

The main entry point is the new OpenFOAM Guide which currently includes the sections:

Case structure

Applications

Physical modelling

Boundary conditions

Numerics

Post-processing

Additional examples

We will continue to evolve the material with the aim to provide greater code coverage and more detailed information, complete with references where appropriate. We are committed to keep the content up-to-date and welcome all feedback and suggestions for improvements.

Recent efforts have been made possible through sponsorship by AUDI and ESI-OpenCFD. Your continued support of the OpenFOAM project is encouraged— contact us to get involved.

For users wishing a more interactive learning experience, we provide training courses for all user levels to accelerate the learning journey and reduce the time taken to master OpenFOAM.

ESI-OpenCFD Ltd.

24 March 2017