Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
grid

GitHub Action

Setup OpenFOAM

v1.2.21

Setup OpenFOAM

grid

Setup OpenFOAM

Set up a specific version of OpenFOAM

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Setup OpenFOAM

uses: gerlero/[email protected]

Learn more about this action in gerlero/setup-openfoam

Choose a version

setup-openfoam

CI Release OpenFOAM

Installs and activates a specific version of OpenFOAM in the GitHub Actions environment.

Usage

steps:
- uses: actions/checkout@v4
- uses: gerlero/setup-openfoam@v1
  with:
    openfoam-version: 2406
- run: blockMesh
- run: icoFoam

Inputs

openfoam-version

Required. OpenFOAM version number (read below for the available versions).

cache

Whether to cache the OpenFOAM installation between runs. Default: true.

Available OpenFOAM versions by runner OS

  • ubuntu-24.04: 2406, 2312 (openfoam.com), 12, 11 (openfoam.org)

  • ubuntu-22.04: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com), 12, 11, 10, 9 (openfoam.org)

  • ubuntu-20.04: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com), 12, 11, 10, 9, 8, 7 (openfoam.org)

  • macos-15, macos-14, macos-13, macos-12: 2406, 2312, 2306, 2212, 2206, 2112 (via OpenFOAM.app)

  • Docker container based on:

    • ubuntu:24.04: 2406, 2312 (openfoam.com), 12, 11 (openfoam.org)

    • ubuntu:22.04: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com), 12, 11, 10, 9 (openfoam.org)

    • ubuntu:20.04: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com), 12, 11, 10, 9, 8, 7 (openfoam.org)

    • debian:bookworm: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2006 (openfoam.com)

    • debian:bullseye: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com)

  • Windows: not supported