]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a note to QMidpoint. 13706/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 5 May 2022 21:04:05 +0000 (15:04 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 10 May 2022 02:48:32 +0000 (20:48 -0600)
include/deal.II/base/quadrature_lib.h

index d58afc17ecc08bb02671202a442e3d5afcf7d781..f3f0d3c126f5d2e440ec27799558946fa9bca257 100644 (file)
@@ -83,7 +83,12 @@ public:
 
 /**
  * The midpoint rule for numerical quadrature. This one-point formula is exact
- * for linear polynomials.
+ * for linear integrands.
+ *
+ * @note This class only works for cells that are tensor product (hypercube) cells,
+ *   that is, are either ReferenceCells::Line, ReferenceCells::Quadrilateral,
+ *   or ReferenceCells::Hexahedron. For other cell shapes, this class is not
+ *   appropriate. Use ReferenceCell::get_midpoint_quadrature() instead.
  */
 template <int dim>
 class QMidpoint : public Quadrature<dim>

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.