comparison docs/src/grids_and_grid_functions.md @ 1351:d7f29359b822

Merge refactor/grids
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Fri, 19 May 2023 23:53:36 +0200
parents 08f06bfacd5c
children ee3fc2d83c73
comparison
equal deleted inserted replaced
1323:95cac1ee8476 1351:d7f29359b822
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, periodic 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