Mercurial > repos > public > sbplib_julia

annotate src/SbpOperators/volumeops/derivatives/first_derivative.jl @ 2091:e21c295fb2da refactor/sbp_operators/direction_check

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Restructure methods for equidistant grids with a dim argument
author Jonatan Werpers <jonatan@werpers.com>
date Mon, 02 Mar 2026 15:41:14 +0100
parents 67d8fbbb9e58
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1329
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1291
diff changeset
1 """
2089
1bc63fa55145 Change variable name from `direction` to `dim`
Jonatan Werpers <jonatan@werpers.com>
parents: 2088
diff changeset
2 first_derivative(g, ..., [dim])
1329
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1291
diff changeset
3
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
4 The first derivative operator `D1` as a `LazyTensor` on the given grid.
1329
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1291
diff changeset
5
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1291
diff changeset
6 `D1` approximates the first-derivative d/dξ on `g` along the coordinate
2089
1bc63fa55145 Change variable name from `direction` to `dim`
Jonatan Werpers <jonatan@werpers.com>
parents: 2088
diff changeset
7 dimension specified by `dim`.
1329
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1291
diff changeset
8 """
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1291
diff changeset
9 function first_derivative end
e94ddef5e72f Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
Jonatan Werpers <jonatan@werpers.com>
parents: 1291
diff changeset
10
972
803f60f461c1 Start adding the first derivative
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11 """
2089
1bc63fa55145 Change variable name from `direction` to `dim`
Jonatan Werpers <jonatan@werpers.com>
parents: 2088
diff changeset
12 first_derivative(g::TensorGrid, stencil_set, dim)
972
803f60f461c1 Start adding the first derivative
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13
1104
c0ab81e4c39c Update docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1100
diff changeset
14 See also: [`VolumeOperator`](@ref), [`LazyTensors.inflate`](@ref).
972
803f60f461c1 Start adding the first derivative
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 """
2089
1bc63fa55145 Change variable name from `direction` to `dim`
Jonatan Werpers <jonatan@werpers.com>
parents: 2088
diff changeset
16 function first_derivative(g::TensorGrid, stencil_set, dim)
1bc63fa55145 Change variable name from `direction` to `dim`
Jonatan Werpers <jonatan@werpers.com>
parents: 2088
diff changeset
17 if dim ∉ 1:ndims(g)
2090
67d8fbbb9e58 Update error messages
Jonatan Werpers <jonatan@werpers.com>
parents: 2089
diff changeset
18 throw(DomainError(dim, "Derivative direction must be in 1:$(ndims(g))."))
2080
0f949681d3d3 Check that direction of first/second derivative operators is within the dimension of the grid. Add 1D functions for first/second derivative operators that take a direction.
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1347
diff changeset
19 end
2089
1bc63fa55145 Change variable name from `direction` to `dim`
Jonatan Werpers <jonatan@werpers.com>
parents: 2088
diff changeset
20 D₁ = first_derivative(g.grids[dim], stencil_set)
1bc63fa55145 Change variable name from `direction` to `dim`
Jonatan Werpers <jonatan@werpers.com>
parents: 2088
diff changeset
21 return LazyTensors.inflate(D₁, size(g), dim)
972
803f60f461c1 Start adding the first derivative
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22 end
974
ba023fc09961 Add stencil_set method and accuracy tests
Jonatan Werpers <jonatan@werpers.com>
parents: 972
diff changeset
23
2080
0f949681d3d3 Check that direction of first/second derivative operators is within the dimension of the grid. Add 1D functions for first/second derivative operators that take a direction.
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1347
diff changeset
24
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
25 """
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
26 first_derivative(g::EquidistantGrid, stencil_set::StencilSet)
972
803f60f461c1 Start adding the first derivative
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
27
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
28 The first derivative operator on an `EquidistantGrid`.
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
29 Uses the `D1` stencil in `stencil_set`.
974
ba023fc09961 Add stencil_set method and accuracy tests
Jonatan Werpers <jonatan@werpers.com>
parents: 972
diff changeset
30 """
1291
356ec6a72974 Implement changes in SbpOperators
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
31 function first_derivative(g::EquidistantGrid, stencil_set::StencilSet)
974
ba023fc09961 Add stencil_set method and accuracy tests
Jonatan Werpers <jonatan@werpers.com>
parents: 972
diff changeset
32 inner_stencil = parse_stencil(stencil_set["D1"]["inner_stencil"])
ba023fc09961 Add stencil_set method and accuracy tests
Jonatan Werpers <jonatan@werpers.com>
parents: 972
diff changeset
33 closure_stencils = parse_stencil.(stencil_set["D1"]["closure_stencils"])
1291
356ec6a72974 Implement changes in SbpOperators
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
34 return first_derivative(g, inner_stencil, closure_stencils);
974
ba023fc09961 Add stencil_set method and accuracy tests
Jonatan Werpers <jonatan@werpers.com>
parents: 972
diff changeset
35 end
989
7bf3121c6864 Add type StencilSet
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 974
diff changeset
36
2091
e21c295fb2da Restructure methods for equidistant grids with a dim argument
Jonatan Werpers <jonatan@werpers.com>
parents: 2090
diff changeset
37 function first_derivative(g::EquidistantGrid, stencil_set, dim)
e21c295fb2da Restructure methods for equidistant grids with a dim argument
Jonatan Werpers <jonatan@werpers.com>
parents: 2090
diff changeset
38 if dim != 1
e21c295fb2da Restructure methods for equidistant grids with a dim argument
Jonatan Werpers <jonatan@werpers.com>
parents: 2090
diff changeset
39 throw(DomainError(dim, "Derivative direction must be 1."))
e21c295fb2da Restructure methods for equidistant grids with a dim argument
Jonatan Werpers <jonatan@werpers.com>
parents: 2090
diff changeset
40 end
e21c295fb2da Restructure methods for equidistant grids with a dim argument
Jonatan Werpers <jonatan@werpers.com>
parents: 2090
diff changeset
41 return first_derivative(g, stencil_set)
e21c295fb2da Restructure methods for equidistant grids with a dim argument
Jonatan Werpers <jonatan@werpers.com>
parents: 2090
diff changeset
42 end
e21c295fb2da Restructure methods for equidistant grids with a dim argument
Jonatan Werpers <jonatan@werpers.com>
parents: 2090
diff changeset
43
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
44 """
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
45 first_derivative(g::EquidistantGrid, inner_stencil::Stencil, closure_stencils)
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
46
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
47 The first derivative operator on an `EquidistantGrid` given an
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1329
diff changeset
48 `inner_stencil` and `closure_stencils`.
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
49 """
1291
356ec6a72974 Implement changes in SbpOperators
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
50 function first_derivative(g::EquidistantGrid, inner_stencil::Stencil, closure_stencils)
356ec6a72974 Implement changes in SbpOperators
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
51 h⁻¹ = inverse_spacing(g)
356ec6a72974 Implement changes in SbpOperators
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
52 return VolumeOperator(g, scale(inner_stencil,h⁻¹), scale.(closure_stencils,h⁻¹), odd)
356ec6a72974 Implement changes in SbpOperators
Jonatan Werpers <jonatan@werpers.com>
parents: 1104
diff changeset
53 end