From: David Wells <drwells@email.unc.edu>
Date: Sun, 27 Oct 2019 19:13:33 +0000 (-0400)
Subject: Implement two helper index functions in (Cell,Tria)Accessor.
X-Git-Tag: v9.2.0-rc1~935^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=82099399ccfeea3bc6a6b2e58f287170c86abc1d;p=dealii.git

Implement two helper index functions in (Cell,Tria)Accessor.
---

diff --git a/doc/news/changes/minor/20191027DavidWells-2 b/doc/news/changes/minor/20191027DavidWells-2
new file mode 100644
index 0000000000..ea7c1035a6
--- /dev/null
+++ b/doc/news/changes/minor/20191027DavidWells-2
@@ -0,0 +1,5 @@
+New: Added convenience functions CellAccessor::face_iterator_to_index()
+and TriaAccessor::child_iterator_to_index() for computing face and child numbers
+from iterators.
+<br>
+(David Wells, 2019/10/27)
diff --git a/include/deal.II/grid/tria_accessor.h b/include/deal.II/grid/tria_accessor.h
index b0d530c8cb..f961522042 100644
--- a/include/deal.II/grid/tria_accessor.h
+++ b/include/deal.II/grid/tria_accessor.h
@@ -982,6 +982,14 @@ public:
   TriaIterator<TriaAccessor<structdim, dim, spacedim>>
   child(const unsigned int i) const;
 
+  /**
+   * Return the child number of @p child on the current cell. This is the
+   * inverse function of TriaAccessor::child().
+   */
+  unsigned int
+  child_iterator_to_index(
+    const TriaIterator<TriaAccessor<structdim, dim, spacedim>> &child) const;
+
   /**
    * Return an iterator to that object that is identical to the ith child for
    * isotropic refinement. If the current object is refined isotropically,
@@ -2044,6 +2052,12 @@ public:
   static unsigned int
   max_refinement_depth();
 
+  /**
+   * @brief Return an invalid unsigned integer.
+   */
+  static unsigned int
+  child_iterator_to_index(const TriaIterator<TriaAccessor<0, dim, spacedim>> &);
+
   /**
    * @brief Return an invalid object.
    */
@@ -2497,6 +2511,12 @@ public:
   static unsigned int
   max_refinement_depth();
 
+  /**
+   * @brief Return an invalid unsigned integer.
+   */
+  static unsigned int
+  child_iterator_to_index(const TriaIterator<TriaAccessor<0, 1, spacedim>> &);
+
   /**
    * @brief Return an invalid object
    */
@@ -2735,6 +2755,13 @@ public:
   TriaIterator<TriaAccessor<dim - 1, dim, spacedim>>
   face(const unsigned int i) const;
 
+  /**
+   * Return the face number of @p face on the current cell. This is the
+   * inverse function of TriaAccessor::face().
+   */
+  unsigned int
+  face_iterator_to_index(
+    const TriaIterator<TriaAccessor<dim - 1, dim, spacedim>> &face) const;
 
   /**
    * Return an array of iterators to all faces of this cell.
diff --git a/include/deal.II/grid/tria_accessor.templates.h b/include/deal.II/grid/tria_accessor.templates.h
index 13d98ab322..01c730bf4e 100644
--- a/include/deal.II/grid/tria_accessor.templates.h
+++ b/include/deal.II/grid/tria_accessor.templates.h
@@ -1510,6 +1510,23 @@ TriaAccessor<structdim, dim, spacedim>::child(const unsigned int i) const
 
 
 
+template <int structdim, int dim, int spacedim>
+inline unsigned int
+TriaAccessor<structdim, dim, spacedim>::child_iterator_to_index(
+  const TriaIterator<TriaAccessor<structdim, dim, spacedim>> &child) const
+{
+  const auto n_children = this->n_children();
+  for (unsigned int child_n = 0; child_n < n_children; ++child_n)
+    if (this->child(child_n) == child)
+      return child_n;
+
+  Assert(false,
+         ExcMessage("The given child is not a child of the current object."));
+  return numbers::invalid_unsigned_int;
+}
+
+
+
 template <int structdim, int dim, int spacedim>
 inline TriaIterator<TriaAccessor<structdim, dim, spacedim>>
 TriaAccessor<structdim, dim, spacedim>::isotropic_child(
@@ -2590,6 +2607,16 @@ TriaAccessor<0, dim, spacedim>::max_refinement_depth()
 
 
 
+template <int dim, int spacedim>
+inline unsigned int
+TriaAccessor<0, dim, spacedim>::child_iterator_to_index(
+  const TriaIterator<TriaAccessor<0, dim, spacedim>> &)
+{
+  return numbers::invalid_unsigned_int;
+}
+
+
+
 template <int dim, int spacedim>
 inline TriaIterator<TriaAccessor<0, dim, spacedim>>
 TriaAccessor<0, dim, spacedim>::child(const unsigned int)
@@ -3004,6 +3031,17 @@ TriaAccessor<0, 1, spacedim>::max_refinement_depth()
 }
 
 
+
+template <int spacedim>
+inline unsigned int
+TriaAccessor<0, 1, spacedim>::child_iterator_to_index(
+  const TriaIterator<TriaAccessor<0, 1, spacedim>> &)
+{
+  return numbers::invalid_unsigned_int;
+}
+
+
+
 template <int spacedim>
 inline TriaIterator<TriaAccessor<0, 1, spacedim>>
 TriaAccessor<0, 1, spacedim>::child(const unsigned int)
@@ -3181,6 +3219,23 @@ CellAccessor<dim, spacedim>::face(const unsigned int i) const
 
 
 
+template <int dim, int spacedim>
+inline unsigned int
+CellAccessor<dim, spacedim>::face_iterator_to_index(
+  const TriaIterator<TriaAccessor<dim - 1, dim, spacedim>> &face) const
+{
+  for (unsigned int face_n = 0; face_n < GeometryInfo<dim>::faces_per_cell;
+       ++face_n)
+    if (this->face(face_n) == face)
+      return face_n;
+
+  Assert(false,
+         ExcMessage("The given face is not a face of the current cell."));
+  return numbers::invalid_unsigned_int;
+}
+
+
+
 template <int dim, int spacedim>
 inline std::array<TriaIterator<TriaAccessor<dim - 1, dim, spacedim>>,
                   GeometryInfo<dim>::faces_per_cell>