Mercurial > repos > public > sbplib_julia
annotate src/SbpOperators/boundary_conditions/sat.jl @ 1685:4aa0973bffb0 feature/grids/manifolds
Restrict the argument types of the simplest equidistant_grid to Number to avoid ambiguity
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Wed, 21 Aug 2024 19:10:37 +0200 |
parents | 77f192b05b1d |
children |
rev | line source |
---|---|
1135
05b1d6fd6401
Add functions for constructing SATs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
1 """ |
1618
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
2 sat_tensors(op, grid, bc::BoundaryCondition; kwargs...) |
1135
05b1d6fd6401
Add functions for constructing SATs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
3 |
1618
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
4 The penalty tensor and boundary operator used to construct a |
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
5 simultaneous-approximation-term for imposing `bc` related to `op`. |
1483
abc5cc0aec94
Update docstrings
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1396
diff
changeset
|
6 |
1618
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
7 For `penalty_tensor, L = sat_tensors(...)` then `SAT(u,g) = |
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
8 penalty_tensor*(L*u - g)` where `g` is the boundary data. |
1135
05b1d6fd6401
Add functions for constructing SATs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
9 """ |
05b1d6fd6401
Add functions for constructing SATs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
10 function sat_tensors end |
05b1d6fd6401
Add functions for constructing SATs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
11 |
1217
ea2e8254820a
Update docstrings and start implementing tests
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1167
diff
changeset
|
12 |
1135
05b1d6fd6401
Add functions for constructing SATs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
13 """ |
1602
3e7438e2a033
Address review comments (1 left to be discussed)
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents:
1599
diff
changeset
|
14 sat(op, grid, bc::BoundaryCondition; kwargs...) |
1135
05b1d6fd6401
Add functions for constructing SATs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
15 |
1618
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
16 Simultaneous-Approximation-Term for a general `bc` to `op`. Returns a function |
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
17 `SAT(u,g)` weakly imposing `bc` when added to `op*u`. |
1217
ea2e8254820a
Update docstrings and start implementing tests
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1167
diff
changeset
|
18 |
1618
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
19 Internally `sat_tensors(op, grid, bc; ...)` is called to construct the |
77f192b05b1d
REVIEW: Suggest changes to doc strings in sat.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
1603
diff
changeset
|
20 necessary parts for the SAT. |
1135
05b1d6fd6401
Add functions for constructing SATs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
21 """ |
1602
3e7438e2a033
Address review comments (1 left to be discussed)
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents:
1599
diff
changeset
|
22 function sat(op, grid, bc::BoundaryCondition; kwargs...) |
3e7438e2a033
Address review comments (1 left to be discussed)
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents:
1599
diff
changeset
|
23 penalty_tensor, L = sat_tensors(op, grid, bc; kwargs...) |
3e7438e2a033
Address review comments (1 left to be discussed)
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents:
1599
diff
changeset
|
24 return SAT(u, g) = penalty_tensor*(L*u - g) |
1599 | 25 end |