comparison src/SbpOperators/boundaryops/boundary_restriction.jl @ 690:1accc3e051d0 refactor/operator_naming

Start changing the name of functions creating operators that are not types to lower case. E.g SecondDerivative->second_derivative
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Fri, 12 Feb 2021 16:16:45 +0100
parents 332f65c1abf3
children 5eb1edef8a7b
comparison
equal deleted inserted replaced
674:621460cf8279 690:1accc3e051d0
1 """ 1 """
2 BoundaryRestriction(grid::EquidistantGrid, closure_stencil::Stencil, boundary::CartesianBoundary) 2 boundary_restriction(grid::EquidistantGrid, closure_stencil::Stencil, boundary::CartesianBoundary)
3 BoundaryRestriction(grid::EquidistantGrid{1}, closure_stencil::Stencil, region::Region) 3 boundary_restriction(grid::EquidistantGrid{1}, closure_stencil::Stencil, region::Region)
4 4
5 Creates the boundary restriction operator `e` as a `TensorMapping` 5 Creates the boundary restriction operator `e` as a `TensorMapping`
6 6
7 `e` is the restriction of a grid function to the boundary specified by `boundary` or `region` using some `closure_stencil`. 7 `e` is the restriction of a grid function to the boundary specified by `boundary` or `region` using some `closure_stencil`.
8 `e'` is the prolongation of a grid function on the boundary to the whole grid using the same `closure_stencil`. 8 `e'` is the prolongation of a grid function on the boundary to the whole grid using the same `closure_stencil`.
9 On a one-dimensional `grid`, `e` is a `BoundaryOperator`. On a multi-dimensional `grid`, `e` is the inflation of 9 On a one-dimensional `grid`, `e` is a `BoundaryOperator`. On a multi-dimensional `grid`, `e` is the inflation of
10 a `BoundaryOperator`. Also see the documentation of `SbpOperators.boundary_operator(...)` for more details. 10 a `BoundaryOperator`. Also see the documentation of `SbpOperators.boundary_operator(...)` for more details.
11 """ 11 """
12 BoundaryRestriction(grid::EquidistantGrid, closure_stencil::Stencil, boundary::CartesianBoundary) = SbpOperators.boundary_operator(grid, closure_stencil, boundary) 12 boundary_restriction(grid::EquidistantGrid, closure_stencil::Stencil, boundary::CartesianBoundary) = SbpOperators.boundary_operator(grid, closure_stencil, boundary)
13 BoundaryRestriction(grid::EquidistantGrid{1}, closure_stencil::Stencil, region::Region) = BoundaryRestriction(grid, closure_stencil, CartesianBoundary{1,typeof(region)}()) 13 boundary_restriction(grid::EquidistantGrid{1}, closure_stencil::Stencil, region::Region) = boundary_restriction(grid, closure_stencil, CartesianBoundary{1,typeof(region)}())
14 14
15 export BoundaryRestriction 15 export boundary_restriction