Update plotting support for Makie for 2D by vincmarks · Pull Request #3057 · trixi-framework/Trixi.jl

vincmarks · 2026-06-02T15:51:21Z

Extension of #3035 to add Makie.plot support for 2D, addressing #1872.

Changes

Makie.plot(sol) and Makie.plot(pd) now work for all 2D mesh types
Single-variable plots: Makie.plot(pd["rho"])
Mesh overlay: Makie.plot(pd, plot_mesh = true) or Makie.plot!(Trixi.getmesh(pd))
Custom axis via Makie.plot!(ax, pd["rho"])
Bugfix: plot_mesh kwarg in TrixiHeatmap recipe was ignored
Unified keyword argument: plot_mesh (was show_mesh in some functions before)
Tests and documentation updated

Example

trixi_include(joinpath(examples_dir(), "dgmulti_2d", "elixir_euler_curved.jl"))
pd = PlotData2D(sol)
fig = Figure()
ax = Axis(fig[1, 1], title = "Density", xlabel = "x", ylabel = "y",
          aspect = Makie.DataAspect())
plt = plot!(ax, pd["rho"], colormap = :berlin)
Colorbar(fig[1, 2], colormap = :berlin)
plot!(Trixi.getmesh(pd))

github-actions · 2026-06-02T15:51:40Z

codecov · 2026-06-02T18:01:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.84%. Comparing base (2796976) to head (28a675d).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3057      +/-   ##
==========================================
+ Coverage   96.83%   96.84%   +0.01%     
==========================================
  Files         636      636              
  Lines       49581    49643      +62     
==========================================
+ Hits        48011    48074      +63     
+ Misses       1570     1569       -1

Flag	Coverage Δ
unittests	`96.84% <100.00%> (+0.01%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

ranocha · 2026-06-02T18:33:53Z

+interactive surface plots. Heatmap plots are supported for all 2D mesh types
+([`TreeMesh`](@ref), [`P4estMesh`](@ref), [`UnstructuredMesh2D`](@ref), [`StructuredMesh`](@ref), [`T8codeMesh`](@ref), DGMulti meshes);
+interactive surface plots are available for [`UnstructuredMesh2D`](@ref) and compatible mesh types.


Do we need to list everything here? What does "compatible mesh types" mean?

With "compatible mesh types" I wanted to refer to all mesh types that support iplot. While writing 3f91bd0 I noticed that iplot was actually failing for DGMulti solver due to a missing PlotData2DTriangulated constructor dispatch for DGMulti. I fixed this by adding

PlotData2DTriangulated(u, mesh, equations, dg::DGMulti{2}, cache; kwargs...) = PlotData2D(u, mesh, equations, dg, cache; kwargs...)

to src/visualization/types.jl. This works because PlotData2D for DGMulti returns a PlotData2DTriangulated internally.

ranocha · 2026-06-03T18:55:11Z

Thanks a lot! Please ping me when this is ready for a full review.

vincmarks · 2026-06-04T17:33:28Z

@ranocha , the PR is ready for review

ranocha

Thanks a lot, very nice work! I have a couple of comments/questions.

ranocha · 2026-06-04T18:00:47Z

-both for heatmap-type plots (similar to the [Plots.jl](@ref Plots.jl) recipes) as well as for
-interactive surface plots. Support is currently limited to the [`UnstructuredMesh2D`](@ref) type.
+for 1D line plots and 2D heatmap-type plots (similar to the [Plots.jl](@ref Plots.jl) recipes), as well as
+interactive surface plots via `iplot` for all supported 2D mesh types.


Suggested change

interactive surface plots via `iplot` for all supported 2D mesh types.

interactive surface plots via [`iplot`](@ref) for all supported 2D mesh types.

ranocha · 2026-06-04T18:04:08Z

+With mesh lines overlaid:
+```@example makie-1d
+plot(pd["scalar"])
+plot!(Trixi.getmesh(pd))
+```


Since we allow plot_mesh = true for oter plot types, we should do so for 1D plots as well, shouldn't we? Could you please update the code such that the following extended example works as well? Note that getmesh is exported by Trixi.jl, so we do not need to prepend it by Trixi..

Suggested change

With mesh lines overlaid:

```@example makie-1d

plot(pd["scalar"])

plot!(Trixi.getmesh(pd))

```

With mesh lines overlaid:

```@example makie-1d

plot(pd["scalar"])

plot!(getmesh(pd))

```

Alternatively, you can also pass the keyword argument `plot_mesh = true`:

```@example makie-1d

plot(pd["scalar"], plot_mesh = true)

```

ranocha · 2026-06-04T18:09:32Z

+With mesh overlay:
+```@example makie-2d
+plot(pd, plot_mesh = true)
+```


Suggested change

With mesh overlay:

```@example makie-2d

plot(pd, plot_mesh = true)

```

With mesh overlay:

```@example makie-2d

plot(pd, plot_mesh = true)

```

Note that `plot!(getmesh(pd))` only plots the mesh in the currently active axis, e.g.,

```@example makie-2d

plot(pd)

plot!(getmesh(pd))

```

ranocha · 2026-06-04T18:09:51Z

+plot(pd, plot_mesh = true)
+```
+
+A key advantage of Makie over Plots.jl is the ability to compose plots on a custom axis,


Suggested change

A key advantage of Makie over Plots.jl is the ability to compose plots on a custom axis,

A key advantage of Makie.jl over Plots.jl is the ability to compose plots on a custom axis,

ranocha · 2026-06-04T18:10:10Z

+                aspect = DataAspect())
+plt = plot!(ax, pd["rho"], colormap = :berlin)
+Colorbar(fig[1, 2], colormap = :berlin)
+plot!(Trixi.getmesh(pd))


Suggested change

plot!(Trixi.getmesh(pd))

plot!(getmesh(pd))

ranocha · 2026-06-04T18:26:20Z


+    # single-variable plot with axis and colorbar (works for all PlotData2DTriangulated meshes)
+    pd = PlotData2D(sol)
+    fap = Makie.plot(pd["rho"])


Suggested change

fap = Makie.plot(pd["rho"])

fap = @trixi_test_nowarn Makie.plot(pd["rho"])

ranocha · 2026-06-04T18:26:28Z

+    @trixi_test_nowarn Makie.plot(pd["rho"], plot_mesh = true)
+
+    # explicit PlotMesh overlay (works for all PlotData2DTriangulated meshes)
+    Makie.plot(pd["rho"])


Suggested change

Makie.plot(pd["rho"])

@trixi_test_nowarn Makie.plot(pd["rho"])

ranocha · 2026-06-04T18:26:40Z

+    # explicit PlotMesh overlay (works for all PlotData2DTriangulated meshes)
+    Makie.plot(pd["rho"])
+    @trixi_test_nowarn Makie.plot!(Trixi.PlotMesh(pd))
+    Makie.plot(pd["rho"])


Suggested change

Makie.plot(pd["rho"])

@trixi_test_nowarn Makie.plot(pd["rho"])

ranocha · 2026-06-04T18:26:50Z

+
+    # explicit PlotMesh overlay (works for all PlotData2DTriangulated meshes)
+    Makie.plot(pd["rho"])
+    @trixi_test_nowarn Makie.plot!(Trixi.PlotMesh(pd))


Suggested change

@trixi_test_nowarn Makie.plot!(Trixi.PlotMesh(pd))

@trixi_test_nowarn Makie.plot!(getmesh(pd))

ranocha · 2026-06-04T18:26:59Z

+    Makie.plot(pd["rho"])
+    @trixi_test_nowarn Makie.plot!(Trixi.PlotMesh(pd))
+    Makie.plot(pd["rho"])
+    @trixi_test_nowarn Makie.plot!(Trixi.PlotMesh(pd), color = :black,


Suggested change

@trixi_test_nowarn Makie.plot!(Trixi.PlotMesh(pd), color = :black,

@trixi_test_nowarn Makie.plot!(getmesh(pd), color = :black,

…Trixi.jl into plotting_support_for_Makie_2d

vincmarks added 3 commits June 2, 2026 17:25

add 2D support for Makie

f361cdc

fromat

7aae8e8

Merge branch 'trixi-framework:main' into plotting_support_for_Makie_2d

820666f

JoshuaLampert mentioned this pull request Jun 2, 2026

Update plotting support for Makie to preferred Makie workflow #1872

Open

3 tasks

ranocha reviewed Jun 2, 2026

View reviewed changes

vincmarks added 2 commits June 3, 2026 12:04

add runnable documentation examples and tests

1372813

Merge branch 'main' into plotting_support_for_Makie_2d

3f91bd0

Merge branch 'main' into plotting_support_for_Makie_2d

eaac845

vincmarks marked this pull request as ready for review June 4, 2026 17:30

Merge branch 'main' into plotting_support_for_Makie_2d

d7e2fc0

ranocha added documentation Improvements or additions to documentation visualization labels Jun 4, 2026

ranocha linked an issue Jun 4, 2026 that may be closed by this pull request

Update plotting support for Makie to preferred Makie workflow #1872

Open

3 tasks

ranocha requested changes Jun 4, 2026

View reviewed changes

vincmarks added 9 commits June 7, 2026 23:12

address reviewer comments

fe8edad

Merge branch 'plotting_support_for_Makie_2d' of github.com:vincmarks/…

3ebc9c5

…Trixi.jl into plotting_support_for_Makie_2d

Load CairoMakie to enable Makie extention

9de3335

Merge branch 'main' into plotting_support_for_Makie_2d

f382f56

Move iplot docstring to main module for Documenter

63b9ea1

Merge branch 'plotting_support_for_Makie_2d' of github.com:vincmarks/…

1cd8f3c

…Trixi.jl into plotting_support_for_Makie_2d

format

adc7506

add test 1D

4652d08

Merge branch 'main' into plotting_support_for_Makie_2d

28a675d

	interactive surface plots via `iplot` for all supported 2D mesh types.
	interactive surface plots via [`iplot`](@ref) for all supported 2D mesh types.

	A key advantage of Makie over Plots.jl is the ability to compose plots on a custom axis,
	A key advantage of Makie.jl over Plots.jl is the ability to compose plots on a custom axis,

	fap = Makie.plot(pd["rho"])
	fap = @trixi_test_nowarn Makie.plot(pd["rho"])

	Makie.plot(pd["rho"])
	@trixi_test_nowarn Makie.plot(pd["rho"])

	@trixi_test_nowarn Makie.plot!(Trixi.PlotMesh(pd))
	@trixi_test_nowarn Makie.plot!(getmesh(pd))

Conversation

vincmarks commented Jun 2, 2026

Changes

Example

Uh oh!

github-actions Bot commented Jun 2, 2026

Review checklist

Purpose and scope

Code quality

Documentation

Testing

Performance

Verification

Uh oh!

codecov Bot commented Jun 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ranocha commented Jun 3, 2026

Uh oh!

vincmarks commented Jun 4, 2026

Uh oh!

ranocha left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented Jun 2, 2026 •

edited

Loading