Data

Tools

Indexes

Applications

Experiments

Open Source Science

TrixiParticles.jl

TrixiParticles.jl: Particle-based multiphysics simulation in Julia - Published in JOSS (2025)

https://github.com/trixi-framework/trixiparticles.jl

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 9 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

julia multiphysics simulation smoothed-particle-hydrodynamics

Keywords from Contributors

mesh standardization fluxes interpretability pde geometry parallel discontinuous-galerkin finite-difference fourier

Scientific Fields

Earth and Environmental Sciences Physical Sciences - 40% confidence
Last synced: 4 months ago · JSON representation ·

Repository

TrixiParticles.jl: Particle-based multiphysics simulations in Julia

Basic Info
Statistics
  • Stars: 56
  • Watchers: 7
  • Forks: 15
  • Open Issues: 150
  • Releases: 14
Topics
julia multiphysics simulation smoothed-particle-hydrodynamics
Created over 3 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security Authors Zenodo

README.md

TrixiParticles.jl

Docs-stable Docs-dev Slack Youtube CI codecov SciML Code Style License: MIT DOI DOI

TrixiP_logo

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.

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.

YouTube

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
  • Support for GPUs by Nvidia, AMD and Apple (experimental)

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. TrixiParticles.jl works with Julia v1.10 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 (used for time integration) and 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 git@github.com: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.

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.

Documentation

You can find the documentation for the latest release here.

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} } and bibtex @article{neher2025trixiparticles, author = {Niklas S. Neher and Erik Faulhaber and Sven Berger and Gregor J. Gassner and Michael Schlottke-Lakemper}, title = {TrixiParticles.jl: Particle-based multiphysics simulation in Julia}, journal = {Journal of Open Source Software}, volume = {10}, number = {105}, pages = {7044}, year = {2025}, publisher = {Open Journals}, doi = {10.21105/joss.07044}, url = {https://joss.theoj.org/papers/10.21105/joss.07044}, issn = {2475-9066} }

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.

License and contributing

TrixiParticles.jl is licensed under the MIT license (see 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 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. To get in touch with the developers, join us on Slack or create an issue.

Acknowledgments

       

The project has benefited from funding from hereon and HiRSE.

Owner

  • Name: Trixi.jl
  • Login: trixi-framework
  • Kind: organization

Adaptive high-order numerical simulations of hyperbolic PDEs in Julia

JOSS Publication

TrixiParticles.jl: Particle-based multiphysics simulation in Julia
Published
January 27, 2025
DOI
Volume 10, Issue 105, Page 7044
Authors
Niklas S. Neher ORCID
High-Performance Computing Center Stuttgart, University of Stuttgart, Germany
Erik Faulhaber ORCID
Department of Mathematics and Computer Science, University of Cologne, Germany
Sven Berger ORCID
Institute of Surface Science, Helmholtz-Zentrum hereon, Germany
Gregor J. Gassner ORCID
Department of Mathematics and Computer Science, University of Cologne, Germany
Michael Schlottke-Lakemper ORCID
High-Performance Scientific Computing, University of Augsburg, Germany
Editor
Rohit Goswami ORCID
Tags
SPH particle-based multiphysics
View PDF Review Thread Software Archive

Citation (CITATION.bib) 

@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}
}

@article{neher2025trixiparticles,
  author       = {Niklas S. Neher and Erik Faulhaber and Sven Berger and Gregor J. Gassner and Michael Schlottke-Lakemper},
  title        = {TrixiParticles.jl: Particle-based multiphysics simulation in Julia},
  journal      = {Journal of Open Source Software},
  volume       = {10},
  number       = {105},
  pages        = {7044},
  year         = {2025},
  publisher    = {Open Journals},
  doi          = {10.21105/joss.07044},
  url          = {https://joss.theoj.org/papers/10.21105/joss.07044},
  issn         = {2475-9066}
}

GitHub Events

Total
  • Create event: 57
  • Commit comment event: 11
  • Release event: 9
  • Issues event: 53
  • Watch event: 18
  • Delete event: 48
  • Issue comment event: 518
  • Push event: 526
  • Pull request review comment event: 994
  • Pull request review event: 907
  • Pull request event: 347
  • Fork event: 6
Last Year
  • Create event: 57
  • Commit comment event: 11
  • Release event: 9
  • Issues event: 53
  • Watch event: 18
  • Delete event: 48
  • Issue comment event: 519
  • Push event: 530
  • Pull request review comment event: 1,006
  • Pull request review event: 912
  • Pull request event: 349
  • Fork event: 6

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 580
  • Total Committers: 11
  • Avg Commits per committer: 52.727
  • Development Distribution Score (DDS): 0.519
Past Year
  • Commits: 156
  • Committers: 9
  • Avg Commits per committer: 17.333
  • Development Distribution Score (DDS): 0.692
Top Committers
Name Email Commits
Erik Faulhaber 4****r 279
Niklas Neher 7****s 119
Sven Berger b****n@g****m 107
dependabot[bot] 4****] 31
github-actions[bot] 4****] 22
Hendrik Ranocha r****a 12
Michael Schlottke-Lakemper m****l@s****m 5
RubberLanding n****n@t****m 2
Mosè Giordano 7****o 1
Marcel Schurer 1****r 1
Joshua Lampert 5****t 1
Committer Domains (Top 20 + Academic)
tutanota.com: 1 sloede.com: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 90
  • Total pull requests: 692
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 9
  • Total pull request authors: 13
  • Average comments per issue: 1.04
  • Average comments per pull request: 1.61
  • Merged pull requests: 388
  • Bot issues: 0
  • Bot pull requests: 73
Past Year
  • Issues: 44
  • Pull requests: 385
  • Average time to close issues: 13 days
  • Average time to close pull requests: 12 days
  • Issue authors: 8
  • Pull request authors: 11
  • Average comments per issue: 0.36
  • Average comments per pull request: 1.75
  • Merged pull requests: 192
  • Bot issues: 0
  • Bot pull requests: 50
View more stats
Top Authors
Issue Authors
  • efaulhaber (37)
  • svchb (23)
  • LasNikas (19)
  • giordano (4)
  • Nour-Touil (2)
  • sloede (2)
  • luraess (1)
  • JuliaTagBot (1)
  • marcelschurer (1)
Pull Request Authors
  • efaulhaber (215)
  • LasNikas (198)
  • svchb (170)
  • github-actions[bot] (44)
  • dependabot[bot] (29)
  • ranocha (11)
  • marcelschurer (8)
  • RubberLanding (5)
  • giordano (4)
  • JoshuaLampert (2)
  • noahstruschka (2)
  • danielskatz (2)
  • sloede (2)
Top Labels
Issue Labels
discussion (15) bug (13) documentation (11) performance (7) enhancement (6) testing (4) good first issue (4) gpu (3) visualization (1) breaking changes (1) dependencies (1)
Pull Request Labels
bug (79) enhancement (62) high priority (34) dependencies (33) documentation (31) gpu (29) breaking changes (21) performance (17) testing (16) github_actions (9) discussion (8) visualization (5) low priority (3) hpc (1)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 6 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 14
juliahub.com: TrixiParticles

TrixiParticles.jl: Particle-based multiphysics simulations in Julia

  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 6 Total
Rankings
Dependent repos count: 9.7%
Average: 24.4%
Dependent packages count: 39.1%
Last synced: 4 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
.github/workflows/Documenter.yml actions
  • actions/checkout v4 composite
  • julia-actions/cache v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/FormatCheck.yml actions
  • actions/checkout v4 composite
  • julia-actions/cache v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/SpellCheck.yml actions
  • actions/checkout v4 composite
  • crate-ci/typos v1.18.2 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4 composite
  • julia-actions/cache v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/Invalidations.yml actions
  • actions/checkout v4 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-invalidations v1 composite
  • julia-actions/setup-julia v2 composite