-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update readme * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Hugo <hugo.talbot@sofa-framework.org> --------- Co-authored-by: Hugo <hugo.talbot@sofa-framework.org>
- Loading branch information
Showing
4 changed files
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,41 @@ | ||
# SofaSphFluid plugin | ||
|
||
This plugin enables simulation of fluid-object interaction using Smoothed-particle hydrodynamics (SPH). | ||
[![Documentation](https://img.shields.io/badge/doc-on_website-green.svg)](https://sofa-framework.github.io/doc/) | ||
[![Support](https://img.shields.io/badge/support-on_GitHub_Discussions-blue.svg)](https://github.com/sofa-framework/sofa/discussions/categories/sofasphfluid) | ||
[![Gitter](https://img.shields.io/badge/chat-on_Gitter-ff69b4.svg)](https://app.gitter.im/#/room/#sofa-framework:gitter.im) | ||
|
||
## Description | ||
|
||
This SOFA SPH Plugin enables advanced simulations of fluid-object interactions using the Smoothed Particle Hydrodynamics (SPH) method. | ||
It allows realistic modeling of fluid dynamics, where fluids and solids interact seamlessly, making it ideal for applications mixing computational fluid dynamics and soft body simulations. | ||
|
||
Here are a some results of the integration: | ||
|<img align="center" width="90%" height="auto" src="./doc/SpatialGridPointModel.png">|<img align="center" width="90%" height="auto" src="./doc/SPHParticleSink.png">| | ||
|--|--| | ||
| <p align="center">SPH against physical barriers</p> | <p align="center">SPH interaction with 3D mesh </p>| | ||
|
||
Smoothed Particle Hydrodynamics (SPH) is a computational method used for simulating the behavior of fluids. | ||
In SPH, the fluid is represented by a collection of particles, each carrying properties such as mass, position, velocity, and pressure. | ||
The properties of the fluid are computed by smoothing functions over these particles, allowing for the accurate simulation of fluid flow, turbulence, and fluid-object interactions. | ||
|
||
SPH is widely used in applications like fluid dynamics, astrophysics, and special effects in computer graphics due to its flexibility and ability to handle complex free-surface flows. | ||
|
||
<p align="center"> | ||
<img align="center" width="75%" height="auto" src="./doc/Sprite-based-rendering.gif"> | ||
</p> | ||
|
||
## Build instructions | ||
|
||
This plugin relies on the open-source project SOFA. To build the sources of this plugin, you can follow the associated "[Build a plugin from sources](https://sofa-framework.github.io/doc/plugins/build-a-plugin-from-sources/)" documentation page. | ||
|
||
## Documentation | ||
|
||
- [API Documentation](https://sofa-framework.github.io/doc/plugins/usual-plugins/sofasphfluid/oglfluidmodel/) | ||
|
||
## Licence: | ||
|
||
This plugin is LGPL | ||
LGPL refers to the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. | ||
|
||
If this work is useful for your industrial application, your [support](https://www.sofa-framework.org/consortium/support-us/) would be most welcome. | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.