Skip to content

Refactor SPH system initialization to use keyword arguments#1144

Open
svchb wants to merge 3 commits intotrixi-framework:devfrom
svchb:api/unify-fluid-constructors
Open

Refactor SPH system initialization to use keyword arguments#1144
svchb wants to merge 3 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 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

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (dev@d628a6d). Learn more about missing BASE report.

Additional details and impacted files
@@          Coverage Diff           @@
##             dev    #1144   +/-   ##
======================================
  Coverage       ?   89.13%           
======================================
  Files          ?      128           
  Lines          ?     9935           
  Branches       ?        0           
======================================
  Hits           ?     8856           
  Misses         ?     1079           
  Partials       ?        0           
Flag Coverage Δ
total 89.13% <100.00%> (?)
unit 67.69% <100.00%> (?)

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
6 tasks
Comment on lines +124 to +125
smoothing_kernel=smoothing_kernel,
smoothing_length=smoothing_length,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
smoothing_kernel=smoothing_kernel,
smoothing_length=smoothing_length,
smoothing_kernel, smoothing_length,

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.

2 participants