From f19bc37f0048550311d9e1aec79bf27e0ce9f21c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A5rd=20Skaflestad?= Date: Mon, 20 Jan 2014 10:33:42 +0100 Subject: [PATCH] Document requirements of CellRange. --- opm/core/simulator/initStateEquil.hpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/opm/core/simulator/initStateEquil.hpp b/opm/core/simulator/initStateEquil.hpp index 43f77aac..4d7a6f0f 100644 --- a/opm/core/simulator/initStateEquil.hpp +++ b/opm/core/simulator/initStateEquil.hpp @@ -555,7 +555,10 @@ namespace Opm * * \tparam CellRange Type of cell range that demarcates the * cells pertaining to the current - * equilibration region. + * equilibration region. Must implement + * methods begin() and end() to bound the range + * as well as provide an inner type, + * const_iterator, to traverse the range. * * \param[in] G Grid. * \param[in] reg Current equilibration region.