add ScalarPlotData2D docstring (#1145)

Co-authored-by: Jesse Chan <[email protected]>
trixi-framework · May 26, 2022 · 29f81e5 · 29f81e5
1 parent b6d801c
commit 29f81e5
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/visualization/types.jl b/src/visualization/types.jl
@@ -406,6 +406,12 @@ struct ScalarData{T}
   data::T
 end
 
+"""
+    ScalarPlotData2D(u, semi::AbstractSemidiscretization; kwargs...)
+
+Returns an `PlotData2DTriangulated` object which is used to visualize a single scalar field.
+`u` should be an array whose entries correspond to values of the scalar field at nodal points.
+"""
 ScalarPlotData2D(u, semi::AbstractSemidiscretization; kwargs...) =
   ScalarPlotData2D(u, mesh_equations_solver_cache(semi)...; kwargs...)