improve doc of constructor for polyhedral complex

pairs cannot be reversed or the domain is not consistent
This commit is contained in:
Jane Tournois 2019-04-23 16:28:16 +02:00
parent 564a6c72f4
commit 576a3799eb
1 changed files with 5 additions and 1 deletions

View File

@ -198,7 +198,11 @@ public:
@param end past the end iterator on the input polyhedral surfaces
@param indices_begin first iterator on the pairs of subdomain indices
(two subdomain indices per input polyhedral surface),
corresponding to the first input polyhedral surface
corresponding to the first input polyhedral surface.
Each pair should be ordered as follows : the first (resp. second)
element is the index of the subdomain that lies on the
positively oriented (resp. negatively oriented) side of the
corresponding input polyhedral surface.
@param indices_end past the end iterator on the pairs of subdomain indices
@tparam InputPolyhedraIterator model of `InputIterator`, holding `Polyhedron`'s