Merge pull request #55 from j-fu/jf-partitiondocs

Jf partitiondocs
WIAS-PDELib · Jul 19, 2024 · 4badf7b · 4badf7b
2 parents 4659905 + 5ce96cf
commit 4badf7b
Show file tree

Hide file tree

Showing 8 changed files with 2,007 additions and 41 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -6,11 +6,17 @@ ExtendableGrids = "cfc395e8-590f-11e8-1f13-43a2532b2fa8"
 Gmsh = "705231aa-382f-11e9-3f0c-b7cb4346fdeb"
 GridVisualize = "5eed8a63-0fb0-45eb-886d-8d5a387d12b8"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
+Metis = "2679e427-3c69-5b7f-982b-ece356f1e94b"
+Pluto = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
+PlutoStaticHTML = "359b1769-a58e-495b-9770-312e911026ad"
+PlutoUI = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
+Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
 SimplexGridFactory = "57bfcd06-606e-45d6-baf4-4ba06da0efd5"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Triangulate = "f7e6ffb2-c36d-4f8f-a77e-16e897189344"
 
 [compat]
+CairoMakie = "0.12"
 Documenter = "1"
-julia = "1.9"
 ExampleJuggler = "2"
-CairoMakie = "0.12"
+julia = "1.9"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,19 +1,32 @@
-using Documenter, ExtendableGrids, ExampleJuggler, Gmsh
-import CairoMakie
+using Documenter, ExtendableGrids, ExampleJuggler
+import Gmsh
+import CairoMakie, Pluto, PlutoStaticHTML
 CairoMakie.activate!(; type = "png", visible = false)
 ExampleJuggler.verbose!(true)
 ExtendableGridsGmshExt=Base.get_extension(ExtendableGrids, :ExtendableGridsGmshExt)
 function mkdocs()
     cleanexamples()
-    generated_examples = @docscripts(joinpath(@__DIR__, "..", "examples"),
+    exampledir=joinpath(@__DIR__, "..", "examples")
+
+    generated_examples = @docscripts(exampledir,
                                      ["examples1d.jl", "examples2d.jl", "examples3d.jl", "gmsh.jl"],
                                      Plotter=CairoMakie)
+
+    notebooks = ["Partitioning" =>   "pluto-partitioning.jl"]
+    notebook_examples = @docplutonotebooks(exampledir, notebooks, iframe=false)
+    size_threshold_ignore = last.(notebook_examples)
+
+    generated_examples=vcat(generated_examples, notebook_examples)
+
     makedocs(; sitename = "ExtendableGrids.jl",
              modules = [ExtendableGrids,ExtendableGridsGmshExt],
              clean = false,
              doctest = true,
              authors = "J. Fuhrmann, Ch. Merdon, J. Taraz",
              repo = "https://github.com/j-fu/ExtendableGrids.jl",
+             format = Documenter.HTML(; size_threshold_ignore,
+                                       assets=String["assets/citations.css"],
+                                      mathengine = MathJax3()),
              pages = [
                  "Home" => "index.md",
                  "Changes" => "changes.md",

diff --git a/docs/src/partitioning.md b/docs/src/partitioning.md
@@ -1,14 +1,10 @@
 # Grid partitioning
 
-!!! compat
-    Grid partitioning is an experimental feature. Breaking changes
-    in this realm may occur with minor version updates.
-
-The general idea is that all grids created from ExtendableGrids
+All grids created from ExtendableGrids
 can be considered to be partitioned such that the neighborhood graph  of
 the partitions is colored so that operations (FEM/FVM assembly, sparse matrix-vector multiplication
-with SparseMatrixCSC) on different partitions of the same color can be performed in parallel 
-without writing conflicts in a multithreading environment.
+with SparseMatrixCSC, ILU preconditioners) on different partitions of the same color can be performed in parallel 
+without write conflicts in a multithreading environment.
 
 
 The default partitioning is trivial: all cells and nodes belong to one partition,
@@ -30,7 +26,6 @@ num_nodes_per_partition
 num_edges_per_partition
 num_cells_per_color
 check_partitioning
-ExtendableGrids.induce_edge_partitioning!
 ```
 
 
@@ -65,4 +60,5 @@ ExtendableGrids.partgraph
 ExtendableGrids.dopartition
 ExtendableGrids.reorder_cells
 ExtendableGrids.induce_node_partitioning!
+ExtendableGrids.induce_edge_partitioning!
 ```