]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a documentation note to the generate()-function. 13632/head
authorSimon Sticko <simon@sticko.se>
Fri, 22 Apr 2022 11:52:05 +0000 (13:52 +0200)
committerSimon Sticko <simon@sticko.se>
Fri, 22 Apr 2022 11:58:19 +0000 (13:58 +0200)
include/deal.II/non_matching/quadrature_generator.h

index 833df1d6cdaded7e57fa1ef665bc7c5696b9be92..c973f8507492f5b1535bd959629fba3be0536437 100644 (file)
@@ -510,6 +510,9 @@ namespace NonMatching
     /**
      * Construct immersed quadratures rules based on the discrete level
      * set vector over the incoming cell.
+     *
+     * @note The cell needs to belong to the same triangulation as the one
+     * associated with the DoFHandler passed to the constructor.
      */
     void
     generate(const typename Triangulation<dim>::active_cell_iterator &cell);
@@ -563,6 +566,9 @@ namespace NonMatching
     /**
      * Construct immersed quadratures rules based on the discrete level
      * set vector over the incoming face described by cell and face index.
+     *
+     * @note The cell needs to belong to the same triangulation as the one
+     * associated with the DoFHandler passed to the constructor.
      */
     void
     generate(const typename Triangulation<dim>::active_cell_iterator &cell,

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.