Skip to content

Refactor SPH system initialization to use keyword arguments#1144

Merged
efaulhaber merged 64 commits intotrixi-framework:devfrom
svchb:api/unify-fluid-constructors
Apr 28, 2026
Merged

Refactor SPH system initialization to use keyword arguments#1144
efaulhaber merged 64 commits intotrixi-framework:devfrom
svchb:api/unify-fluid-constructors

Conversation

@svchb
Copy link
Copy Markdown
Collaborator

@svchb svchb commented Apr 16, 2026

  • Updated the initialization of WeaklyCompressibleSPHSystem, ImplicitIncompressibleSPHSystem, TotalLagrangianSPHSystem, DEMSystem and EntropicallyDampedSPHSystem across multiple examples to utilize keyword arguments for better readability and maintainability.
  • Adjusted the documentation for both systems to reflect the new argument structure.
  • Ensured consistency in the usage of density calculators and state equations in the examples.
  • Modified tests to validate the new keyword argument structure for both SPH systems.

- Updated the initialization of `WeaklyCompressibleSPHSystem` and `EntropicallyDampedSPHSystem` across multiple examples to utilize keyword arguments for better readability and maintainability.
- Adjusted the documentation for both systems to reflect the new argument structure.
- Ensured consistency in the usage of density calculators and state equations in the examples.
- Modified tests to validate the new keyword argument structure for both SPH systems.
@svchb svchb self-assigned this Apr 16, 2026
@svchb svchb added the breaking changes This change will break the public API and requires a new major release label Apr 16, 2026
@svchb svchb requested review from LasNikas and efaulhaber April 16, 2026 23:59
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 17, 2026

Codecov Report

❌ Patch coverage is 87.50000% with 6 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (dev@3d7c0c2). Learn more about missing BASE report.

Files with missing lines Patch % Lines
src/callbacks/solution_saving.jl 0.00% 1 Missing ⚠️
src/preprocessing/geometries/io.jl 0.00% 1 Missing ⚠️
.../preprocessing/particle_packing/signed_distance.jl 0.00% 1 Missing ⚠️
src/schemes/boundary/dem_boundary/system.jl 0.00% 1 Missing ⚠️
...rc/schemes/fluid/entropically_damped_sph/system.jl 50.00% 1 Missing ⚠️
src/setups/complex_shape.jl 0.00% 1 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff           @@
##             dev    #1144   +/-   ##
======================================
  Coverage       ?   68.10%           
======================================
  Files          ?      128           
  Lines          ?    10019           
  Branches       ?        0           
======================================
  Hits           ?     6823           
  Misses         ?     3196           
  Partials       ?        0           
Flag Coverage Δ
unit 68.10% <87.50%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@svchb svchb changed the base branch from main to dev April 17, 2026 06:39
@LasNikas LasNikas mentioned this pull request Apr 17, 2026
7 tasks
Comment thread docs/literate/src/tut_setup.jl Outdated
@svchb svchb requested a review from efaulhaber April 21, 2026 10:05
Comment thread examples/fluid/dam_break_2d.jl Outdated
@svchb svchb added this to the 0.5 milestone Apr 22, 2026
@svchb svchb requested a review from LasNikas April 22, 2026 13:09
Comment thread docs/literate/src/tut_rigid_body_fsi.jl Outdated
@svchb svchb requested a review from efaulhaber April 23, 2026 09:59
@svchb svchb requested a review from efaulhaber April 28, 2026 11:45
svchb added 3 commits April 28, 2026 13:59
…tructors

# Conflicts:
#	examples/fluid/dam_break_3d.jl
#	examples/fluid/falling_water_column_2d.jl
#	examples/fsi/dam_break_gate_2d.jl
#	examples/fsi/dam_break_plate_2d.jl
#	examples/fsi/falling_rigid_spheres_2d.jl
#	examples/fsi/falling_rotating_rigid_squares_2d.jl
#	examples/fsi/falling_spheres_2d.jl
Comment thread examples/fluid/sphere_surface_tension_2d.jl Outdated
Comment thread src/schemes/fluid/entropically_damped_sph/system.jl
Comment thread src/schemes/fluid/implicit_incompressible_sph/system.jl Outdated
Comment thread src/schemes/fluid/weakly_compressible_sph/system.jl
@svchb svchb requested a review from efaulhaber April 28, 2026 12:51
Comment thread NEWS.md Outdated
Comment thread NEWS.md Outdated
svchb and others added 2 commits April 28, 2026 15:08
Co-authored-by: Erik Faulhaber <[email protected]>
Co-authored-by: Erik Faulhaber <[email protected]>
@svchb svchb requested a review from efaulhaber April 28, 2026 13:09
@efaulhaber efaulhaber merged commit 92884cb into trixi-framework:dev Apr 28, 2026
5 checks passed
@svchb svchb deleted the api/unify-fluid-constructors branch April 28, 2026 13:19
@efaulhaber efaulhaber mentioned this pull request Apr 29, 2026
efaulhaber added a commit that referenced this pull request Apr 29, 2026
* Apply Copilot suggestion

* Apply Copilot suggestion

* Fix unit tests

* Fix dam break GPU example

* Refactor dam break simulation parameters for clarity

* Fix syntax error in dam_break_2d_gpu.jl

* fix

* fix allocations

* pin static.jl to 1.3.1

* Fix 2adeecd

---------

Co-authored-by: Sven Berger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking changes This change will break the public API and requires a new major release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants