changeset 1096:9f0121e465a5 feature/dissipation_operators

Docs for undivided_dissipation
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 10 May 2022 21:10:31 +0200
parents 2be39d485221
children 95464a1af340
files src/SbpOperators/volumeops/derivatives/dissipation.jl
diffstat 1 files changed, 8 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/SbpOperators/volumeops/derivatives/dissipation.jl	Tue May 10 20:49:44 2022 +0200
+++ b/src/SbpOperators/volumeops/derivatives/dissipation.jl	Tue May 10 21:10:31 2022 +0200
@@ -1,9 +1,16 @@
-# REVIEW: Add documentation. Also would it be more correct to
+# REVIEW: Would it be more correct to
 # call these undivided_differences instead of dissipation?
 # If I understand it correctly, this method simply provides
 # the operators required in order to compose a dissipation operator
 # and the dissipation operator are formed by a linear combination
 # of the products of Dᵀ and D for different orders.
+"""
+    undivided_dissipation(g::EquidistantGrid, p, direction)
+
+Create undivided difference operators approximating the `p`th derivative for
+building artificial dissipation. The operators and how they are used to create accurate artifical dissipation is described in
+"K. Mattsson, M. Svärd, and J. Nordström, “Stable and Accurate Artificial Dissipation,” Journal of Scientific Computing, vol. 21, no. 1, pp. 57–79, Aug. 2004"
+"""
 function undivided_dissipation(g::EquidistantGrid, p, direction)
     T = eltype(g)
     interior_weights = T.(dissipation_interior_weights(p))