annotate src/Grids/Grids.jl @ 1721:7379f492c4b3 feature/lazy_tensors/sparse_conversions

Fix typos in docstring
author Vidar Stiernström <vidar.stiernstrom@gmail.com>
date Thu, 05 Sep 2024 08:31:03 -0700
parents 3714a391545a
children 471a948cd2b2
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
1146
31041ef8092a Specialize evalOn for EquidistantGrid to return a LazyArray
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
3 using Sbplib.LazyTensors
1266
a4ddae8b5d49 Add tests for TensorGrid and make them pass
Jonatan Werpers <jonatan@werpers.com>
parents: 1246
diff changeset
4 using StaticArrays
217
4c62d0253bd4 Add RegionIndices as dependency of Grids
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
5
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
6 # Grid
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
7 export Grid
1332
ad31c1022e42 Rename function for coordinate size of a grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
8 export coordinate_size
1288
7de1df0aad6a Add component_type function to Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1280
diff changeset
9 export component_type
1467
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
10 export grid_id
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
11 export boundary_id
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
12 export boundary_indices
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
13 export boundary_identifiers
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
14 export boundary_grid
1646
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1602
diff changeset
15 export min_spacing
1474
276c38a48aac Start implementing componentview
Jonatan Werpers <jonatan@werpers.com>
parents: 1467
diff changeset
16 export coarsen
276c38a48aac Start implementing componentview
Jonatan Werpers <jonatan@werpers.com>
parents: 1467
diff changeset
17 export refine
1467
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
18 export eval_on
1474
276c38a48aac Start implementing componentview
Jonatan Werpers <jonatan@werpers.com>
parents: 1467
diff changeset
19 export componentview
1476
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1474
diff changeset
20 export ArrayComponentView
1467
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
21
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
22 export BoundaryIdentifier
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
23 export TensorGridBoundary
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
24 export CartesianBoundary
1672
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
25 export LowerBoundary
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
26 export UpperBoundary
1246
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
27
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
28 export TensorGrid
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
29 export ZeroDimGrid
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
30
1467
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
31 export EquidistantGrid
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
32 export inverse_spacing
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
33 export spacing
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
34 export equidistant_grid
1266
a4ddae8b5d49 Add tests for TensorGrid and make them pass
Jonatan Werpers <jonatan@werpers.com>
parents: 1246
diff changeset
35
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
36 include("grid.jl")
1243
783284b3e438 Fix include errors
Jonatan Werpers <jonatan@werpers.com>
parents: 1236
diff changeset
37 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
38 include("equidistant_grid.jl")
1234
8806f4cd6fee Move ZeroDimGrid to its own file
Jonatan Werpers <jonatan@werpers.com>
parents: 1146
diff changeset
39 include("zero_dim_grid.jl")
379
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 335
diff changeset
40
211
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
41 end # module