diff +grid/boundaryIdentifier.txt @ 527:763d50caddf3 feature/boundaryGroup

Move the description of boundary identifiers to the grid package and update documentation for grid.Grid.getBoundaryNames
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 03 Aug 2017 14:04:36 +0200
parents +multiblock/boundaryIdentifier.txt@3011f9a28ac8
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/+grid/boundaryIdentifier.txt	Thu Aug 03 14:04:36 2017 +0200
@@ -0,0 +1,5 @@
+A grid.boundaryIdentifier identifies a boundary of a grid.
+For a Cartesian grid it is simply 's', 'n', 'w', 'e'.
+For a multiblock grid it might be something like {1, 's'}.
+For some other grid it will be up to the developer to chose
+a good way to identify boundaries.