update docs

WIAS-PDELib · Nov 25, 2024 · 88bcab9 · 88bcab9 · j-fu · Nov 25, 2024
1 parent 734eb88
commit 88bcab9
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 18 deletions.
diff --git a/docs/src/post.md b/docs/src/post.md
@@ -3,7 +3,7 @@
 ## Plotting
 
 Plotting can be performed using the package [GridVisualize.jl](https://github.com/WIAS-PDELib/GridVisualize.jl).
-This package extends the API with a couple of methods:
+This package extends the API with a couple of methods for systems:
 
 ```@docs
 GridVisualize.gridplot
@@ -37,9 +37,9 @@ nodevolumes
 ## Solution integrals
 ```@docs
 VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, tf::Vector, U::AbstractMatrix; kwargs...)
-VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem{Tv, Tc, Ti, Tm}, F::Function, U::AbstractMatrix{Tu}; boundary = false, data = system.physics.data) where {Tu, Tv, Tc, Ti, Tm}
+VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem{Tv, Tc, Ti, Tm}, F::Tf, U::AbstractMatrix{Tu}; boundary = false, data = system.physics.data) where {Tu, Tv, Tc, Ti, Tm, Tf}
 VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, U::AbstractMatrix; kwargs...)
-VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, F::Function, U::AbstractMatrix; boundary, data)
+VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, F, U::AbstractMatrix; boundary, data)
 VoronoiFVM.edgeintegrate
 ```
 

diff --git a/src/vfvm_postprocess.jl b/src/vfvm_postprocess.jl
@@ -124,28 +124,18 @@ end
 
 ############################################################################
 """
-$(SIGNATURES)
+    nodeflux(system, F,U; data)
 
 Reconstruction of an edge function as  vector function  on the nodes  of the
 triangulation.  The result  can be seen as a  piecewiesw linear vector
 function in the FEM space spanned by the discretization nodes exhibiting
 the flux density.
 
 The reconstruction is based on the  "magic formula"
-R. Eymard, T. Gallouet, R. Herbin, IMA Journal of Numerical Analysis (2006)
-26, 326−353, Lemma 2.4 .
+R. Eymard, T. Gallouët, R. Herbin, IMA Journal of Numerical Analysis (2006)
+26, 326−353, Lemma 2.4  (also: [hal.science/hal-00004840](https://hal.science/hal-00004840) ).
 
-The return value is a `dim x nspec x nnodes` vector. The flux of species i
-can  e.g. plotted via GridVisualize.vectorplot.
-
-Example:
-```julia
-    ispec=3
-    vis=GridVisualizer(Plotter=Plotter)
-    scalarplot!(vis,grid,solution[ispec,:],clear=true,colormap=:summer)
-    vectorplot!(vis,grid,nf[:,ispec,:],clear=false)
-    reveal(vis)
-```
+The return value is a `dim x nspec x nnodes` vector.
 
 CAVEAT: there is a possible unsolved problem with the values at domain
 corners in the code. Please see any potential boundary artifacts as a manifestation
@@ -206,10 +196,24 @@ function nodeflux(
 end
 
 """
-$(SIGNATURES)
+    nodeflux(system, U; data)
 
 Reconstruction of the edge flux as vector function  on the nodes  of the
 triangulation. See [`nodeflux(system,F,U;data)`](@ref).
+
+ The flux of species i
+can  e.g. plotted via GridVisualize.vectorplot.
+
+Example:
+```julia
+    ispec=3
+    vis=GridVisualizer(Plotter=Plotter)
+    scalarplot!(vis,grid,solution[ispec,:],clear=true,colormap=:summer)
+    vectorplot!(vis,grid,nf[:,ispec,:],clear=false)
+    reveal(vis)
+```
+
+
 """
 function nodeflux(
         system::AbstractSystem{Tv, Tc, Ti, Tm}, U::AbstractArray{Tu, 2};