hippo

Moose app that wraps OpenFOAM buoyantFoam solver.

Install/Build

Note: Only tested with GCC.

OpenFOAM

Unfortunately hippo relies on patching OpenFOAM, there is a script scripts/install-openfoam.sh that will clone OpenFOAM-10, apply the patch, and build it.

First install the build dependencies:

apt install \
    bison \
    flex \
    libptscotch-dev \
    libqt5opengl5-dev \
    libqt5x11extras5-dev \
    libxt-dev \
    make \
    paraview \
    paraview-dev \
    qtbase5-dev \
    qttools5-dev \
    qttools5-dev-tools

Then run the script (use flag -h for help, this will take ~1 hour):

bash ./scripts/install-openfoam.sh

To set the OpenFOAM build options (e.g., Opt or Debug mode), copy scripts/openfoam-prefs.sh to ~/.OpenFOAM/prefs.sh, and update the environment variables within. The variables will be loaded when <path/to/OpenFOAM>/etc/bashrc is sourced (which is done automatically by the install script).

Moose

Follow instructions here to build MOOSE.

Environment

Set (recommend direnv for this)

MOOSE_DIR=/path/to/moose/dir
MPI_ROOT=/path/to/mpich/root
MPI_ARCH_INC="-I/path/to/mpi/includes"
MPI_ARCH_LIBS="-L/path/to/mpi/libs -lmpi"
source /path/to/OpenFOAM/etc/bashrc

Build

Once the dependencies are built, then (in theory) you should be able to make in the root directory:

make

Or, for a debug build:

METHOD=dbg make

Tests

Some basic tests can be run with ./run_tests.

Note that you must have installed the fluidfoam Python package:

pip install "fluidfoam>=0.2.4"

Quality

Some code quality checks are set up with pre-commit.

Install the pre-commit hooks to run on each new commit:

pre-commit install

Run the hooks manually:

pre-commit run --all

To bypass the pre-commit checks, use the --no-verify (or -n) flag:

git commit --no-verify

Notes

This is a work in progress. So far hippo can:

• Create a moose mesh from the boundary of an openfoam mesh
• Can run an buoyantFOAM case via moose
• Transfer temperature from faces of openfoam mesh to nodes of Moose mesh

Note: When running in parallel add --keep-cout to the command line because OpenFOAM will crash if a process fails to write to stdout

"Fork hippo" to create a new MOOSE-based application.

For more information see: http://mooseframework.org/create-an-app/