Merge pull request #65 from WIAS-PDELib/feature/slice-line-plot

Add high level methods for sliceplot and lineplot

Author: pjaap

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.11.0] - 2025-03-04
+
+### Added
+
+ - New key word argument `slice` for `scalarplot` to extract a `dim-1` scalar plot along a slice definition.
+   The slice can be provided as an expression `slice = :(x + 2y - 4)` constrained by zero, or as a pair `slice = :x => 3`
+   to fix a certain value of one axis.
+
 ## [1.10.0] - 2025-01-20
 
 ### Added

Project.toml

@@ -1,7 +1,7 @@
 name = "GridVisualize"
 uuid = "5eed8a63-0fb0-45eb-886d-8d5a387d12b8"
 authors = ["Juergen Fuhrmann <[email protected]>", "Patrick Jaap <[email protected]>"]
-version = "1.10.0"
+version = "1.11.0"
 
 [deps]
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
@@ -39,7 +39,7 @@ ElasticArrays = "1"
 ExtendableGrids = "1.10"
 GLMakie = "0.9, 0.10, 0.11"
 GeometryBasics = "0.4.1, 0.5"
-GridVisualizeTools = "2"
+GridVisualizeTools = "3"
 HypertextLiteral = "0.9"
 Interpolations = "0.14, 0.15"
 IntervalSets = "0.7"

docs/makeplots.jl

@@ -24,6 +24,18 @@ function makeplots(picdir; Plotter = GLMakie, extension = "png")
     @test isfile(fname)
     println("func3d")
 
+    p = plotting_slice3d(; Plotter = Plotter)
+    fname = joinpath(picdir, "plotting_slice3d." * extension)
+    save(fname, p; Plotter = Plotter)
+    @test isfile(fname)
+    println("slice3d")
+
+    p = plotting_line2d(; Plotter = Plotter)
+    fname = joinpath(picdir, "plotting_line2d." * extension)
+    save(fname, p; Plotter = Plotter)
+    @test isfile(fname)
+    println("line2d")
+
     fname = joinpath(picdir, "plotting_jfunc1d." * "gif")
     p = plotting_jfunc1d(; Plotter = Plotter, filename = fname)
     @test isfile(fname)

docs/src/privapi.md

@@ -6,7 +6,7 @@
 Modules = [GridVisualize]
 Private = true
 Public = false
-Pages = ["dispatch.jl","common.jl"]
+Pages = ["dispatch.jl","common.jl","slice_plots.jl"]
 ```
 
 ```@docs
@@ -43,7 +43,7 @@ FlippableLayout
 Modules = [GridVisualize]
 Private = true
 Public = false
-Pages = ["plots.jl"]
+Pages = [joinpath("src","plots.jl")] # https://github.com/JuliaDocs/Documenter.jl/issues/2639
 ```
 
 ## VTKView
@@ -53,3 +53,8 @@ Private = true
 Public = false
 Pages = ["vtkview.jl"]
 ```
+
+## Internals
+```@docs
+GridVisualize.ImplEvalSlice
+```

examples/plotting.jl

@@ -110,6 +110,59 @@ function plotting_func3d(;
 end
 # ![](plotting_func3d.svg)
 
+# ## d-1 dim slice in d-dim data
+# ### 2D slice of a 3D grid
+#
+# You can plot a 2D slice of a function defined on a
+# 3D grid by providing a `slice` key word argument which
+# describes a plane equation of a fixed value to one axis.
+#
+# The example shows a plot for a fixed axis y = 0.5.
+# Note that labeling the other axes may be useful
+function plotting_slice3d(;
+        Plotter = default_plotter(),
+        slice = :y => 0.5,
+        xlabel = "x",
+        ylabel = "z",
+        kwargs...,
+    )
+    g, f = func3d()
+    return scalarplot(g, f; Plotter, slice, xlabel, ylabel, kwargs...)
+end
+# ![](plotting_slice3d.svg)
+
+
+# ### 1D line of a 2D grid
+#
+# You can plot a 1D line of a function defined on a
+# 2D grid by providing a `slice` key word argument which
+# describes a line equation of a fixed value to one axis.
+#
+# The example shows a plot along the diagonal x + y - 1 = 0
+# Note that you should provide meaningful axes labels
+function plotting_line2d(;
+        Plotter = default_plotter(),
+        slice = :(x + y - 1),
+        xlabel = "line",
+        ylabel = "value",
+        kwargs...,
+    )
+    g, f = func2d()
+    return scalarplot(g, f; Plotter, slice, xlabel, ylabel, kwargs...)
+end
+# ![](plotting_line2d.svg)
+
+
+#
+# Plotting a function then goes as follows:
+# `xplane`, `yplane` and `zplane` now define cut planes where
+# the function projection is plotted as a heatmap.
+# The additional `flevel` keyword argument allows
+# to control an isolevel.
+#
+# For Makie and VTKView, the cutplane values and the flevel can be controlled interactively.
+
+
 # ## Vector and stream plots
 # ### 2D vector
 function vec2d(; n = 20)