Sandals

Sandals is a library for the numerical integration of Ordinary Differential Equations (ODEs) and Differential Algebraic Equations (DAEs) written in C++17.

Installation

Quick and dirty

Sandals is a header-only library that depends only on Eigen (version >= 3.4.0), so the quick and dirty way of installing it is by simply copying the include directory to your project and make sure to have Eigen available however you see fit. Alternatively, you can do things properly and use CMake (version >= 3.14).

You also need to install Optimist to use root-finding algorithms. But don't worry, it is already fetched by CMake if you use it.

Optionally, you can also install Matplot++ (version >= 1.2.0) to plot the results of your simulations.

CMake

If you are using CMake, you can add the library as a subdirectory in your project.

add_subdirectory(path/to/Sandals)
target_link_libraries(your_target PRIVATE Sandals::Sandals)

You can use FetchContent to download the library from GitHub.

include(FetchContent)
 
# Optionally specify a custom path to fetch content to
set(FETCHCONTENT_BASE_DIR "path/to/your/dependencies")
fetchcontent_declare(
  Sandals
  GIT_REPOSITORY https://github.com/StoccoDavide/Sandals.git
  GIT_TAG        main
)
fetchcontent_makeavailable(Sandals)
target_link_libraries(your_target PRIVATE Sandals::Sandals)

If you already have Sandals somewhere on your system, you can use find_pacakge directly.

# Optionally specify a custom path to find content from
list(APPEND CMAKE_PREFIX_PATH "path/to/your/dependencies")
find_package(
  Sandals
  ${YOUR_DESIRED_SANDALS_VERSION}
  NO_MODULE
)
 
target_link_libraries(your_target PRIVATE Sandals::Sandals)

Since we are nice people, we also show you how to conditionally use FetchContent based if you already have the library or not.

# Optionally specify a custom path to find content from
list(APPEND CMAKE_PREFIX_PATH "path/to/your/dependencies")
find_package(
  Sandals
  ${YOUR_DESIRED_SANDALS_VERSION}
  NO_MODULE
)
 
if(NOT TARGET Sandals::Sandals)
  include(FetchContent)
 
  # Optionally specify a custom path to fetch content to
  set(FETCHCONTENT_BASE_DIR "path/to/your/dependencies")
  fetchcontent_declare(
    Sandals
    GIT_REPOSITORY https://github.com/StoccoDavide/Sandals.git
    GIT_TAG        main
  )
 
  fetchcontent_makeavailable(Sandals)
endif()
 
target_link_libraries(your_target PRIVATE Sandals::Sandals)

Authors

• Davide Stocco
  University of Trento
  Department of Industrial Engineering
  email: david.nosp@m.e.st.nosp@m.occo@.nosp@m.unit.nosp@m.n.it
• Enrico Bertolazzi
  University of Trento
  Department of Industrial Engineering
  email: enric.nosp@m.o.be.nosp@m.rtola.nosp@m.zzi@.nosp@m.unitn.nosp@m..it

Aka...

▗▄▄▄  ▄   ▄  ▐▌    ▗▞▀▜▌▄▄▄▄     ▐▌    ▗▄▄▖ ▗▞▀▚▖ ▄▄▄ ▄   ▄
▐▌  █ █   █  ▐▌    ▝▚▄▟▌█   █    ▐▌    ▐▌ ▐▌▐▛▀▀▘█    █   █
▐▌  █  ▀▄▀▗▞▀▜▌         █   █ ▗▞▀▜▌    ▐▛▀▚▖▝▚▄▄▖█     ▀▀▀█
▐▙▄▄▀     ▝▚▄▟▌               ▝▚▄▟▌    ▐▙▄▞▘          ▄   █
                                                       ▀▀▀

License

The Sandals project is distributed under the BSD 2-Clause License - see the LICENSE file for details.

Here's what the license entails:

1. Anyone can copy, modify and distribute this software.
2. You have to include the license and copyright notice with each and every distribution.
3. You can use this software privately.
4. You can use this software for commercial purposes.
5. This software is provided without warranty.
6. The software author or license can not be held liable for any damages inflicted by the software.

Acknowledgements

The name Sandals has been suggested by Mattia Piazza as a poor imitation of the Lawrence Livermore National Laboratory's (LLNL) Sundials (SUite of Nonlinear and DIfferential/ALgebraic Equation Solvers).