2. Installation¶

2.1.1. Obtain a copy of the source code¶

In the CFDEMcoupling repository take a look at the file

src/lagrangian/cfdemParticle/cfdTools/versionInfo.H

to find out the latest tested version of LIGGGHTS and OpenFOAM that work with CFDEMcoupling. As of this writing the version of OpenFOAM to be used is 6.

You can then basically follow the instructions at openfoam.org, cloning OpenFOAM from the git repository.

cd $HOME
mkdir OpenFOAM
cd OpenFOAM
git clone https://github.com/OpenFOAM/OpenFOAM-6.git

Clone the corresponding third party packages to the OpenFOAM folder.

git clone https://github.com/OpenFOAM/ThirdParty-6.git

Switch to root user with sudo

sudo su -

Install dependent packages required for OpenFOAM on Ubuntu by executing the following commands:

apt-get install build-essential flex bison git-core cmake zlib1g-dev libboost-system-dev libboost-thread-dev libopenmpi-dev openmpi-bin gnuplot libreadline-dev libncurses-dev libxt-dev
apt-get install libqt5x11extras5-dev libxt-dev qt5-default qttools5-dev curl

apt-get install build-essential flex bison git-core cmake zlib1g-dev libboost-system-dev libboost-thread-dev libopenmpi-dev openmpi-bin gnuplot libreadline-dev libncurses-dev libxt-dev
apt-get install libqt5x11extras5-dev libxt-dev qttools5-dev qttools5-dev-tools qtwebengine5-dev libqt5svg5-dev libqt5websockets5-dev libqt5xmlpatterns5 qtxmlpatterns5-dev-tools curl

2.1.2. Setup the environment¶

Open your bash startup file

gedit ~/.bashrc

and add the following lines:

source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc
export WM_NCOMPPROCS=4

Save the file and reload it:

source ~/.bashrc

Additional check

Open ~/OpenFOAM/OpenFOAM-6/etc/bashrc and make sure that WM_MPLIB is set correctly:

export WM_MPLIB=SYSTEMOPENMPI

This should be the default setting but if you encounter some problems regarding MPI you might have to download the openmpi-1.10.2 source package to the third party folder and change the setting to OPENMPI

2.1.3. Compile ThirdParty packages¶

cd $WM_THIRD_PARTY_DIR
./Allwmake

Compiling Paraview and the Paraview Reader Module

Paraview is a third-party software provided for graphical post-processing in OpenFOAM. Its compilation is automated using a script called makeParaView in the ThirdParty-6 directory.

Before installing Paraview, check the version of cmake that is installed on the system. This can be done by typing

cmake --version

If the system cmake is older than version 2.8.8, clone a newer version to the Third Party folder and compile it by executing the following:

cd $WM_THIRD_PARTY_DIR
git clone https://github.com/Kitware/CMake.git cmake-3.2.1
cd cmake-3.2.1
git checkout tags/v3.2.1
cd ..
./makeCmake

In makeParaView set the path to cmake:

CMAKE_PATH="$WM_THIRD_PARTY_DIR/platforms/linux64Gcc/cmake-3.2.1/bin"

To install Paraview, execute the following

cd $WM_THIRD_PARTY_DIR
./makeParaView

If you get the following error

VTK/ThirdParty/hdf5/vtkhdf5/src/H5detect.c:158:1: error: unknown type name ‘sigjmp_buf’
static H5JMP_BUF jbuf_g;

in VTK/ThirdParty/hdf5/vtkhdf5/config/cmake/ConfigureChecks.cmake around line 445 change

set (HDF5_EXTRA_FLAGS -D_DEFAULT_SOURCE -D_BSD_SOURCE)

to

set (HDF5_EXTRA_FLAGS -D_GNU_SOURCE -D_DEFAULT_SOURCE -D_BSD_SOURCE)

2.1.4. Compile OpenFOAM¶

Compiling the source code

cd $WM_PROJECT_DIR
./Allwmake

Testing the installation

Create a project directory within the $HOME/OpenFOAM directory

mkdir -p $FOAM_RUN

Copy the tutorial examples directory in the OpenFOAM distribution to the run directory. If the OpenFOAM environment variables are set correctly, then the following command will be correct:

cp -r $FOAM_TUTORIALS $FOAM_RUN

Run the first example case of incompressible laminar flow in a cavity:

cd $FOAM_RUN/tutorials/incompressible/icoFoam/cavity/cavity
blockMesh
icoFoam
paraFoam