]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix Triangulation copydocs 16237/head
authorJan Philipp Thiele <thiele@wias-berlin.de>
Fri, 3 Nov 2023 23:09:37 +0000 (00:09 +0100)
committerJan Philipp Thiele <thiele@wias-berlin.de>
Fri, 3 Nov 2023 23:09:37 +0000 (00:09 +0100)
include/deal.II/distributed/fully_distributed_tria.h
include/deal.II/distributed/tria_base.h

index 6e302cf025ed98205b08f7a69c975b76bab94f06..2b8598be916972c9c0b5d7e5179af162677d5156 100644 (file)
@@ -134,7 +134,16 @@ namespace parallel
       virtual ~Triangulation() = default;
 
       /**
-       * @copydoc deal.II/grid/tria.h Triangulation::create_triangulation(const TriangulationDescription::Description<dim, spacedim>&)
+       * Create a triangulation from the provided
+       * TriangulationDescription::Description.
+       *
+       * @note Don't forget to attach the manifolds with set_manifold() before
+       *   calling this function if manifolds are needed.
+       *
+       * @note The namespace TriangulationDescription::Utilities contains functions
+       *   to create TriangulationDescription::Description.
+       *
+       * @param construction_data The data needed for this process.
        *
        * @note This is the function to be used instead of
        * Triangulation::create_triangulation() for some of the other
index 998125325e7d95afad7c6130fe30d3065ec99f69..e32f80d32e6902306ce3ff51cb85bc80d4f556c3 100644 (file)
@@ -211,7 +211,16 @@ namespace parallel
       const unsigned int level) const override;
 
     /**
-     * @copydoc deal.II/grid/tria.h Triangulation::get_boundary_ids()
+     * Return a vector containing all boundary indicators assigned to boundary
+     * faces of active cells of this Triangulation object. Note, that each
+     * boundary indicator is reported only once. The size of the return vector
+     * will represent the number of different indicators (which is greater or
+     * equal one).
+     *
+     * @ingroup boundary
+     *
+     * @see
+     * @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
      *
      * @note This function involves a global communication gathering all current
      *   IDs from all processes.
@@ -220,7 +229,16 @@ namespace parallel
     get_boundary_ids() const override;
 
     /**
-     * @copydoc deal.II/grid/tria.h Triangulation::get_manifold_ids()
+     * Return a vector containing all manifold indicators assigned to the
+     * objects of the active cells of this Triangulation. Note, that each
+     * manifold indicator is reported only once. The size of the return vector
+     * will represent the number of different indicators (which is greater or
+     * equal one).
+     *
+     * @ingroup manifold
+     *
+     * @see
+     * @ref GlossManifoldIndicator "Glossary entry on manifold indicators"
      *
      * @note This function involves a global communication gathering all current
      *   IDs from all processes.
@@ -370,9 +388,6 @@ namespace parallel
     virtual void
     update_number_cache();
 
-    /**
-     * @copydoc deal.II/grid/tria.h Triangulation::update_reference_cells()
-     */
     void
     update_reference_cells() override;
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.