JunhuaPAN / EOF-Library

Efficient two-way coupling between Elmer and OpenFOAM

EOF-Library // https://EOF-Library.com //

Libraries for coupling Elmer and OpenFOAM + test cases. Currently used for solving coupled problems, e.g., electromagnetic induction heating and MHD with free surface, but users can use this library for coupling any Elmer and OpenFOAM solvers.

This software is maintained by the Laboratory for mathematical modelling of environmental and technological processes (University of Latvia) in cooperation with CSC - IT Center for Science Ltd. (Finland).

Requirements

• Both Elmer and OpenFOAM must use the same OpenMPI version!
• Tested on Ubuntu 14.04 and Ubuntu 16.04, but in theory it should work on all Linux distros.
• Provided test cases should work on OpenFOAM version 5.0, but might need some small modifications for other versions.

How to

There are two options to install and use this software:

1. Docker
2. Complete install

Performance-wise these two options are comparable, do not worry about it at this point. Docker installation takes existing OpenFOAM image from Docker Hub, then installs Elmer and EOF-Library. Since the user does not need to compile OpenFOAM, Docker installation process is quicker and more robust therefore it is preferred for users who want to get taste of EOF-Library. On the other hand complete installation gives users more flexibility and this is preferred option for advanced users who want to work with their own solvers or have full controm over software versions.

1. Docker

git clone https://github.com/jvencels/EOF-Library.git
cd EOF-Library
docker build --no-cache -t eof-library/full -f docker/Dockerfile-build .
docker run --rm -it -u $(id -u):$(id -g) -v ${PWD}:/home/openfoam/EOF-Library eof-library/full
cd EOF-Library
mkdir runs
cp -r tests/mhdInterFoamTest_2D runs
cp libs/Elmer2OpenFOAM/Elmer2OpenFOAM.F90 runs/mhdInterFoamTest_2D
cp libs/OpenFOAM2Elmer/OpenFOAM2Elmer.F90 runs/mhdInterFoamTest_2D
cd runs/mhdInterFoamTest_2D
elmerf90 -o Elmer2OpenFOAM.so Elmer2OpenFOAM.F90
elmerf90 -o OpenFOAM2Elmer.so OpenFOAM2Elmer.F90
. run.sh

2. Complete installation

• Get git, cmake, gfortran, blas and lapack.

sudo apt-get install git cmake gfortran libblas-dev liblapack-dev

• Download OpenFOAM 5.0 source code, configure and compile it (https://openfoam.org/download/5-0-source/)

• Download Elmer from developers repo (https://github.com/ElmerCSC/elmerfem).

• Configure and compile Elmer with -DWITH_MPI=TRUE by following these steps (https://www.csc.fi/web/elmer/sources-and-compilation). In short .., we create build folder and call CMake from this folder:

cmake -DWITH_MPI=TRUE -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../mpi-install ../elmerfem
make -j install

• Download EOF-Library:

git clone https://github.com/jvencels/EOF-Library

• Add this line to .bashrc

export LD_LIBRARY_PATH=$FOAM_USER_LIBBIN:$LD_LIBRARY_PATH

• Check the MPI implementation and version (it is important that Elmer and OpenFOAM was compiled with the same version!)

which mpirun
mpirun --version

• Compile libraries and solver

cd EOF-Library/libs/commSplit
wmake
cd ../coupleElmer
wmake
cd ../mhdInterFoam
wmake
cd ../Elmer2OpenFOAM
elmerf90 -o Elmer2OpenFOAM.so Elmer2OpenFOAM.F90
cd ../OpenFOAM2Elmer
elmerf90 -o OpenFOAM2Elmer.so OpenFOAM2Elmer.F90

• Copy test

cd ../..
mkdir runs
cd runs
cp -r ../tests/mhdInterFoamTest_2D .

• Prepare test

cd mhdInterFoamTest_2D
setFields
decomposePar
ElmerGrid 2 2 mesh_Elmer -metis 2

• Copy Elmer2OpenFOAM.so, Elmer2OpenFOAM.mod, OpenFOAM2Elmer.so and OpenFOAM2Elmer.mod to this folder

• Run OpenFOAM on 2 processes and Elmer on 2 processes

mpirun -np 2 mhdInterFoam -parallel : -np 2 ElmerSolver_mpi

• Postprocessing

reconstructPar
paraFoam