Mercurial > repos > public > sbplib_julia
comparison docs/src/grids_and_grid_functions.md @ 1347:08f06bfacd5c refactor/grids
Fix typos and formatting of documentation
author | Vidar Stiernström <vidar.stiernstrom@it.uu.se> |
---|---|
date | Thu, 18 May 2023 22:53:31 +0200 |
parents | 5761f4060f2b |
children | ee3fc2d83c73 |
comparison
equal
deleted
inserted
replaced
1345:c2012db881cb | 1347:08f06bfacd5c |
---|---|
1 # Grids and grid functions | 1 # Grids and grid functions |
2 | 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. | 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, periodic grids and much more. |
4 | 4 |
5 The module also has functionality for creating and working with grid functions. | 5 The module also has functionality for creating and working with grid functions. |
6 | 6 |
7 ## Interface for grids | 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. | 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. |