Skip to content

doc: add performance comparison table #458

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

Merged
henry2004y merged 2 commits into from
Feb 11, 2026
Merged

doc: add performance comparison table #458

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1d4257
doc: add performance comparison table
henry2004y Feb 11, 2026
205b983
Format table display
henry2004y Feb 11, 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
23 changes: 19 additions & 4 deletions docs/examples/features/demo_hybrid.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import DisplayAs #hide
using TestParticle, OrdinaryDiffEq, StaticArrays
import TestParticle as TP
using LinearAlgebra, Random
using LinearAlgebra, Random, Printf, Markdown
using CairoMakie
CairoMakie.activate!(type = "png") #hide

Expand Down Expand Up @@ -62,7 +62,8 @@ tspan = (0.0, 30 * T_gyro)

param_fo = prepare(E_field, B_field; species = Proton)
prob_fo = ODEProblem(trace, u0, tspan, param_fo)
sol_fo = solve(prob_fo, Vern9())
stats_fo = @timed solve(prob_fo, Vern9(); save_everystep = true)
sol_fo = stats_fo.value;

## Verify trapping: z should oscillate, not diverge
z_fo = [u[3] for u in sol_fo.u]
Expand All @@ -79,7 +80,8 @@ stateinit_gc, param_gc = TP.prepare_gc(
u0, bottle_E_static, bottle_B_static; species = Proton
)
prob_gc = ODEProblem(trace_gc!, stateinit_gc, tspan, param_gc)
sol_gc = solve(prob_gc, Vern9());
stats_gc = @timed solve(prob_gc, Vern9())
sol_gc = stats_gc.value;

# ## Step 3: Hybrid Solver
#
Expand All @@ -100,7 +102,8 @@ alg = AdaptiveHybrid(;

Random.seed!(1234)
## Set verbose = true to see the dynamic switching
sol = TP.solve(TraceHybridProblem(u0, tspan, p), alg; verbose = false)[1];
stats_hybrid = @timed TP.solve(TraceHybridProblem(u0, tspan, p), alg; verbose = false)
sol = stats_hybrid.value[1];

# ## Step 4: Compute Adiabaticity
#
Expand Down Expand Up @@ -251,3 +254,15 @@ Legend(f[3, 1:4], ax_ts; orientation = :horizontal)
rowsize!(f.layout, 1, Relative(0.55))

f = DisplayAs.PNG(f) #hide

# ## Performance Comparison
#
# Finally, we compare the execution time and memory allocations of the three solvers.

io = IOBuffer() #hide
println(io, "| Solver | Time (s) | Allocations (bytes) |") #hide
println(io, "| :--- | :--- | :--- |") #hide
Printf.@printf(io, "| Full Orbit | %.2e | %.2e |\n", stats_fo.time, stats_fo.bytes) #hide
Printf.@printf(io, "| Guiding Center | %.2e | %.2e |\n", stats_gc.time, stats_gc.bytes) #hide
Printf.@printf(io, "| Hybrid | %.2e | %.2e |\n", stats_hybrid.time, stats_hybrid.bytes) #hide
Markdown.parse(String(take!(io))) #hide
Loading