Repository files navigation

Notice on repository transfer to SPHinXsys team

In order to promoting open-source democratization,this repository will be transferred to the SPHinXsys teamin the next few weeks.After the transfer, the decision-making process for SPHinXsys will be made by a number of project leaders from different institutions.

Project Status

Project Communication

SPHinXsys (pronunciation: s'fink-sis) is an acronym fromSmoothedParticleHydrodynamics forindustrial compleXsystems.The multi-physics library uses SPH (smoothed particle hydrodynamics) as the underlying numerical methodfor both particle-based and mesh-based discretization.Due to the unified computational framework, SPHinXsys is able to carry out simulation and optimization at the same time.For more information on the SPHinXsys project, please check the project website:https://www.sphinxsys.org.

Using SPHinXsys library, straightforward and fast multi-physics modeling can be achieved.Here, we present several short examples in flow, solid dynamics, fluid structure interactions (FSI) and dynamic solid contact.

Through the unified computational framework in SPHinXsys,the algorithms for particle methods are full compatible to those in the classical finite volume method (FVM).The following gives an example of the flow around cylinder problem solved by FVM in SPHinXsys.

Note that the code for FVM algorithm is exact the same one for particle interaction in SPHinXsys.The only difference is that SPHinXsys reads a predefined mesh, other than generate particles, before the computation.

The unique target-driven optimization is able to achieve the optimization target and physical solution all-in-once,which is able to accelerate optimization process greatly.The following gives an example of optimizing the conductivity distributionfor a thermal domain problem targeting minimum average temperature.

Note that the physical solution of the thermal domain (right) and the optimal distribution of conductivity (left)are obtained at the same time when optimization is finished.Also note that the entire optimization process is very fast andonly several times slower than that for a single physical solution with given conductivity distribution.

While SPHinXsys is written in C++, it provides a python interface for users to write python scripts to control the simulation,including carry out regression tests for continuous integration (CI) and other tasks.One example is given below for the dambreak case.Please check the source code of2D Dambreak case with python interfacefor the usage.

Recently, we have a preview release for the heterogeneous computing version of SPHinXsys.By using SYCL, a royalty-free open standard developed by the Khronos Group that allows developersto program heterogeneous architectures in standard C++, SPHinXsys is able to utilize the power of GPU.Please check thePreview Releaseand theSYCL branch for details.

Main publication on the library:

1. C. Zhang, M. Rezavand, Y. Zhu, Y. Yu, D. Wu, W. Zhang, J. Wang, X. Hu,"SPHinXsys: an open-source multi-physics and multi-resolution library based on smoothed particle hydrodynamics",Computer Physics Communications, 267, 108066, 2021.
   

The numerical methods and computational algorithms in SPHinXsys are based on the followingpublications.

SPHinXsys is cross-platform can be compiled and used in Windows, Linux and McOS systems.

For installation, program manual and tutorials, please checkhttps://www.sphinxsys.org/html/sphinx_index.html.Please check the documentation of the code athttps://xiangyu-hu.github.io/SPHinXsys/.For a Docker image, checkhttps://hub.docker.com/r/toshev/sphinxsys.

Thank you for using and supporting our open-source project! We value all feedback and strive to improve our codebase continuously.

As the code is on git-hub, you can register an account there (if you do not have a github account yet)and fork out the SPHinXsys repository.You can work on the forked repository and add new features, and then commit them.You can also initiate a pull request to the main repository,so that your new features can be merged into it.

To ensure efficient and effective development, we prioritize addressing issues and pull requests from those who actively contribute to the project. Your contributions, whether through code, documentation, or other means, help us maintain and enhance the project for everyone.We encourage all users to consider contributing in any way they can. Together, we can build a better, more robust software.

You are also welcomed to join the main repository as a collaborator,by which you are able to branch directly in the main repository,and review the pull request.

If you have any further question, you are also welcomed to contactxiangyu.hu@tum.de.