add docstring

jlchan · May 16, 2024 · 3f717ba · 3f717ba
1 parent 2a857d9
commit 3f717ba
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/cut_cell_meshes.jl b/src/cut_cell_meshes.jl
@@ -1009,6 +1009,17 @@ function MeshData(rd::RefElemData, objects,
 
 end
 
+"""
+    hybridized_SBP_operators(md::MeshData{2, <:CutCellMesh})
+
+This constructs hybridized SBP operators using the approach taken in Chan (2019), 
+"Skew-Symmetric Entropy Stable Modal Discontinuous Galerkin Formulations". 
+[https://doi.org/10.1007/s10915-019-01026-w](https://doi.org/10.1007/s10915-019-01026-w)
+
+This function returns `hybridized_operators::Vector{Tuple{<:Matrix, <:Matrix}}` and 
+`project_and_interp_operators, projection_operators, interpolation_operators`, which are 
+all `Vector{<:Matrix}`, where each entry corresponds to a cut element.
+"""
 function hybridized_SBP_operators(md::MeshData{2, <:CutCellMesh})
     mt = md.mesh_type
     (; volume_interpolation_matrices,