fl0p : C++ Interpolated flow

A C++ library that provides flow field interpolation of stored data.

This C++ library provides a continuous flow implementation that interpolates fixed position data. Simple examples are provided and should be enough to explain how to use this library.

This repository contains:

1. The software itself provided as a header only library in the directory include/sl0
2. A few examples.

Table of Contents

• Background
• Install
• License

Background

This library has been produced during my PhD thesis and as part as the European Research Council project: C0PEP0D This library is used as part of SHELD0N, a lagrangian particle advection software.

Install

Dependencies

• CMake v? or higher must be installed
• a c++17 compliant compiler, such as gcc v9 or higher must be installed. For Ubuntu users: ppa.
• the Threading Building Block Library v2018 or higher must be installed (this version that enables is installing it using CMake is advised)

Examples:

• Eigen must be installed
• fl0w must be installed
• m0sh must be installed

Vtk example:

• v0l must be installed

The examples assume the following directory tree structure:

..
 ├── .
 │   │── fl0p
 │   │── fl0w
 │   │── m0sh
 │   └── (v0l)
 └── thirdparty
     └── eigen

One should either install these dependencies accordingly, or adapt their path in the CMakeList.txt file of the examples.

Installing

Start by cloning this repository.

$ git clone https://github.com/C0PEP0D/fl0p.git

Examples

Running an example:

$ cd examples/stationary
$ mkdir build
$ cd build
$ cmake ..
$ make
$ ./stationary

Updating

A simple pull should be enough.

$ git pull

Maintainers

Rémi Monthiller - @rmonthil - remi.monthiller@gmail.com

Contributing

Feel free to dive in! Open an issue or submit PRs.

License

MIT © Centrale Marseille, Rémi MONTHILLER.