annotate src/Grids/Grids.jl @ 1682:4ce9cb21220c feature/grids/curvilinear

Fix naming of metrix tensor functions
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 11 Jul 2024 11:24:52 +0200
parents 51f0c5f895fb
children 88021d580320
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1434
af73340a8f0e Add todos
Jonatan Werpers <jonatan@werpers.com>
parents: 1431
diff changeset
1 # TODO: Double check that the interfaces for indexing and iterating are fully implemented and tested for all grids.
211
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 module Grids
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3
335
f4e3e71a4ff4 Fix `using` commands to refer to local modules within the Sbplib package/module
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
4 using Sbplib.RegionIndices
1146
31041ef8092a Specialize evalOn for EquidistantGrid to return a LazyArray
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
5 using Sbplib.LazyTensors
1266
a4ddae8b5d49 Add tests for TensorGrid and make them pass
Jonatan Werpers <jonatan@werpers.com>
parents: 1246
diff changeset
6 using StaticArrays
217
4c62d0253bd4 Add RegionIndices as dependency of Grids
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
7
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
8 # Grid
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
9 export Grid
1332
ad31c1022e42 Rename function for coordinate size of a grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
10 export coordinate_size
1288
7de1df0aad6a Add component_type function to Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1280
diff changeset
11 export component_type
1467
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
12 export grid_id
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
13 export boundary_id
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
14 export boundary_indices
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
15 export boundary_identifiers
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
16 export boundary_grid
1646
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1602
diff changeset
17 export min_spacing
1474
276c38a48aac Start implementing componentview
Jonatan Werpers <jonatan@werpers.com>
parents: 1467
diff changeset
18 export coarsen
276c38a48aac Start implementing componentview
Jonatan Werpers <jonatan@werpers.com>
parents: 1467
diff changeset
19 export refine
1467
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
20 export eval_on
1474
276c38a48aac Start implementing componentview
Jonatan Werpers <jonatan@werpers.com>
parents: 1467
diff changeset
21 export componentview
1476
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1474
diff changeset
22 export ArrayComponentView
1659
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1649
diff changeset
23 export normal
1467
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
24
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
25 export BoundaryIdentifier
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
26 export TensorGridBoundary
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
27 export CartesianBoundary
1246
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
28
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
29 export TensorGrid
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
30 export ZeroDimGrid
476b889f0ffa Add missing export statements
Jonatan Werpers <jonatan@werpers.com>
parents: 1243
diff changeset
31
1467
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
32 export EquidistantGrid
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
33 export inverse_spacing
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
34 export spacing
1e8fbe55916e Reorder exports in Grids.jl
Jonatan Werpers <jonatan@werpers.com>
parents: 1462
diff changeset
35 export equidistant_grid
1266
a4ddae8b5d49 Add tests for TensorGrid and make them pass
Jonatan Werpers <jonatan@werpers.com>
parents: 1246
diff changeset
36
211
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
37
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
38 # MappedGrid
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
39 export MappedGrid
1431
6adf31ba6cfd Add `jacobian` and `logicalgrid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
40 export jacobian
6adf31ba6cfd Add `jacobian` and `logicalgrid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
41 export logicalgrid
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
42 export mapped_grid
1560
5d32ecb98db8 Add functions for jacobian_determiant, geometric_tensor, geometric_tensor_inverse
Jonatan Werpers <jonatan@werpers.com>
parents: 1506
diff changeset
43 export jacobian_determinant
1682
4ce9cb21220c Fix naming of metrix tensor functions
Jonatan Werpers <jonatan@werpers.com>
parents: 1677
diff changeset
44 export metric_tensor
4ce9cb21220c Fix naming of metrix tensor functions
Jonatan Werpers <jonatan@werpers.com>
parents: 1677
diff changeset
45 export metric_tensor_inverse
1426
9c689a627244 Add src and test file for curvilinear grid type
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
46
1243
783284b3e438 Fix include errors
Jonatan Werpers <jonatan@werpers.com>
parents: 1236
diff changeset
47 abstract type BoundaryIdentifier end
783284b3e438 Fix include errors
Jonatan Werpers <jonatan@werpers.com>
parents: 1236
diff changeset
48
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 662
diff changeset
49 include("grid.jl")
1243
783284b3e438 Fix include errors
Jonatan Werpers <jonatan@werpers.com>
parents: 1236
diff changeset
50 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
51 include("equidistant_grid.jl")
1234
8806f4cd6fee Move ZeroDimGrid to its own file
Jonatan Werpers <jonatan@werpers.com>
parents: 1146
diff changeset
52 include("zero_dim_grid.jl")
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
53 include("mapped_grid.jl")
379
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 335
diff changeset
54
211
1ad91e11b1f4 Move DiffOps and Grids into packages
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
55 end # module