Mercurial > repos > public > sbplib_julia

changeset 1619:1937be9502a7 feature/boundary_conditions

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
REVIEW: Minor fixes to doc strings in laplace.jl
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 11 Jun 2024 00:19:09 +0200
parents 77f192b05b1d
children 48596b2f7923
files src/SbpOperators/volumeops/laplace/laplace.jl
diffstat 1 files changed, 13 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/src/SbpOperators/volumeops/laplace/laplace.jl	Tue Jun 11 00:12:06 2024 +0200
+++ b/src/SbpOperators/volumeops/laplace/laplace.jl	Tue Jun 11 00:19:09 2024 +0200
@@ -56,10 +56,11 @@
 """
     sat_tensors(Δ::Laplace, g::Grid, bc::DirichletCondition; H_tuning, R_tuning)
 
-The operators required to construct the SAT for imposing a Dirichlet condition.
-`H_tuning` and `R_tuning` are used to specify the strength of the penalty.
+The operators required to construct the SAT for imposing a Dirichlet
+condition. `H_tuning` and `R_tuning` are used to specify the strength of the
+penalty.
 
-See also: [`sat`](@ref),[`DirichletCondition`](@ref),[`positivity_decomposition`](@ref).
+See also: [`sat`](@ref),[`DirichletCondition`](@ref), [`positivity_decomposition`](@ref).
 """
 function sat_tensors(Δ::Laplace, g::Grid, bc::DirichletCondition; H_tuning = 1., R_tuning = 1.)
     id = boundary(bc)
@@ -76,9 +77,9 @@
 """
     sat_tensors(Δ::Laplace, g::Grid, bc::NeumannCondition)
 
-The operators required to construct the SAT for imposing a Neumann condition
+The operators required to construct the SAT for imposing a Neumann condition.
 
-See also: [`sat`](@ref),[`NeumannCondition`](@ref).
+See also: [`sat`](@ref), [`NeumannCondition`](@ref).
 """
 function sat_tensors(Δ::Laplace, g::Grid, bc::NeumannCondition)
     id = boundary(bc)
@@ -95,11 +96,13 @@
 """
     positivity_decomposition(Δ::Laplace, g::Grid, bc::DirichletCondition; H_tuning, R_tuning)
 
-Constructs the scalar `B` such that `d' - 1/2*B*e'` is symmetric positive definite with respect to
-the boundary quadrature. Here `d` is the normal derivative and `e` is the boundary restriction operator.
-`B` can then be used to form a symmetric and energy stable penalty for a Dirichlet condition.
-The parameters `H_tuning` and `R_tuning` are used to specify the strength of the penalty and
-must be greater than 1. For details we refer to https://doi.org/10.1016/j.jcp.2020.109294
+Constructs the scalar `B` such that `d' - 1/2*B*e'` is symmetric positive
+definite with respect to the boundary quadrature. Here `d` is the normal
+derivative and `e` is the boundary restriction operator. `B` can then be used
+to form a symmetric and energy stable penalty for a Dirichlet condition. The
+parameters `H_tuning` and `R_tuning` are used to specify the strength of the
+penalty and must be greater than 1. For details we refer to
+https://doi.org/10.1016/j.jcp.2020.109294
 """
 function positivity_decomposition(Δ::Laplace, g::Grid, bc::DirichletCondition; H_tuning, R_tuning)
     @assert(H_tuning ≥ 1.)