https://github.com/jakobhaervig/openfoam-dockerfiles

This repo explains how to work with OpenFOAM through Docker. This ensures a consistent working environment across different operating systems such as Windows, macOS and Linux, which is convenient when working in groups.
https://github.com/jakobhaervig/openfoam-dockerfiles

computational-fluid-dynamics containers docker openfoam

Last synced: 3 months ago
JSON representation

This repo explains how to work with OpenFOAM through Docker. This ensures a consistent working environment across different operating systems such as Windows, macOS and Linux, which is convenient when working in groups.

• Host: GitHub
• URL: https://github.com/jakobhaervig/openfoam-dockerfiles
• Owner: jakobhaervig
• Created: 2020-11-29T13:08:27.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-09T16:59:24.000Z (about 2 years ago)
• Last Synced: 2025-02-27T13:19:07.151Z (over 1 year ago)
• Topics: computational-fluid-dynamics, containers, docker, openfoam
• Language: Dockerfile
• Homepage:
• Size: 198 KB
• Stars: 26
• Watchers: 2
• Forks: 15
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# OpenFOAM Dockerfiles

This repository contains OpenFOAM Dockerfiles. Both openfoam.com and openfoam.org releases are included. Both are based on a recent Ubuntu image.

### What is Docker and why?

Docker is a set of tools to manage, build and run various software installations with a number of advantages. Using Docker we start containers (think of shipping containers) from images. Containers include everything needed to run a particular set of tasks (in this case OpenFOAM simulations). As containers are standardised, you can be confident that they run the same way on Windows, macOS and Linux. And yes, they are future proof and run similarly on major cloud solutions such as Amazon Web Services (AWS) and Microsoft Azure. This is convenient (!) because we can copy our setup to a cloud solution or a friend’s computer and still be confident it runs the same way.

### Docker containers, Docker images and Dockerfiles

Instead of shipping the complete container including the operating system, it’s more convenient to use what we call Dockerfiles. Think of Dockerfiles as recipes (simply just text file with set of commands) that outlines how to build an image. A container may then be started from the Docker image

### Contributing to this project

Feel free to fork these Docker files. If you make an improvement you are most welcome to make a pull request and you will be added to the author list. Comments are also welcome.

# Setup

This guide explains how to setup OpenFOAM with Docker. It contains both OpenFOAM fundation releases (from openfoam.org) and OpenFOAM ESI releases (from openfoam.com).

## 1. Prerequisites

*1a)* Install [Docker](https://www.docker.com/products/docker-desktop)

Windows only: You will be prompted to install WSL (Windows Subsystem for Linux) when installing Docker (in the instructions

please follow step 4 and 5).

*1b)* Install [Git](https://git-scm.com/downloads) for your operating system (Windows, macOS or Linux)

*1c)* Install the latest [Paraview](https://www.paraview.org/download/) version. If you have trouble getting the MPI version (parallel) to work, please choose the non-MPI version.

Windows only: Choose the .exe or .msi file

macOS: Choose the .pkg file

Linux: Choose the .tar.gz archieve and extract it

## 2. Preparing for OpenFOAM

*2a)* Decide on a OpenFOAM version to install. List available versions by folder names in this repository. Following the steps in guide will give you the latest ESI release of OpenFOAM. Replace ```esi``` with ```foundation``` to install the latest foundation release (e.g. 7, 8, 9)

*2b)* Open a Powershell (Windows) or a terminal (macOS or Linux) and run the following commands. First, make a folder to store your OpenFOAM data:

```shell

mkdir $HOME/openfoam-data

```

*2c)* Next, clone this repository by:

```shell

git clone https://github.com/jakobhaervig/openfoam-dockerfiles.git $HOME/openfoam-dockerfiles

```

You should now have two folder ```openfoam-data``` and ```openfoam-dockerfiles``` in your home folder.

*2d)* Now, start the program called Docker Desktop to start the Docker engine.

*2e)* Build the OpenFOAM image:

```shell

docker image build --no-cache -t openfoam $HOME/openfoam-dockerfiles/esi/latest/

```

## 3. Run the Docker container

*3a)* Finally, start a Docker container with ``/data`` mapped to ``$HOME/openfoam-data``:

```shell

docker container run -ti --rm -v $HOME/openfoam-data:/data -w /data openfoam:latest

```

Note: All files stored in the container are deleted when you exit the container. Therefore you should save your simulation results and solver development in ``/data``, which is the only directory that persists when the container is closed.

Running the above command should leave you inside the Docker container with the username ```foam```. 

## 4. Accessing files in the Docker container

You may access the container through ``$HOME/openfoam-data`` e.g.:

On a Windows system: ``C:\Users\jakob\openfoam-data``

On a macOS system: ``/Users/jakob/openfoam-data``

On most Linux systems: ``/home/jakob/openfoam-data``

## 5. Optional: Save an alias for running the Docker container

Instead of starting a Docker container with the command in [3. Run the Docker container](#3-run-the-docker-container), we can save an alias for that command. With an alias saved we can simply type ```of``` (short for OpenFOAM) in a Powershell (Windows) or a terminal (macOS or Linux) to start the Docker container.

### **Windows operating system**

*5a)* Open a Powershell with *Administrator Rights* and enter the follwing commands (copy/paste the code from each step into the Power Shell (use GitHub's copy buttom) and hit enter).

*5b)* Allow scripts to be run (Hit *A* for Yes to All):

```shell

Set-ExecutionPolicy RemoteSigned

```

*5c)* Create a ```profile``` file to store our alias function:

```shell

New-Item -Path $profile -ItemType file -force

```

*5d)* Add the alias to the newly created file:

```shell

echo "function openfoam-docker-latest {docker container run -ti --rm -v $HOME/openfoam-data:/data -w /data openfoam:latest} Set-Alias of openfoam-docker-latest" > $profile

```

We can now start the container using the newly created ```of``` alias by typing ```of``` in the Power Shell.

### **macOS and Linux systems**

*5a)* 

Copy/paste the following code snippet in the terminal:

```shell

case "$OSTYPE" in

  linux*)   echo "alias of='docker container run -ti --rm -v $HOME/openfoam-data:/data -w /data openfoam:latest'" >> $HOME/.bashrc ;;

  darwin*)  echo "alias of='docker container run -ti --rm -v $HOME/openfoam-data:/data -w /data openfoam:latest'" >> $HOME/.zprofile ;;

  *)        echo "This function is not yet added for $OSTYPE" ;;

esac

```

After opening a new terminal, we can now start the container using the newly created ```of``` alias by typing ```of``` in the Power Shell.

## 6. Install extensions

If you need to add extensions to your image, you may extend it by following the steps below. 

*6a)* To extend our Docker image to include a Python installation with different useful packages:

```shell

docker image build -t openfoam $HOME/openfoam-dockerfiles/extensions/python

```

*6b)* To extend our Docker image to include a FreeCad installation:

```shell

docker image build -t openfoam $HOME/openfoam-dockerfiles/extensions/freecad

```