aartiukh / sph-sdk

C++ implementation of Smoothed Particle Hydrodynamics

sph

C++ implementation of Smoothed Particle Hydrodynamics.

How to build

Ubuntu

• sudo apt-get install libxtst-dev libxrandr-dev libxxf86vm-dev
• cd build
• cmake -DBUILD_UNIT_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
• make -j

Windows MSVC 2017

• cd build
• cmake -G "Visual Studio 15 2017 Win64" -DBUILD_UNIT_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
• Open generated sph-sdk.sln and run Build Solution in MSVC 2017 IDE

Windows MSVC 2019

• cd build
• cmake -G "Visual Studio 16 2019" -A x64 -DBUILD_UNIT_TESTS=ON -DCMAKE_BUILD_TYPE=Release ..
• Open generated sph-sdk.sln and run Build Solution in MSVC 2019 IDE

How to test

• ctest -VV

Contributors

This project is maintained by teachers and students of Kharkiv National University of Radio Electronics (NURE), Department of Applied Mathematics (AM).

Thanks goes to these wonderful people (emoji key):

Anton Artiukh 💻 📖 👀

Oleksii Shabalin 💻 📖

Igor Lytvyn 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

sph-sdk's Issues

Setup mergeable app for PRs

Is your feature request related to a problem? Please describe.
Prevent merging PRs without description or with inappropriate title.

Describe the solution you'd like
Create a file with configs and put it into the repo
https://github.com/mergeability/mergeable
https://github.com/mergeability/mergeable#configuration

Use GLFW instead of FreeGlut

FreeGlut is very outdated. It is desired to use the FW that's still supported.
https://github.com/glfw/glfw

TODO:

• Add glfw as Git sub module
• Rewrite code
• Remove freeglut sub module
• Remove sph/thirdparty/freeglut-MSVC-3.0.0-2.mp.zip

Verify Windows MSVC 2017 build

• Check if Windows build passes on maximum warning level. If no, fix all warnings and the build itself
• Update README with How to build on Windows

Increase code coverage in algorithms

Describe the bug
The code coverage can be increased by adding new unit tests.

Expected behavior
Code coverage should be ~100%.

Additional context
Find coverage report here
https://codecov.io/gh/aartiukh/sph

Contributors list

Is your feature request related to a problem? Please describe.
Add contributors list

Describe the solution you'd like
Use all-contributors app

Additional context
https://github.com/all-contributors/all-contributors

Build freeglut instead of expecting to be installed in system

https://github.com/dcnieho/FreeGLUT

• Add ExternalProject CMake build
• Verify on Linux

Add clang-format file with code style rules

• Add .clang-format file
• Apply those rules to all src files
• Find how to check the automatically with Travis CI

Show FPS in the demo

Is your feature request related to a problem? Please describe.
As a user I want to see the current FPS.

Describe the solution you'd like
FPS number should be placed somewhere in the black area so it won't overlap the demo itself.

Describe alternatives you've considered
None.

Additional context
None.

Get rid of include directories and move all code to `src`

Fix bug in neighbours search algorithm

Describe the bug
There is a bug in neighbours search algorithm that causes test failure (SEGFAULT) in Github Actions:

2: [----------] 19 tests from ForcesTestSuite
2: [ RUN      ] ForcesTestSuite.densityForFourNeighbours
Errors while running CTest
2/2 Test #2: sph_tests ........................***Exception: Numerical  0.15 sec

Four tests are commented temporarily:

1. densityForFourNeighbours
2. pressureForFourNeighbours
3. internalForcesForFourNeighbours
4. externalForcesForFourNeighbours

To Reproduce
Steps to reproduce the behavior:

1. Disable commented tests.
2. Push the changes.
3. Check GitHub Actions logs.

Expected behavior
All tests passed.

Screenshots
Null.

Desktop (please complete the following information):

• OS: Ubuntu
• Version: latest used in GitHub Actions

Smartphone (please complete the following information):
Null.

Additional context
This bug can be reproduced in Release mode only, so we can assume that it is connected to uninitialised vars or some memory issues.
Experiments showed that bug is in sercher init. We need to investigate and fix this bug.

Draw 3D object by its equation F(x,y,z) = 0

Is your feature request related to a problem? Please describe.
We want to draw 3D objects by its equation F(x,y,z) = 0. This feature is needed to draw objects inserted into considered region.

Describe the solution you'd like
I suggest to use well-known Marching Cubes algorithm.
Useful refs:
https://en.wikipedia.org/wiki/Marching_cubes
https://graphics.stanford.edu/~mdfisher/MarchingCubes.html
https://github.com/nsf/mc
https://github.com/dominikwodniok/dualmc

Optimize neighbor search algorithm

Currently NSA is very slow. Consider to replace it with new one.

TODO:

• Discover what algorithms are usually used to find neighbours in SPH.
• Implement a benchmark in Python and compare at least 3 algorithms: naive, mesh-based and hash-based.
• Publish benchmarking results in Wiki
• Implement the fastest algorithms in C++ if it is not implemented yet.

Use R-functions for describing problem domain

Is your feature request related to a problem? Please describe.
Currently we use several conditions to describe a cube and use it in the collision handling. It is better to have a boundary equation instead.

Describe the solution you'd like
Implement R-operations.

Change files mode to 644

Is your feature request related to a problem? Please describe.
Change files mode to 644

Describe the solution you'd like
Use chmod command on Linux

Fix unit tests in sph library

Describe the bug
Currently unit tests are disabled in sph CMake file https://github.com/aartiukh/sph/blob/develop/sph/CMakeLists.txt#L22

To Reproduce
Steps to reproduce the behavior:

1. Build sph-sdk
2. Run tests
3. Ensure that sph tests are not running

Expected behavior
The sph tests should work.

Add algorithm description to wiki/docs

TODO:

• Add doxygen to all classes/methods
• Add CMake custom target for doxygen files generation
• Consider to write formulas in doxygen comments and check if doxygen is able to generate Latex formulas properly
• Add MD document with algorithm SPH description

Setup coverage measure using Traciv CI and codecov

Is your feature request related to a problem? Please describe.
Add coverage measure and add badge to README

SPH implementation on GPU

Is your feature request related to a problem? Please describe.
It is reasonable to implement SPH algorithm on GPU in order to speedup all calculations.

Describe the solution you'd like
It is preferable to use OpenCL for the solution as it allows to run the code on CPU and GPU as well.

Describe alternatives you've considered
Consider CUDA or OpenACC as alternatives to OpenCL

Additional context
Useful links:

• https://www.khronos.org/opencl/
• https://developer.nvidia.com/opencl
• https://developer.nvidia.com/cuda-toolkit
• https://developer.nvidia.com/openacc

Remove SPHAlgorithms name space

Remove SPHAlgorithms, replace with SPHSDK

Draw 3D objects in demo

Is your feature request related to a problem? Please describe.
Marching cubes algorithm is implemented. Now it is required to draw the test objects inside the cude.

Describe the solution you'd like
Call MC algorithm once and plot triangles using OpenGL.

Add more control options

Is your feature request related to a problem? Please describe.
As a user I want to have more control options: turn the cube to left, right, up and down. Particles should react on these actions appropriately.

Describe the solution you'd like
A - turn left
D - turn right
W - turn up
X - turn down
S - restore the default position

Describe alternatives you've considered
None.

Additional context
Chose a step, maybe 5 degrees?