Merge branch 'main' into jc/isoparametric_cut_cell

jlchan · Jan 8, 2024 · db5462c · db5462c
2 parents d8fe5f5 + 1c0cfe7
commit db5462c
Show file tree

Hide file tree

Showing 13 changed files with 588 additions and 41 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "StartUpDG"
 uuid = "472ebc20-7c99-4d4b-9470-8fde4e9faa0f"
 authors = ["Jesse Chan", "Yimin Lin"]
-version = "0.17.5"
+version = "0.17.7"
 
 [deps]
 ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
@@ -23,10 +23,16 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Triangulate = "f7e6ffb2-c36d-4f8f-a77e-16e897189344"
 WriteVTK = "64499a7a-5c06-52f2-abe2-ccb03c286192"
 
+[weakdeps]
+SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
+
+[extensions]
+StartUpDGSummationByPartsOperatorsExt = "SummationByPartsOperators"
+
 [compat]
 ConstructionBase = "1"
 FillArrays = "0.13, 1"
-HDF5 = "0.16"
+HDF5 = "0.16, 0.17"
 Kronecker = "0.5"
 NodesAndModes = "0.9"
 PathIntersections = "0.1"
@@ -37,6 +43,10 @@ Requires = "1"
 Setfield = "1"
 SimpleUnPack = "1"
 StaticArrays = "1"
+SummationByPartsOperators = "0.5"
 Triangulate = "2"
 WriteVTK = "1"
 julia = "1.7"
+
+[extras]
+SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -4,6 +4,6 @@ DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
 StartUpDG = "472ebc20-7c99-4d4b-9470-8fde4e9faa0f"
 
 [compat]
-Documenter = "0.25, 0.26, 0.27"
+Documenter = "0.25, 0.26, 0.27, 1"
 DocumenterTools = "0.1"
 StartUpDG = "0.17"
diff --git a/docs/src/RefElemData.md b/docs/src/RefElemData.md
@@ -72,9 +72,22 @@ By default, `RefElemData` is constructed for a nodal basis (in order to facilita
 
 ## `RefElemData` based on SBP finite differences
 
-It is also possible to construct a [`RefElemData`](@ref) based on [multi-dimensional SBP finite difference operators](https://doi.org/10.1137/15M1038360). These utilize nodes constructed by [Tianheng Chen and Chi-Wang Shu](https://doi.org/10.1016/j.jcp.2017.05.025), [Ethan Kubatko](https://sites.google.com/site/chilatosu/ethan-bio), and [Jason Hicken](https://doi.org/10.1007/s10915-020-01154-8).
+It is also possible to construct a [`RefElemData`](@ref) based on both traditional finite difference SBP operators and [multi-dimensional SBP finite difference operators](https://doi.org/10.1137/15M1038360). The traditional finite difference SBP operators are built using [SummationByPartsOperators.jl](https://github.com/ranocha/SummationByPartsOperators.jl). The multi-dimensional SBP operators utilize nodes constructed by [Tianheng Chen and Chi-Wang Shu](https://doi.org/10.1016/j.jcp.2017.05.025), [Ethan Kubatko](https://sites.google.com/site/chilatosu/ethan-bio), and [Jason Hicken](https://doi.org/10.1007/s10915-020-01154-8). 
 
-Some examples:
+Some examples of traditional finite difference SBP operators on tensor product domains:
+```julia
+using StartUpDG
+using SummationByPartsOperators # this package must be loaded to enable extension
+
+D = derivative_operator(MattssonNordström2004(), 
+                        derivative_order=1, accuracy_order=N+1,
+                        xmin=-1.0, xmax=1.0, N=20)
+
+rd = RefElemData(Line(), D) 
+rd = RefElemData(Quad(), D)
+rd = RefElemData(Hex(), D)
+```
+Some examples of multi-dimensional SBP operators:
 ```julia
 N = 3
 rd = RefElemData(Quad(), SBP(), N) # defaults to SBP{TensorProductLobatto}