Combine PST and TVF into a unified framework by efaulhaber · Pull Request #884 · trixi-framework/TrixiParticles.jl

efaulhaber · 2025-08-17T12:02:23Z

Based on #882 and #883.

efaulhaber · 2025-08-17T13:27:19Z

+An alternative formulation is the so-called Transport Velocity Formulation (TVF)
+by [Adami (2013)](@cite Adami2013).
+[Ramachandran (2019)](@cite Ramachandran2019) applied the TVF also for the [EDAC](@ref edac)
+scheme.


Note that I just copied this section over from EDAC and changed this first paragraph. The rest of the section is unchanged, except for changes like "right hand side" to "right-hand side" and "time-step" to "time step".

efaulhaber · 2025-08-17T13:27:36Z

+with the density ``\rho_a``, ``\rho_b`` and the pressure ``p_a``, ``p_b`` of particles ``a``
+and ``b``, respectively. ``\bm{A}_a`` and ``\bm{A}_b`` are the convection tensors
+for particle ``a`` and ``b``, respectively, and are given, e.g., for particle ``a``,


And I added a few commas here.

efaulhaber · 2025-08-17T13:27:42Z

+for particle ``a`` and ``b``, respectively, and are given, e.g., for particle ``a``,
+as ``\bm{A}_a = \rho v_a\left(\tilde{v}_a-v_a\right)^T``.
+
+To apply the TVF, use the keyword argument `shifting_technique` in the constructor


This is new.

codecov · 2025-08-17T14:03:43Z

Codecov Report

❌ Patch coverage is 16.52174% with 96 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.26%. Comparing base (38f5f07) to head (844145e).
⚠️ Report is 1 commits behind head on dev.

Files with missing lines	Patch %	Lines
src/schemes/fluid/shifting_techniques.jl	11.57%	84 Missing ⚠️
src/callbacks/update.jl	0.00%	11 Missing ⚠️
...rc/schemes/fluid/entropically_damped_sph/system.jl	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev     #884      +/-   ##
==========================================
+ Coverage   71.16%   71.26%   +0.10%     
==========================================
  Files         107      106       -1     
  Lines        7005     6996       -9     
==========================================
+ Hits         4985     4986       +1     
+ Misses       2020     2010      -10

Flag	Coverage Δ
unit	`71.26% <16.52%> (+0.10%)`	⬆️

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.

* Combine PST and TVF into a unified framework * Require update callback for PST * Fix WCSPH * Update PST only in callback * Fix EDAC * Update docs * Fix alle example files * Fix tests * Fix periodic channel * Fix docs * Update news * Fix tests * Fix example file

* add dvu_ode vector to custom quantities * add for fluid and boundary * fix tests * fix tests * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * Combine PST and TVF into a unified framework (#884) * Combine PST and TVF into a unified framework * Require update callback for PST * Fix WCSPH * Update PST only in callback * Fix EDAC * Update docs * Fix alle example files * Fix tests * Fix periodic channel * Fix docs * Update news * Fix tests * Fix example file * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * Combine PST and TVF into a unified framework (#884) * Combine PST and TVF into a unified framework * Require update callback for PST * Fix WCSPH * Update PST only in callback * Fix EDAC * Update docs * Fix alle example files * Fix tests * Fix periodic channel * Fix docs * Update news * Fix tests * Fix example file * fix tests * fix doctests * implement suggestions * fix tests * fix tests * implement suggestions * fix * fix --------- Co-authored-by: LasNikas <niklas.nehe@web.de> Co-authored-by: Sven Berger <berger.sven@gmail.com> Co-authored-by: Erik Faulhaber <44124897+efaulhaber@users.noreply.github.com>

* swap extrapolation * swap density pressure * adapt docs * rm example * fix missing nhs update * implement different mirror methods * add docs * fix tests * fix typos * add docs * add tests * apply formatter * add `average_velocity!` for `BoundaryModelLastiwka` * fix * add interpolation functions * restructure again * fix gpu bugs * remove unnecessary argument * fix gpu again * fix gpu * implement suggestions * fix * add comments * implement suggestions * first prototype: NOT VALIDATED YET * fix avg vel in LastiwkaModel * fix avg in mirroring * fix tests * adapt example file * fix allocations * fix gpu * first GPU working prototype * improve API * fix tests * rm export * fix * fix type stability * implement suggestions * rm ref * format * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * fix merge bugs * supersede #852 * supersede #850 * fix * rename boundary models * fix? * fix tests * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * fix characteristics * revise pipe flow example * fix include bug * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * Combine PST and TVF into a unified framework (#884) * Combine PST and TVF into a unified framework * Require update callback for PST * Fix WCSPH * Update PST only in callback * Fix EDAC * Update docs * Fix alle example files * Fix tests * Fix periodic channel * Fix docs * Update news * Fix tests * Fix example file * add doc strings * implement suggestions * remove duplicated system * rm unnecessary variable * apply formatter * set pressure for WCSPH * setter for open boundary * rename reference values * fix gpu tests * fix sign * implement suggestions * fix unit tests * revise doc strings * add NEWS entry * update NEWS --------- Co-authored-by: LasNikas <niklas.nehe@web.de> Co-authored-by: Sven Berger <berger.sven@gmail.com> Co-authored-by: Erik Faulhaber <44124897+efaulhaber@users.noreply.github.com>

* Integrate write2json for initial metadata export * Remove old `write_meta_data` parameter from VTK writing functions and callbacks * Add `solver_name` to metadata and format files * update `write2json.jl` to match merge * rename file * update references * rename function * Refactor write2vtk! * formatting * refactor functions * implement suggestions * fix bugs * add add_meta_data! function for `system::ParticlePackingSystem` * relocate `add_meta_data!` to `system.jl` * formatting * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * dispatch `FluidSystem` * Write one unified metadata file for all systems * improve JSON-file structure * improve consistency * Enhance structure of the JSON-File * Fix `rho0` in `AkinciFreeSurfaceCorrection` * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * Refactor metadata handling * Add settable filename * Add filename display to SolutionSavingCallback output * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * add function for `ParticlePackingSystem` * improve structure * Formatting Code * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * fix failing tests * Rename 'tlsph' to 'place_on_shell' (#814) * rename * format * forgot some * format * naming * forgot some more * fix test * incorporate review comments * format --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> * Combine PST and TVF into a unified framework (#884) * Combine PST and TVF into a unified framework * Require update callback for PST * Fix WCSPH * Update PST only in callback * Fix EDAC * Update docs * Fix alle example files * Fix tests * Fix periodic channel * Fix docs * Update news * Fix tests * Fix example file * improve structure and fixing problems * add `shifting_technique` to `io.jl` * change filename of the JSON-File * add suggestions * Enhance data handling for `OpenBoundarySPHSystem` * correct formatting issue * Remove autoinfiltrate * rename `number_of_threads` --------- Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com> Co-authored-by: Sven Berger <berger.sven@gmail.com> Co-authored-by: Erik Faulhaber <44124897+efaulhaber@users.noreply.github.com>

efaulhaber changed the base branch from main to dev August 17, 2025 12:02

efaulhaber self-assigned this Aug 17, 2025

efaulhaber added the breaking changes This change will break the public API and requires a new major release label Aug 17, 2025

efaulhaber mentioned this pull request Aug 17, 2025

Merge dev to main #832

Merged

7 tasks

efaulhaber changed the base branch from dev to main August 17, 2025 12:09

efaulhaber changed the base branch from main to dev August 17, 2025 12:09

efaulhaber force-pushed the revise-pst branch from 155a958 to cf7a35b Compare August 17, 2025 13:06

efaulhaber commented Aug 17, 2025

View reviewed changes

efaulhaber changed the base branch from dev to main August 17, 2025 13:43

efaulhaber closed this Aug 17, 2025

efaulhaber reopened this Aug 17, 2025

efaulhaber force-pushed the revise-pst branch from a7937e0 to f342e96 Compare August 18, 2025 06:33

efaulhaber force-pushed the revise-pst branch 2 times, most recently from 51270d9 to a118d24 Compare August 26, 2025 09:57

efaulhaber changed the base branch from main to dev August 26, 2025 09:58

efaulhaber added 12 commits August 26, 2025 13:00

Combine PST and TVF into a unified framework

d4f6764

Require update callback for PST

6280538

Fix WCSPH

1f882f6

Update PST only in callback

8b150bb

Fix EDAC

fa90ae9

Update docs

9bdd2d6

Fix alle example files

13d3268

Fix tests

2a0ae28

Fix periodic channel

b5d1492

Fix docs

77e20e1

Update news

0209d65

Fix tests

e8146dc

Fix example file

844145e

efaulhaber force-pushed the revise-pst branch from a118d24 to 844145e Compare August 26, 2025 10:01

efaulhaber marked this pull request as ready for review August 26, 2025 10:14

efaulhaber requested review from LasNikas and svchb August 26, 2025 10:14

LasNikas approved these changes Aug 26, 2025

View reviewed changes

svchb approved these changes Aug 26, 2025

View reviewed changes

svchb merged commit b9d091c into trixi-framework:dev Aug 26, 2025
12 of 13 checks passed

efaulhaber deleted the revise-pst branch August 26, 2025 14:25

efaulhaber referenced this pull request Sep 19, 2025

Merge dev into main for major release 0.4 (#832)

cecb8c0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Combine PST and TVF into a unified framework#884

Combine PST and TVF into a unified framework#884
svchb merged 13 commits intotrixi-framework:devfrom
efaulhaber:revise-pst

efaulhaber commented Aug 17, 2025 •

edited

Loading

Uh oh!

efaulhaber Aug 17, 2025

Uh oh!

efaulhaber Aug 17, 2025

Uh oh!

efaulhaber Aug 17, 2025

Uh oh!

codecov Bot commented Aug 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

efaulhaber commented Aug 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

efaulhaber Aug 17, 2025

Choose a reason for hiding this comment

Uh oh!

efaulhaber Aug 17, 2025

Choose a reason for hiding this comment

Uh oh!

efaulhaber Aug 17, 2025

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Aug 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

efaulhaber commented Aug 17, 2025 •

edited

Loading

codecov Bot commented Aug 17, 2025 •

edited

Loading