annotate src/Grids/Grids.jl @ 1342:c0c1189c5f2e refactor/grids

Clean up grid_refactor.md
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 12 May 2023 15:50:09 +0200
parents ad31c1022e42
children 9c689a627244 05eb8ba149e2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
211
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 module Grids
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2
335
f4e3e71a4ff4 Fix `using` commands to refer to local modules within the Sbplib package/module
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
3 using Sbplib.RegionIndices
1146
31041ef8092a Specialize evalOn for EquidistantGrid to return a LazyArray
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
4 using Sbplib.LazyTensors
1266
a4ddae8b5d49 Add tests for TensorGrid and make them pass
Jonatan Werpers <jonatan@werpers.com>
parents: 1246
diff changeset
5 using StaticArrays
217
4c62d0253bd4 Add RegionIndices as dependency of Grids
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
6
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
7 # Grid
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
8 export Grid
1332
ad31c1022e42 Rename function for coordinate size of a grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
9 export coordinate_size
1288
7de1df0aad6a Add component_type function to Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1280
diff changeset
10 export component_type
1246
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
11
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
12 export TensorGrid
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
13 export ZeroDimGrid
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
14
1266
a4ddae8b5d49 Add tests for TensorGrid and make them pass
Jonatan Werpers <jonatan@werpers.com>
parents: 1246
diff changeset
15 export TensorGridBoundary
a4ddae8b5d49 Add tests for TensorGrid and make them pass
Jonatan Werpers <jonatan@werpers.com>
parents: 1246
diff changeset
16
1280
17d435c08773 Add missing exports and alias TensorGridBoundary to CartesianBoundary
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
17 export grid_id
17d435c08773 Add missing exports and alias TensorGridBoundary to CartesianBoundary
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
18 export boundary_id
17d435c08773 Add missing exports and alias TensorGridBoundary to CartesianBoundary
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
19
1246
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
20 export eval_on
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
21 export getcomponent
221
235f0a771c8f Make all packages load properly
Jonatan Werpers <jonatan@werpers.com>
parents: 217
diff changeset
22
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
23 # BoundaryIdentifier
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
24 export BoundaryIdentifier
1266
a4ddae8b5d49 Add tests for TensorGrid and make them pass
Jonatan Werpers <jonatan@werpers.com>
parents: 1246
diff changeset
25
211
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
26
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
27 # EquidistantGrid
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
28 export EquidistantGrid
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
29 export spacing
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
30 export inverse_spacing
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
31 export boundary_identifiers
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
32 export boundary_grid
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
33 export refine
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
34 export coarsen
1246
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
35 export equidistant_grid
1280
17d435c08773 Add missing exports and alias TensorGridBoundary to CartesianBoundary
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
36 export CartesianBoundary
233
7d2ad8a73b1f Export dim and region from Grids
Jonatan Werpers <jonatan@werpers.com>
parents: 221
diff changeset
37
1243
783284b3e438 Fix include errors
Jonatan Werpers <jonatan@werpers.com>
parents: 1236
diff changeset
38 abstract type BoundaryIdentifier end
783284b3e438 Fix include errors
Jonatan Werpers <jonatan@werpers.com>
parents: 1236
diff changeset
39
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
40 include("grid.jl")
1243
783284b3e438 Fix include errors
Jonatan Werpers <jonatan@werpers.com>
parents: 1236
diff changeset
41 include("tensor_grid.jl")
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
42 include("equidistant_grid.jl")
1234
8806f4cd6fee Move ZeroDimGrid to its own file
Jonatan Werpers <jonatan@werpers.com>
parents: 1146
diff changeset
43 include("zero_dim_grid.jl")
379
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 335
diff changeset
44
211
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
45 end # module