Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trixi-framework/trixiparticles.jl
TrixiParticles.jl: Particle-based multiphysics simulations in Julia
https://github.com/trixi-framework/trixiparticles.jl
julia multiphysics simulation smoothed-particle-hydrodynamics
Last synced: about 1 month ago
JSON representation
TrixiParticles.jl: Particle-based multiphysics simulations in Julia
- Host: GitHub
- URL: https://github.com/trixi-framework/trixiparticles.jl
- Owner: trixi-framework
- License: mit
- Created: 2022-06-20T13:16:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T18:38:03.000Z (about 2 months ago)
- Last Synced: 2024-10-29T20:38:57.589Z (about 2 months ago)
- Topics: julia, multiphysics, simulation, smoothed-particle-hydrodynamics
- Language: Julia
- Homepage: https://trixi-framework.github.io/TrixiParticles.jl/
- Size: 20.8 MB
- Stars: 33
- Watchers: 7
- Forks: 10
- Open Issues: 95
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.bib
- Security: SECURITY.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# TrixiParticles.jl
[](https://trixi-framework.github.io/TrixiParticles.jl/stable)
[](https://trixi-framework.github.io/TrixiParticles.jl/dev)
[](https://join.slack.com/t/trixi-framework/shared_invite/zt-sgkc6ppw-6OXJqZAD5SPjBYqLd8MU~g)
[](https://www.youtube.com/@trixi-framework)
[](https://github.com/trixi-framework/TrixiParticles.jl/actions/workflows/ci.yml)
[](https://codecov.io/github/trixi-framework/TrixiParticles.jl)
[](https://github.com/SciML/SciMLStyle)
[](https://opensource.org/licenses/MIT)
[](https://zenodo.org/doi/10.5281/zenodo.10797541)
**TrixiParticles.jl** is a high-performance numerical simulation framework for particle-based methods, focused on the simulation of complex multiphysics problems, and written in [Julia](https://julialang.org).
TrixiParticles.jl focuses on the following use cases:
- Accurate and efficient physics-based modelling of complex multiphysics problems.
- Development of new particle-based methods and models.
- Easy setup of accessible simulations for educational purposes, including student projects, coursework, and thesis work.
It offers intuitive configuration, robust pre- and post-processing, and vendor-agnostic GPU-support based on the Julia package [KernelAbstractions.jl](https://github.com/JuliaGPU/KernelAbstractions.jl).
[](https://www.youtube.com/watch?v=V7FWl4YumcA&t=4667s)
## Features
- Incompressible Navier-Stokes
- Methods: Weakly Compressible Smoothed Particle Hydrodynamics (WCSPH), Entropically Damped Artificial Compressibility (EDAC)
- Models: Surface Tension, Open Boundaries
- Solid-body mechanics
- Methods: Total Lagrangian SPH (TLSPH), Discrete Element Method (DEM)
- Fluid-Structure Interaction
- Particle sampling of complex geometries from `.stl` and `.asc` files.
- Output formats:
- VTK
## Examples
We provide several example simulation setups in the `examples` folder (which can be accessed from Julia via `examples_dir()`).
2D Dam Break
Moving Wall
Oscillating Beam
Dam Break with Elastic Plate
## Installation
If you have not yet installed Julia, please [follow the instructions for your
operating system](https://julialang.org/downloads/platform/). TrixiParticles.jl works
with Julia v1.9 and newer. We recommend using the latest stable release of Julia.
### For users
TrixiParticles.jl is a registered Julia package.
You can install TrixiParticles.jl,
[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) (used for time integration)
and [Plots.jl](https://github.com/JuliaPlots/Plots.jl) by executing the following commands
in the Julia REPL:
```julia
julia> using Pkg
julia> Pkg.add(["TrixiParticles", "OrdinaryDiffEq", "Plots"])
```
### For developers
If you plan on editing TrixiParticles.jl itself, you can download TrixiParticles.jl
to a local folder and use the code from the cloned directory:
```bash
git clone [email protected]:trixi-framework/TrixiParticles.jl.git
cd TrixiParticles.jl
mkdir run
julia --project=run -e 'using Pkg; Pkg.develop(PackageSpec(path="."))' # Add TrixiParticles.jl to `run` project
julia --project=run -e 'using Pkg; Pkg.add(["OrdinaryDiffEq", "Plots"])' # Add additional packages
```
If you installed TrixiParticles.jl this way, you always have to start Julia with the
`--project` flag set to your `run` directory, e.g.,
```bash
julia --project=run
```
from the TrixiParticles.jl root directory.
Further details can be found in the [documentation](https://trixi-framework.github.io/TrixiParticles.jl/stable).
## Usage
In the Julia REPL, first load the package TrixiParticles.jl.
```jldoctest getting_started
julia> using TrixiParticles
```
Then start the simulation by executing
```jldoctest getting_started; filter = r".*"s
julia> trixi_include(joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"))
```
This will open a new window with a 2D visualization of the final solution:
Further details can be found in the [documentation](https://trixi-framework.github.io/TrixiParticles.jl/stable).
## Documentation
You can find the documentation for the latest release
[here](https://trixi-framework.github.io/TrixiParticles.jl/stable).
## Publications
## Cite Us
If you use TrixiParticles.jl in your own research or write a paper using results obtained
with the help of TrixiParticles.jl, please cite it as
```bibtex
@misc{trixiparticles,
title={{T}rixi{P}articles.jl: {P}article-based multiphysics simulations in {J}ulia},
author={Erik Faulhaber and Niklas Neher and Sven Berger and
Michael Schlottke-Lakemper and Gregor Gassner},
year={2024},
howpublished={\url{https://github.com/trixi-framework/TrixiParticles.jl}},
doi={10.5281/zenodo.10797541}
}
```
## Authors
Erik Faulhaber (University of Cologne) and Niklas Neher (HLRS) implemented the foundations
for TrixiParticles.jl and are principal developers along with Sven Berger (hereon).
The project was started by Michael Schlottke-Lakemper (University of Augsburg)
and Gregor Gassner (University of Cologne), who provide scientific direction and technical advice.
The full list of contributors can be found in [AUTHORS.md](AUTHORS.md).
## License and contributing
TrixiParticles.jl is licensed under the MIT license (see [LICENSE.md](LICENSE.md)). Since TrixiParticles.jl is
an open-source project, we are very happy to accept contributions from the
community. Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
Note that we strive to be a friendly, inclusive open-source community and ask all members
of our community to adhere to our [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md).
To get in touch with the developers,
[join us on Slack](https://join.slack.com/t/trixi-framework/shared_invite/zt-sgkc6ppw-6OXJqZAD5SPjBYqLd8MU~g)
or [create an issue](https://github.com/trixi-framework/TrixiParticles.jl/issues/new).
## Acknowledgments
The project has benefited from funding from [hereon](https://www.hereon.de/) and [HiRSE](https://www.helmholtz-hirse.de/).