annotate docs/src/submodules/grids.md @ 1354:150313ed2cae

Merge refactor/grids (missed delete of a note) Changes from previous merge: * `EquidistantGrid` is now only a 1D thing. * Higher dimensions are supported through `TensorGrid`. * The old behavior of `EquidistantGrid` has been moved to the function `equidistant_grid`. * Grids embedded in higher dimensions are now supported through tensor products with `ZeroDimGrid`s. * Vector valued grid functions are now supported and the default element type is `SVector`. * Grids are now expected to support Julia's indexing and iteration interface. * `eval_on` can be called with both `f(x,y,...)` and `f(x̄)`.
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 20 May 2023 14:19:20 +0200
parents 126e169bb0b7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 # Grids
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 ## Contents
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 ```@contents
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 Pages = ["grids.md"]
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6 ```
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 ## Index
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 ```@index
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10 Pages = ["grids.md"]
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11 ```
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13 ## Public interface
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14 ```@autodocs
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 Modules = [Grids]
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
16 Private = false # Hide unexported objects
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
17 ```
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
18
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 ## Internal interface
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20 ```@autodocs
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21 Modules = [Grids]
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22 Public = false # Hide exported objects
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
23 ```