Skip to content

C0PEP0D/sl0

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sl0 : Simple C++ Lagrangian Objects

standard-readme compliant

A simple C++ library that helps advecting various lagrangian objects into a flow.

This simple C++ library provides passive lagrangian objects that are able to be advected in a flow. Simple examples are provided and should be enough to explain how to use this library.

Note that a similar library providing active lagrangian objects advection is available: sa0

This repository contains:

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

This library currently supports the following objects:

  • passive point particles
  • spheroids
  • groups of such particles
  • chains

Table of Contents

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

The dependencies are standard softwares that may already be installed on your system. If not, you should be able to install these dependencies with your package manager.

Examples:

  • Eigen must be installed
  • s0s must be installed

Chain example:

  • m0sh must be installed
  • p0l must be installed

The examples assume the following directory tree structure:

..
 ├── .
 │   │── sl0
 │   │── s0s
 │   │── (m0sh)
 │   └── (p0l)
 └── 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/sl0.git

Examples

Running an example:

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

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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published