leia

The "leia" project is an OpenFOAM module that implements unstructured Lagrangian / Eulerian Interface Approximation (LEIA) methods for multiphase flow simulations in complex geometries. This currently includes an unstructured Finite Volume Level Set Method for advecting interfaces and for simulating two-phase flows.

Author

* Tomislav Maric ORCID * Julian Reizel ORCID

Publications

License

This project is licensed under the GPL3.0 License - see the LICENSE.md file for details.

Documentation

A doxygen-generated documentation can be found here.

Installation

These instructions will get your copy of the project up and running on your local machine for development and testing purposes.

leia is a project that builds on OpenFOAM so it compiles and links against OpenFOAM libraries.

Compilation & Installation dependencies

A C++ compiler that supports the C++17 standard. Tested with

* g++ (GCC) 11.2.0 * g++ (GCC) 10.3.0

Computing dependencies

Meshing

* cfmesh, available as OpenFOAM sub-module, used for automatic generation of unstructured volume meshes

OpenFOAM-v2206

To install OpenFOAM follow the instructions on installing OpenFOAM from sources.

1. Check out openfoam using git. 2. Check out the git tag and build

?> git checkout OpenFOAM-v2206
?> ./Allwmake

Compilation

Once OpenFOAM is installed, run

leia> ./Allwmake  

How to setup and run example cases

The template cases used for advection verification are located in cases/.

Serial execution

case> ./Allrun_hex_serial.sh

Parallel execution

Create the mesh and initialize the fields with

case> ./Allrun_hex_parallel.sh

Level Set Advection

The velocity field for an alternative advection case can be set in 3Ddeformation/system/fvSolution

velocityModel
{
    type deformation3D; 
    oscillation on;
}

Enter test ater type to get a list of available velocity models. Initial interface shape is also set in 3Ddeformation/system/fvSolution

levelSet
{
    implicitSurface 
    {
        type implicitSphere; 
        center (0.35 0.35 0.35); 
        radius 0.15;
    }
 
    ...

Enter test after type to get a list of available types and their parameters.

Parameter studies

To run parameter studies, we use the pyFoamStudy submodule, which is a pip-installable package of scripts built on top of pyFoam.

Postprocessing and visualization

Currently, pyFoamStudy also includes scripts to agglomerate a study's postprocessing data into a CSV database and a script to visualize the CSV database.

Contributing

Fork the project and submit a merge request.