changeset 1618:77f192b05b1d feature/boundary_conditions

REVIEW: Suggest changes to doc strings in sat.jl
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 11 Jun 2024 00:12:06 +0200
parents a00fa58e9fb0
children 1937be9502a7
files src/SbpOperators/boundary_conditions/sat.jl
diffstat 1 files changed, 9 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/src/SbpOperators/boundary_conditions/sat.jl	Tue Jun 11 00:02:15 2024 +0200
+++ b/src/SbpOperators/boundary_conditions/sat.jl	Tue Jun 11 00:12:06 2024 +0200
@@ -1,11 +1,11 @@
 """
-    sat_tensors(op, grid, bc::BoundaryCondition, params...)
+    sat_tensors(op, grid, bc::BoundaryCondition; kwargs...)
 
-The tensor and boundary operator used to construct a simultaneous-approximation-term
-for imposing `bc` related to `op`.
+The penalty tensor and boundary operator used to construct a
+simultaneous-approximation-term for imposing `bc` related to `op`.
 
-For `penalty_tensor, L  = sat_tensors(...)` then `SAT = penalty_tensor*(L*u - g)`  where `g` 
-is the boundary data.
+For `penalty_tensor, L  = sat_tensors(...)` then `SAT(u,g) =
+penalty_tensor*(L*u - g)`  where `g` is the boundary data.
 """
 function sat_tensors end
 
@@ -13,10 +13,11 @@
 """
     sat(op, grid, bc::BoundaryCondition; kwargs...)
 
-Simultaneous-Approximation-Term for a general `bc` to `op`. 
-Returns a function `SAT(u,g)` weakly imposing `bc` when added to `op*u`.
+Simultaneous-Approximation-Term for a general `bc` to `op`. Returns a function
+`SAT(u,g)` weakly imposing `bc` when added to `op*u`.
 
-`op` must implement the function `sat_tensors`.
+Internally `sat_tensors(op, grid, bc; ...)` is called to construct the
+necessary parts for the SAT.
 """
 function sat(op, grid, bc::BoundaryCondition; kwargs...)
     penalty_tensor, L = sat_tensors(op, grid, bc; kwargs...)