Improve doc of dirId() method.

2024-11-26 03:00:17 -06:00 · 2022-09-16 09:50:25 +02:00 · 2022-09-16 09:50:25 +02:00 · a050c1e945
commit a050c1e945
parent 6526f9a29a
1 changed files with 4 additions and 1 deletions
--- a/opm/models/discretization/ecfv/ecfvstencil.hh
+++ b/opm/models/discretization/ecfv/ecfvstencil.hh
@ -212,7 +212,10 @@ public:
        { return area_; }

        /*!
-         * \brief Returns the direction of the face
+         * \brief Returns the direction id of the face w.r.t the cell.
+         *
+         * For corner point grids, this is 0-5 for I-, I+, J-, J+, K- and K+ faces,
+         * and -1 for NNC faces.
         */
        int dirId() const
        {