Skip to content

OpenFOAM

OpenFOAM is a free, open source CFD software package.

Introduction

OpenFOAM is a free, open source CFD software package developed by OpenCFD Ltd at ESI Group and distributed by the OpenFOAM Foundation. It has a large user base across most areas of engineering and science from both commercial and academic organizations.

Installed Version

Currently, several versions are available compiled by GCC/ICC compilers in single/double precision with several versions of OpenMPI.

The naming convention of the installed versions is:

openfoam/<VERSION>-<COMPILER>-<openmpiVERSION>-<PRECISION>

  • VERSION - version of openfoam
  • COMPILER - version of used compiler
  • openmpiVERSION - version of used openmpi/impi
  • PRECISION - DP/SP – double/single precision

Example of the available OpenFOAM modules syntax is openfoam/2.2.1-icc-openmpi1.6.5-DP

This means OpenFOAM version 2.2.1 compiled by the ICC compiler with openmpi1.6.5 in double precision.

Available OpenFOAM Modules

To check the available modules, use:

$ ml av

In /opt/modules/modulefiles/engineering, you can see the installed engineering softwares:

    ------------------------------------ /opt/modules/modulefiles/engineering -------------------------------------------------------------
    ansys/14.5.x               matlab/R2013a-COM                                openfoam/2.2.1-icc-impi4.1.1.036-DP
    comsol/43b-COM             matlab/R2013a-EDU                                openfoam/2.2.1-icc-openmpi1.6.5-DP
    comsol/43b-EDU             openfoam/2.2.1-gcc481-openmpi1.6.5-DP            paraview/4.0.1-gcc481-bullxmpi1.2.4.1-osmesa10.0
    lsdyna/7.x.x               openfoam/2.2.1-gcc481-openmpi1.6.5-SP

For information on how to use modules, look here.

Getting Started

To create OpenFOAM environment, use the commands:

$ ml openfoam
$ source $FOAM_BASHRC

Note

Load the correct module with your requirements “compiler - GCC/ICC, precision - DP/SP”.

Create a project directory within the $HOME/OpenFOAM directory named <USER>-<OFversion> and create a directory named run within it:

$ mkdir -p $FOAM_RUN

The project directory is now available by typing:

$ cd /home/<USER>/OpenFOAM/<USER>-<OFversion>/run

<OFversion> - for example 2.2.1

or

$ cd $FOAM_RUN

Copy the tutorial examples directory in the OpenFOAM distribution to the run directory:

$ cp -r $FOAM_TUTORIALS $FOAM_RUN

Now you can run the first case, for example incompressible laminar flow in a cavity.

Running Serial Applications

Create a test.sh Bash script:

#!/bin/bash

ml openfoam/2.2.1-icc-openmpi1.6.5-DP
source $FOAM_BASHRC

# source to run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions

cd $FOAM_RUN/tutorials/incompressible/icoFoam/cavity

runApplication blockMesh
runApplication icoFoam

Job submission (example for Karolina):

$ sbatch -A PROJECT_ID -p qcpu --nodes=1 --ntasks=128 --time=03:00:00 test.sh

For information about job submission, look here.

Running Applications in Parallel

Run the second case, for example external incompressible turbulent flow - case - motorBike.

First we must run the serial application bockMesh and decomposePar for preparation of parallel computation.

Note

Create a test.sh Bash scrip:

#!/bin/bash

ml openfoam/2.2.1-icc-openmpi1.6.5-DP
source $FOAM_BASHRC

# source to run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions

cd $FOAM_RUN/tutorials/incompressible/simpleFoam/motorBike

runApplication blockMesh
runApplication decomposePar

Job submission

$ sbatch -A PROJECT_ID -p qcpu --nodes=1 --ntasks=16 --time=03:00:00 test.sh

This job creates a simple block mesh and domain decomposition. Check your decomposition and submit parallel computation:

Note

Create a testParallel.slurm script:

#!/bin/bash
#SBATCH --job-name=motorBike
#SBATCH --nodes=2
#SBATCH --ntasks-per-node=16
#SBATCH --time=01:00:00
#SBATCH --partition=qcpu
#SBATCH --account=ACCOUNT_ID

ml openfoam/2.2.1-icc-openmpi1.6.5-DP
source $FOAM_BASHRC

cd $FOAM_RUN/tutorials/incompressible/simpleFoam/motorBike

nproc = 32

mpirun -hostfile ${$SLURM_JOB_NODELIST} -np $nproc snappyHexMesh -overwrite -parallel | tee snappyHexMesh.log

mpirun -hostfile ${$SLURM_JOB_NODELIST} -np $nproc potentialFoam -noFunctionObject-writep -parallel | tee potentialFoam.log

mpirun -hostfile ${$SLURM_JOB_NODELIST} -np $nproc simpleFoam -parallel | tee simpleFoam.log

nproc – the number of subdomains

Job submission

$ srun testParallel.slurm

Compile Your Own Solver

Initialize the OpenFOAM environment before compiling your solver:

$ ml openfoam/2.2.1-icc-openmpi1.6.5-DP
$ source $FOAM_BASHRC
$ cd $FOAM_RUN/

Create the applications/solvers directory in the user directory:

$ mkdir -p applications/solvers
$ cd applications/solvers

Copy icoFoam solver’s source files:

$ cp -r $FOAM_SOLVERS/incompressible/icoFoam/My_icoFoam
$ cd My_icoFoam

Rename icoFoam.C to My_icoFOAM.C:

$ mv icoFoam.C My_icoFoam.C

Edit the files file in the Make directory:

    icoFoam.C
    EXE = $(FOAM_APPBIN)/icoFoam

and change to:

    My_icoFoam.C
    EXE = $(FOAM_USER_APPBIN)/My_icoFoam

In the My_icoFoam directory, use the compilation command:

$ wmake