Mercurial > repos > public > sbplib_julia

annotate src/Grids/AbstractGrid.jl @ 1115:6530fceef37c feature/grids

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rename dimension to dim
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Fri, 15 Jul 2022 09:41:58 +0200
parents fc57804c9bf4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
1 """
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
2 AbstractGrid
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
3
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
4 Should implement
1115
6530fceef37c Rename dimension to dim
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1114
diff changeset
5 dim(grid::AbstractGrid)
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
6 points(grid::AbstractGrid)
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
7
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
8 """
51
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
9 abstract type AbstractGrid end
723
c16abc564b82 Change from EquidistantGrid to AbstractGrid in Laplace interface
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 333
diff changeset
10 export AbstractGrid
1115
6530fceef37c Rename dimension to dim
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1114
diff changeset
11 function dim end # TODO: Rename to Base.ndims instead? That's the name used for arrays.
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
12 function points end
1115
6530fceef37c Rename dimension to dim
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1114
diff changeset
13 export dim, points
51
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
14
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
15 """
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
16 evalOn(g::AbstractGrid, f::Function)
51
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
17
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
18 Evaluate function f on the grid g
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
19 """
51
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
20 function evalOn(g::AbstractGrid, f::Function)
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
21 F(x) = f(x...)
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
22 return F.(points(g))
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
23 end
223
b3506cfbb9d8 Add some missing exports
Jonatan Werpers <jonatan@werpers.com>
parents: 212
diff changeset
24 export evalOn
1114
fc57804c9bf4 Add function dims
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 723
diff changeset
25
fc57804c9bf4 Add function dims
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 723
diff changeset
26
fc57804c9bf4 Add function dims
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 723
diff changeset
27 """
fc57804c9bf4 Add function dims
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 723
diff changeset
28 dims(g::AbstractGrid)
fc57804c9bf4 Add function dims
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 723
diff changeset
29
fc57804c9bf4 Add function dims
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 723
diff changeset
30 A range containing the dimensions of the grid
fc57804c9bf4 Add function dims
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 723
diff changeset
31 """
1115
6530fceef37c Rename dimension to dim
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1114
diff changeset
32 dims(grid::AbstractGrid) = 1:dim(grid)
1114
fc57804c9bf4 Add function dims
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 723
diff changeset
33 export dims