annotate src/SbpOperators/boundaryops/boundary_restriction.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 08f06bfacd5c
children 65b2d2c72fbc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
510
db64cfe4d9de Start sketching on 1D boundary restriction operators.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
1 """
1329
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1281
diff changeset
2 boundary_restriction(g, stencil_set::StencilSet, boundary)
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1281
diff changeset
3 boundary_restriction(g::TensorGrid, stencil_set::StencilSet, boundary::TensorGridBoundary)
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1281
diff changeset
4 boundary_restriction(g::EquidistantGrid, stencil_set::StencilSet, boundary)
580
0779713f95a2 Add constructor that infers T and N
Jonatan Werpers <jonatan@werpers.com>
parents: 579
diff changeset
5
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 966
diff changeset
6 Creates boundary restriction operators `e` as `LazyTensor`s on `boundary`
510
db64cfe4d9de Start sketching on 1D boundary restriction operators.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
7
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
8 `e` restricts a grid function on `g` to `boundary` using the 'e' stencil
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
9 in `stencil_set`. `e'` prolongates a grid function on
1329
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1281
diff changeset
10 `boundary` to the whole grid using the same stencil. On a one-dimensional
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1281
diff changeset
11 grid, `e` is a `BoundaryOperator`. On a multi-dimensional grid, `e` is the
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1281
diff changeset
12 inflation of a `BoundaryOperator`.
947
38d1752a9aff Reformat "See also:"
Jonatan Werpers <jonatan@werpers.com>
parents: 936
diff changeset
13
1104
c0ab81e4c39c Update docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1100
diff changeset
14 See also: [`BoundaryOperator`](@ref), [`LazyTensors.inflate`](@ref).
610
e40e7439d1b4 Add a general boundary operator and make BoundaryRestriction a specialization of it.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 588
diff changeset
15 """
1329
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1281
diff changeset
16 function boundary_restriction end
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1281
diff changeset
17
1281
1cc45207817e Fix tests for boundary operator and boundary restriction
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
18 function boundary_restriction(g::TensorGrid, stencil_set::StencilSet, boundary::TensorGridBoundary)
1cc45207817e Fix tests for boundary operator and boundary restriction
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
19 op = boundary_restriction(g.grids[grid_id(boundary)], stencil_set, boundary_id(boundary))
1cc45207817e Fix tests for boundary operator and boundary restriction
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
20 return LazyTensors.inflate(op, size(g), grid_id(boundary))
827
beae513ef8b3 Fix bug in boundary_restriction when grids and stencil does not have matching type
Jonatan Werpers <jonatan@werpers.com>
parents: 777
diff changeset
21 end
925
6b47a9ee1632 Add functionality for creating operators from a stencil set. Note: Tests are not updated yet!
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 871
diff changeset
22
1281
1cc45207817e Fix tests for boundary operator and boundary restriction
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
23 function boundary_restriction(g::EquidistantGrid, stencil_set::StencilSet, boundary)
1cc45207817e Fix tests for boundary operator and boundary restriction
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
24 closure_stencil = parse_stencil(stencil_set["e"]["closure"])
1cc45207817e Fix tests for boundary operator and boundary restriction
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
25 converted_stencil = convert(Stencil{eltype(g)}, closure_stencil)
1cc45207817e Fix tests for boundary operator and boundary restriction
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
26 return BoundaryOperator(g, converted_stencil, boundary)
1cc45207817e Fix tests for boundary operator and boundary restriction
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
27 end