Merge pull request #359 from rolk/359_cart

Document Cartesian info fields for unstructured grids
2013-09-06 01:13:34 -07:00
parent 1d61208d88 a25e3ea851
commit fb64b96695
1 changed files with 9 additions and 0 deletions
--- a/opm/core/grid.h
+++ b/opm/core/grid.h
@@ -204,6 +204,11 @@ struct UnstructuredGrid
       This field is intended for grids that have a (possibly
       degenerate) logical cartesian structure, for example
       cornerpoint grids.
+
+       If null, this indicates that the element indices coincide
+       with the logical cartesian indices, _or_ that the grid has
+       no inherent Cartesian structure. Due to this ambiguity, this
+       field should not be used to check if the grid is Cartesian.
    */
    int    *global_cell;

@@ -213,6 +218,10 @@ struct UnstructuredGrid
       This field is intended for grids that have a (possibly
       degenerate) logical cartesian structure, for example
       cornerpoint grids.
+
+       If the grid is unstructured (non-Cartesian), then at least one
+       of the items in the (sub-)array cartdims[0..dimensions-1]
+       _could_ have the value 0 to signal this.
    */
    int     cartdims[3];
    /**