Skip to content

Commit 88bcab9

Browse files
committed
update docs
1 parent 734eb88 commit 88bcab9

File tree

2 files changed

+22
-18
lines changed

2 files changed

+22
-18
lines changed

docs/src/post.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Plotting
44

55
Plotting can be performed using the package [GridVisualize.jl](https://github.com/WIAS-PDELib/GridVisualize.jl).
6-
This package extends the API with a couple of methods:
6+
This package extends the API with a couple of methods for systems:
77

88
```@docs
99
GridVisualize.gridplot
@@ -37,9 +37,9 @@ nodevolumes
3737
## Solution integrals
3838
```@docs
3939
VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, tf::Vector, U::AbstractMatrix; kwargs...)
40-
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}
40+
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}
4141
VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, U::AbstractMatrix; kwargs...)
42-
VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, F::Function, U::AbstractMatrix; boundary, data)
42+
VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, F, U::AbstractMatrix; boundary, data)
4343
VoronoiFVM.edgeintegrate
4444
```
4545

src/vfvm_postprocess.jl

+19-15
Original file line numberDiff line numberDiff line change
@@ -124,28 +124,18 @@ end
124124

125125
############################################################################
126126
"""
127-
$(SIGNATURES)
127+
nodeflux(system, F,U; data)
128128
129129
Reconstruction of an edge function as vector function on the nodes of the
130130
triangulation. The result can be seen as a piecewiesw linear vector
131131
function in the FEM space spanned by the discretization nodes exhibiting
132132
the flux density.
133133
134134
The reconstruction is based on the "magic formula"
135-
R. Eymard, T. Gallouet, R. Herbin, IMA Journal of Numerical Analysis (2006)
136-
26, 326−353, Lemma 2.4 .
135+
R. Eymard, T. Gallouët, R. Herbin, IMA Journal of Numerical Analysis (2006)
136+
26, 326−353, Lemma 2.4 (also: [hal.science/hal-00004840](https://hal.science/hal-00004840) ).
137137
138-
The return value is a `dim x nspec x nnodes` vector. The flux of species i
139-
can e.g. plotted via GridVisualize.vectorplot.
140-
141-
Example:
142-
```julia
143-
ispec=3
144-
vis=GridVisualizer(Plotter=Plotter)
145-
scalarplot!(vis,grid,solution[ispec,:],clear=true,colormap=:summer)
146-
vectorplot!(vis,grid,nf[:,ispec,:],clear=false)
147-
reveal(vis)
148-
```
138+
The return value is a `dim x nspec x nnodes` vector.
149139
150140
CAVEAT: there is a possible unsolved problem with the values at domain
151141
corners in the code. Please see any potential boundary artifacts as a manifestation
@@ -206,10 +196,24 @@ function nodeflux(
206196
end
207197

208198
"""
209-
$(SIGNATURES)
199+
nodeflux(system, U; data)
210200
211201
Reconstruction of the edge flux as vector function on the nodes of the
212202
triangulation. See [`nodeflux(system,F,U;data)`](@ref).
203+
204+
The flux of species i
205+
can e.g. plotted via GridVisualize.vectorplot.
206+
207+
Example:
208+
```julia
209+
ispec=3
210+
vis=GridVisualizer(Plotter=Plotter)
211+
scalarplot!(vis,grid,solution[ispec,:],clear=true,colormap=:summer)
212+
vectorplot!(vis,grid,nf[:,ispec,:],clear=false)
213+
reveal(vis)
214+
```
215+
216+
213217
"""
214218
function nodeflux(
215219
system::AbstractSystem{Tv, Tc, Ti, Tm}, U::AbstractArray{Tu, 2};

0 commit comments

Comments
 (0)