annotate src/SbpOperators/volumeops/derivatives/second_derivative.jl @ 989:7bf3121c6864 feature/stencil_set_type

Add type StencilSet
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Thu, 17 Mar 2022 21:31:20 +0100
parents 2ae62dbaf839
children b6238afd3bb0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
623
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
1 """
820
b4acd25943f4 Remove some more types and type parameters
Jonatan Werpers <jonatan@werpers.com>
parents: 776
diff changeset
2 second_derivative(grid::EquidistantGrid, inner_stencil, closure_stencils, direction)
623
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
3
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
4 Creates the second-derivative operator `D2` as a `TensorMapping`
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
5
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
6 `D2` approximates the second-derivative d²/dξ² on `grid` along the coordinate dimension specified by
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
7 `direction`, using the stencil `inner_stencil` in the interior and a set of stencils `closure_stencils`
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
8 for the points in the closure regions.
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
9
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
10 On a one-dimensional `grid`, `D2` is a `VolumeOperator`. On a multi-dimensional `grid`, `D2` is the outer product of the
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
11 one-dimensional operator with the `IdentityMapping`s in orthogonal coordinate dirrections.
947
38d1752a9aff Reformat "See also:"
Jonatan Werpers <jonatan@werpers.com>
parents: 936
diff changeset
12
38d1752a9aff Reformat "See also:"
Jonatan Werpers <jonatan@werpers.com>
parents: 936
diff changeset
13 See also: [`volume_operator`](@ref).
623
914428a1fc61 Add documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 619
diff changeset
14 """
820
b4acd25943f4 Remove some more types and type parameters
Jonatan Werpers <jonatan@werpers.com>
parents: 776
diff changeset
15 function second_derivative(grid::EquidistantGrid, inner_stencil, closure_stencils, direction)
611
e71f2f81b5f8 NOT WORKING: Draft implementation of VolumeOperator and make SecondDerivative specialize it. Reformulate Laplace for the new SecondDerivative.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 548
diff changeset
16 h_inv = inverse_spacing(grid)[direction]
619
332f65c1abf3 Remove export of BoundaryOperator and VolumeOperator
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 618
diff changeset
17 return SbpOperators.volume_operator(grid, scale(inner_stencil,h_inv^2), scale.(closure_stencils,h_inv^2), even, direction)
356
0844069ab5ff Reinclude SbpOperators and fix most of the code and tests there.
Jonatan Werpers <jonatan@werpers.com>
parents: 348
diff changeset
18 end
964
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
19 second_derivative(grid::EquidistantGrid{1}, inner_stencil::Stencil, closure_stencils) = second_derivative(grid,inner_stencil,closure_stencils,1)
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
20
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
21 """
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
22 second_derivative(grid, stencil_set, direction)
952
6a8d7fbf55fc Review: Stencil set method for second_derivative?
Jonatan Werpers <jonatan@werpers.com>
parents: 947
diff changeset
23
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
24 Creates a `second_derivative` operator on `grid` along coordinate dimension `direction` given a `stencil_set`.
964
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
25 """
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
26 function second_derivative(grid::EquidistantGrid, stencil_set::StencilSet, direction)
964
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
27 inner_stencil = parse_stencil(stencil_set["D2"]["inner_stencil"])
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
28 closure_stencils = parse_stencil.(stencil_set["D2"]["closure_stencils"])
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
29 second_derivative(grid,inner_stencil,closure_stencils,direction);
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
30 end
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
31
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
32 # TODO: Not possible to remove ::Stencil from second_derivative(grid::EquidistantGrid{1},...) due to type deduction failing.
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
33 # Is this due to the type ambuguity of StencilSet? Possible to address in some other way?
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
34 # If not, should we drop ::StencilSet from the method above (it is not required)?