annotate src/SbpOperators/volumeops/derivatives/second_derivative.jl @ 1104:c0ab81e4c39c refactor/sbpoperators/inflation

Update docs
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Fri, 20 May 2022 11:30:46 +0200
parents 157a78959e5d
children 356ec6a72974
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
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 964
diff changeset
4 Creates the second-derivative operator `D2` as a `LazyTensor`
623
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
1104
c0ab81e4c39c Update docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1100
diff changeset
10 On a one-dimensional `grid`, `D2` is a `VolumeOperator`. On a multi-dimensional `grid`, `D2` is the inflation of
c0ab81e4c39c Update docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1100
diff changeset
11 a `VolumeOperator`.
947
38d1752a9aff Reformat "See also:"
Jonatan Werpers <jonatan@werpers.com>
parents: 936
diff changeset
12
1104
c0ab81e4c39c Update docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1100
diff changeset
13 See also: [`VolumeOperator`](@ref), [`LazyTensors.inflate`](@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]
1099
05a25a5063bb Try to remove volume_operator and boundary_operator methods
Jonatan Werpers <jonatan@werpers.com>
parents: 995
diff changeset
17
05a25a5063bb Try to remove volume_operator and boundary_operator methods
Jonatan Werpers <jonatan@werpers.com>
parents: 995
diff changeset
18 D₂ = VolumeOperator(restrict(grid, direction), scale(inner_stencil,h_inv^2), scale.(closure_stencils,h_inv^2), even)
05a25a5063bb Try to remove volume_operator and boundary_operator methods
Jonatan Werpers <jonatan@werpers.com>
parents: 995
diff changeset
19 return LazyTensors.inflate(D₂, size(grid), direction)
356
0844069ab5ff Reinclude SbpOperators and fix most of the code and tests there.
Jonatan Werpers <jonatan@werpers.com>
parents: 348
diff changeset
20 end
990
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
21
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
22
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
23 """
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
24 second_derivative(grid, inner_stencil, closure_stencils)
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
25
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
26 Creates a `second_derivative` operator on a 1D `grid` given `inner_stencil` and `closure_stencils`.
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
27 """
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
28 second_derivative(grid::EquidistantGrid{1}, inner_stencil::Stencil, closure_stencils) = second_derivative(grid, inner_stencil, closure_stencils,1)
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
29
964
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
30
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
31 """
2ae62dbaf839 Add method for creating second derivative from a stencil set.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 952
diff changeset
32 second_derivative(grid, stencil_set, direction)
952
6a8d7fbf55fc Review: Stencil set method for second_derivative?
Jonatan Werpers <jonatan@werpers.com>
parents: 947
diff changeset
33
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
34 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
35 """
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
36 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
37 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
38 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
39 second_derivative(grid,inner_stencil,closure_stencils,direction);
990
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
40 end
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
41
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 964
diff changeset
42
990
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
43 """
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
44 second_derivative(grid, stencil_set)
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
45
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
46 Creates a `second_derivative` operator on a 1D `grid` given a `stencil_set`.
b6238afd3bb0 Add methods for creating derivative operators in 1D from stencil sets without providing directions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 989
diff changeset
47 """
1036
99d1f5651d0b Remove todo, add ::StencilSet to some methods, and update docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 990
diff changeset
48 second_derivative(grid::EquidistantGrid{1}, stencil_set::StencilSet) = second_derivative(grid, stencil_set, 1)