fl0w : C++ Flows

A C++ library providing a few typical flow descriptions and an interface to the Johns Hopkins Turbulence Database.

This C++ library provides a few typical flow descriptions and a networking interface to the Johns Hopkins Turbulence Database. This flow descriptions are meant to be used as part of particle traking simulations. 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++14 compliant compiler, such as gcc v9 or higher must be installed. For Ubuntu users: ppa.

Examples:

• Eigen must be installed

The examples assume the following directory tree structure:

..
 ├── .
 │   └── fl0w
 └── thirdparty
     └── eigen

One should either install Eigen accordingly, or adapt its path in the CMakeList.txt file of the examples.

Installing

Start by cloning this repository.

$ git clone --recursive https://github.com/C0PEP0D/fl0w.git

Examples

Running an example:

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

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.