comparison src/Grids/grid.jl @ 1336:52087a6c0682 refactor/grids

Mention grids as grid functions
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 03 May 2023 15:50:08 +0200
parents 47e309eac131
children f265799bc2b6
comparison
equal deleted inserted replaced
1335:cca45af5e724 1336:52087a6c0682
1 """ 1 """
2 Grid{T,D} 2 Grid{T,D}
3 3
4 A grid with coordinates of type `T`, e.g. `SVector{3,Float64}`, and dimension 4 A grid with coordinates of type `T`, e.g. `SVector{3,Float64}`, and dimension
5 `D`. The grid can be embedded in a higher dimension in which case the number 5 `D`. The grid can be embedded in a higher dimension in which case the number
6 of indices and the number of components of the coordinatevectors will be 6 of indices and the number of components of the coordinate vectors will be
7 different. 7 different.
8
9 All grids are expected to behave as a grid function for the coordinates.
8 10
9 `Grids` is top level abstract type for grids. A grid should implement Julia's interfaces for 11 `Grids` is top level abstract type for grids. A grid should implement Julia's interfaces for
10 indexing and iteration. 12 indexing and iteration.
11 13
12 ## Note 14 ## Note