Mercurial > repos > public > sbplib
changeset 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 | d8833f0a9f1a |
| children | 6712655953d3 |
| files | +grid/Grid.m +grid/boundaryIdentifier.txt +multiblock/boundaryIdentifier.txt |
| diffstat | 3 files changed, 6 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
diff -r d8833f0a9f1a -r 763d50caddf3 +grid/Grid.m --- a/+grid/Grid.m Thu Aug 03 09:55:59 2017 +0200 +++ b/+grid/Grid.m Thu Aug 03 14:04:36 2017 +0200 @@ -16,7 +16,7 @@ % Projects the grid function gf on obj to the grid g. gf = projectFunc(obj, gf, g) - % Return the names of all boundaries in this grid. + % Return the grid.boundaryIdentifiers of all boundaries in a cell array. bs = getBoundaryNames(obj) % Return coordinates for the given boundary
diff -r d8833f0a9f1a -r 763d50caddf3 +grid/boundaryIdentifier.txt --- /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.