Skip to content

Add ThrustCalculator #1229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
efaulhaber wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Add ThrustCalculator #1229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8ef214b
Convert `MechanicalWorkCalculatorCallback` to a custom quantity
efaulhaber Jun 1, 2026
2388efd
Fix
efaulhaber Jun 1, 2026
ac8e18a
Update docstrings
efaulhaber Jun 1, 2026
1ac2a49
Extract function
efaulhaber Jun 1, 2026
5b1c85d
Fix docstring
efaulhaber Jun 1, 2026
16647c2
Fix return value
efaulhaber Jun 1, 2026
a875ca0
Fix return values
efaulhaber Jun 1, 2026
35edcb2
Move timer out of inner function
efaulhaber Jun 1, 2026
71ff0ec
Add `ThrustCalculator`
efaulhaber Jun 1, 2026
fc31569
Fix timer
efaulhaber Jun 1, 2026
6694821
Fix
efaulhaber Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/src/callbacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,13 @@ The following pre-defined custom quantities can be used with the
Modules = [TrixiParticles]
Pages = ["general/custom_quantities.jl"]
```

# Mechanical Work Calculator

@efaulhaber efaulhaber Jun 3, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

INFO: This autodocs block now includes ThrustCalculator, but the section title and intro only mention mechanical work. Rename or expand the section so users can find thrust documentation under an accurate heading.


The `MechanicalWorkCalculator` is a special custom quantity to be used with the
[`PostprocessCallback`](@ref).

Comment on lines +18 to +22
```@autodocs
Modules = [TrixiParticles]
Pages = ["general/mechanical_work_calculator.jl"]
```
4 changes: 2 additions & 2 deletions src/TrixiParticles.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ export WeaklyCompressibleSPHSystem, EntropicallyDampedSPHSystem, TotalLagrangian
export BoundaryZone, InFlow, OutFlow, BidirectionalFlow
export InfoCallback, SolutionSavingCallback, DensityReinitializationCallback,
PostprocessCallback, StepsizeCallback, UpdateCallback, SteadyStateReachedCallback,
SplitIntegrationCallback, MechanicalWorkCalculatorCallback,
calculated_mechanical_work,
SplitIntegrationCallback, MechanicalWorkCalculator, calculated_mechanical_work,
Comment thread
efaulhaber marked this conversation as resolved.

@efaulhaber efaulhaber Jun 3, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

WARNING: MechanicalWorkCalculator and ThrustCalculator are new exported user-facing quantities, but the PR does not add compact and rich Base.show methods required for types shown in callback summaries. Add display methods using summary_header, summary_line, and summary_footer.

ThrustCalculator, calculated_thrust,
SortingCallback
export ContinuityDensity, SummationDensity
export PenaltyForceGanzenmueller, TransportVelocityAdami, ParticleShiftingTechnique,
Expand Down
1 change: 0 additions & 1 deletion src/callbacks/callbacks.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,4 @@ include("stepsize.jl")
include("update.jl")
include("steady_state_reached.jl")
include("split_integration.jl")
include("mechanical_work_calculator.jl")
include("sorting.jl")
243 changes: 0 additions & 243 deletions src/callbacks/mechanical_work_calculator.jl
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions src/general/general.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ include("initial_condition.jl")
include("buffer.jl")
include("interpolation.jl")
include("custom_quantities.jl")
include("mechanical_work_calculator.jl")
include("time_integration.jl")
Loading
Loading