Mercurial > repos > public > sbplib_julia
comparison docs/src/grids_and_grid_functions.md @ 1341:5761f4060f2b refactor/grids
Start adding general info about grids to docs
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Mon, 08 May 2023 17:37:24 +0200 |
| parents | |
| children | 08f06bfacd5c |
comparison
equal
deleted
inserted
replaced
| 1340:c0da6ea50732 | 1341:5761f4060f2b |
|---|---|
| 1 # Grids and grid functions | |
| 2 | |
| 3 The submodule `Grids` aims to provide types and logic for all types of grids that are useful for implementing summation-by-parts difference methods. It provides an abstract top level type `Grid` which defines a broad interface for how a general grid is supposed to work. Currently only equidistant grids are supported, but the basic structure supports implementations of curvilinear grids, multi-block grids, peridic grids and much more. | |
| 4 | |
| 5 The module also has functionality for creating and working with grid functions. | |
| 6 | |
| 7 ## Interface for grids | |
| 8 All grids are expected to work as a grid function for the coordinate function, and thus implements Julia's Indexing- and Iteration-interfaces. Notably they are *not* abstract arrays because that inteface is too restrictive for the types of grids we wish to implement. | |
| 9 | |
| 10 ## To write about | |
| 11 <!-- # TODO: --> | |
| 12 * Grid functions | |
| 13 * Basic structure | |
| 14 * Indexing | |
| 15 * Curvilinear | |
| 16 * Multiblock | |
| 17 * Vector valued grid functions |