annotate Grids/src/AbstractGrid.jl @ 212:aa17d4d9d09e package_refactor

Export some functions from AbstractGrid and move documentation to docstrings
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 26 Jun 2019 11:00:34 +0200
parents 1ad91e11b1f4
children b3506cfbb9d8
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
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
5 dimension(grid::AbstractGrid)
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
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
10
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
11 function dimension end
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
12 function points end
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
13 export dimension, 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