Extend VoronoiFVM to incorporate FEM-computed velocity fields provided by ExtendableFEM

CITATION.cff

@@ -12,6 +12,8 @@ authors:
     orcid: 'https://orcid.org/0000-0003-4432-2434'
   - given-names: Patrick
     family-names: Jaap
+  - given-names: Daniel
+    family-names: Runge
   - given-names: Dilara
     family-names: Abdel
   - given-names: Jan
@@ -25,5 +27,3 @@ authors:
 doi: "10.5281/zenodo.3529808"
 license: MIT
 repository-code: "https://github.com/j-fu/VoronoiFVM.jl"
-
-

Project.toml

@@ -1,7 +1,7 @@
 name = "VoronoiFVM"
 uuid = "82b139dc-5afc-11e9-35da-9b9bdfd336f3"
-authors = ["Jürgen Fuhrmann <[email protected]>", "Patrick Jaap", "Dilara Abdel", "Jan Weidner", "Alexander Seiler", "Patricio Farrell", "Matthias Liero"]
-version = "2.0.2"
+authors = ["Jürgen Fuhrmann <[email protected]>", "Patrick Jaap", "Daniel Runge", "Dilara Abdel", "Jan Weidner", "Alexander Seiler", "Patricio Farrell", "Matthias Liero"]
+version = "2.1"
 
 [deps]
 BandedMatrices = "aae01518-5342-5314-be14-df237901396f"
@@ -28,13 +28,20 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
 
+[weakdeps]
+ExtendableFEMBase = "12fb9182-3d4c-4424-8fd1-727a0899810c"
+
+[extensions]
+VoronoiFVMExtendableFEMBaseExt = "ExtendableFEMBase"
+
 [compat]
 BandedMatrices = "0.17,1"
 Colors = "0.12"
 CommonSolve = "0.2"
 DiffResults = "1"
 DocStringExtensions = "0.8,0.9"
-ExtendableGrids = "1.9.2"
+ExtendableFEMBase = "0.7.0"
+ExtendableGrids = "1.10.1"
 ExtendableSparse = "1.5.1"
 ForwardDiff = "0.10.35"
 GridVisualize = "0.5.2,0.6.1,1"

docs/Project.toml

@@ -9,6 +9,8 @@ DiffResults = "163ba53b-c6d8-5494-b064-1a9d43ac40c5"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 ExampleJuggler = "3bbe58f8-ed81-4c4e-a134-03e85fcf4a1a"
+ExtendableFEM = "a722555e-65e0-4074-a036-ca7ce79a4aed"
+ExtendableFEMBase = "12fb9182-3d4c-4424-8fd1-727a0899810c"
 ExtendableGrids = "cfc395e8-590f-11e8-1f13-43a2532b2fa8"
 ExtendableSparse = "95c220a8-a1cf-11e9-0c77-dbfce5f500b3"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"

docs/make.jl

@@ -1,6 +1,8 @@
 using Documenter, ExampleJuggler, PlutoStaticHTML, VoronoiFVM, DocumenterCitations
 using ExtendableGrids, GridVisualize, LinearAlgebra, RecursiveArrayTools, SciMLBase
 
+using ExtendableFEMBase, ExtendableFEM
+
 using OrdinaryDiffEqBDF, OrdinaryDiffEqLowOrderRK, OrdinaryDiffEqRosenbrock, OrdinaryDiffEqSDIRK, OrdinaryDiffEqTsit5 
 
 function make(; with_examples = true,
@@ -33,7 +35,8 @@ function make(; with_examples = true,
             "misc.md",
             "internal.md",
             "allindex.md",
-            "devel.md",]
+            "devel.md",
+            "extensions.md"]
     ]
 
 
@@ -65,10 +68,14 @@ function make(; with_examples = true,
         push!(pages, "Examples" => module_examples)
     end
 
-    makedocs(; sitename = "VoronoiFVM.jl",
-             modules = [VoronoiFVM],
-             plugins = [bib],
-             checkdocs = :all,
+    makedocs(; sitename="VoronoiFVM.jl",
+             modules=[
+                 VoronoiFVM,
+                 # define extension modules manually: https://github.com/JuliaDocs/Documenter.jl/issues/2124#issuecomment-1557473415
+                 Base.get_extension(VoronoiFVM, :VoronoiFVMExtendableFEMBaseExt)
+             ],
+             plugins=[bib],
+             checkdocs=:all,
              clean = false,
              doctest = false,
              authors = "J. Fuhrmann",

docs/src/extensions.md

@@ -0,0 +1,9 @@
+# [`ExtendableFEMBase`](https://github.com/chmerdon/ExtendableFEMBase.jl/) Extension
+
+The extension for [`ExtendableFEMBase`](https://github.com/chmerdon/ExtendableFEMBase.jl/) extends the functions below for solution types of [`ExtendableFEM`](https://github.com/chmerdon/ExtendableFEM.jl/).
+The name of the extension originates from the solution type `FEVectorBlock` that is defined in `ExtendableFEMBase`.
+
+```@docs
+edgevelocities(grid::ExtendableGrid, vel::FEVectorBlock; kwargs...)
+bfacevelocities(grid::ExtendableGrid, vel::FEVectorBlock; kwargs...)
+```

docs/src/internal.md

@@ -121,6 +121,8 @@ prepare_diffeq!
 
 ## Misc tools
 ```@docs
+VoronoiFVM.integrate(::Type{<:Cartesian2D}, coordl, coordr, hnormal, velofunc; kwargs...)
+VoronoiFVM.integrate(::Type{<:Cylindrical2D}, coordl, coordr, hnormal, velofunc; kwargs...)
 VoronoiFVM.doolittle_ludecomp!
 VoronoiFVM.doolittle_lusolve!
 VoronoiFVM.bernoulli_horner

docs/src/post.md

@@ -36,7 +36,10 @@ nodevolumes
 
 ## Solution integrals
 ```@docs
-VoronoiFVM.integrate
+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, U::AbstractMatrix; kwargs...)
+VoronoiFVM.integrate(system::VoronoiFVM.AbstractSystem, F::Function, U::AbstractMatrix; boundary, data)
 VoronoiFVM.edgeintegrate
 ```