Installation

---

Dependencies

CaptureFOAM is built upon OpenFOAM, a free open-source computational fluid dynamics software. CaptureFOAM is currently compatible with OpenFOAM v12, which will need to be compiled and sourced prior to beginning the CaptureFOAM installation process. Installation instructions for OpenFOAM can be found here.

---

Compiling CaptureFOAM

Once OpenFOAM v12 is built, CaptureFOAM is ready to be downloaded and compiled via the following steps:

1. Clone CaptureFOAM from the repository to your OpenFOAM project directory WM_PROJECT_USER_DIR:

   cd $WM_PROJECT_USER_DIR
   git clone https://github.com/ORNL/AdditiveFOAM.git
   

2. Build the CaptureFOAM libraries:

   cd $WM_PROJECT_USER_DIR/CaptureFOAM
   ./Allwmake
   

If the Allwmake script completes without errors, CaptureFOAM is ready to use.