FAQ

  1. Why this library?
  1. The intention behind developing this library is to have a set of python components that can execute the preprocessing and solver stages of OpenFoam, such that they can be easily integrated with a 3D graphics package to develop a GUI for these stages. Thus one of the important design constraint is that library be GUI agnostic!
  1. Does this currently work with any 3D graphics package?

  1. Yes, currently there is a reference implementation for integrating with a 3D graphics package using Blender. There exists a Blender add-on, that uses this library to start openfoam, generate a blockMesh and run a solver.

    You can checkout this add on here. You can also run this Blender add-on with this Docker image on Ubuntu.

  1. What is the current state of this library?
  1. This library right now supports blockMesh and executing any solver which works with a mesh generated by blockMesh.
  1. What mesh generators does it support?
  1. Currently, blockMesh is supported. More, including snappyHexMesh will be added in upcoming versions.
  1. Is this cross-platform?

  1. Currently, it supports macOS and linux platforms. However the Docker image runs only on Linux (tested on Ubuntu) and can work with macOS if you can share the mac host X11. The Windows platform has not been tested.

    The final version will support all of Linux, macOS and Windows.

  1. Do I need to install openfoam4?
  1. Yes, you need to install openfoam4 for this library to work, it is a dependency. See Pre-requisites for installing openfoam4.