Skip to content

Commit c0e4f9b

Browse files
committed
Remove old Polygon1 name from comments
Generic explanations are a better idea here anyway
1 parent 4154046 commit c0e4f9b

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

include/fe/fe.h

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -415,8 +415,10 @@ class FE : public FEGenericBase<typename FEOutputType<T>::type>
415415
*
416416
* On a p-refined element, \p o should be the total order of the element.
417417
*
418-
* This method does not support all finite element types; e.g. the
419-
* Polygon1 type may differ from element to element.
418+
* This method does not support all finite element types; e.g. for an
419+
* arbitrary polygon or polyhedron type the number of shape
420+
* functions may depend on an individual element and not just its
421+
* type.
420422
*/
421423
static unsigned int n_shape_functions (const ElemType t,
422424
const Order o)
@@ -428,8 +430,10 @@ class FE : public FEGenericBase<typename FEOutputType<T>::type>
428430
*
429431
* On a p-refined element, \p o should be the total order of the element.
430432
*
431-
* This method does not support all finite element types; e.g. the
432-
* Polygon1 type may differ from element to element.
433+
* This method does not support all finite element types; e.g. for an
434+
* arbitrary polygon or polyhedron type the number of shape
435+
* functions may depend on an individual element and not just its
436+
* type.
433437
*/
434438
static unsigned int n_dofs(const ElemType t,
435439
const Order o);
@@ -452,8 +456,9 @@ class FE : public FEGenericBase<typename FEOutputType<T>::type>
452456
*
453457
* On a p-refined element, \p o should be the total order of the element.
454458
*
455-
* This method does not support all finite element types; e.g. the
456-
* Polygon1 type may differ from element to element.
459+
* This method does not support all finite element types; e.g. for an
460+
* arbitrary polygon or polyhedron type the meaning of a node index
461+
* \p n may depend on an individual element and not just its type.
457462
*/
458463
static unsigned int n_dofs_at_node(const ElemType t,
459464
const Order o,

include/fe/fe_abstract.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,9 +209,10 @@ class FEAbstract : public ReferenceCountedObject<FEAbstract>
209209
* indicate a tolerance. For example, \f$ x \le 1 \f$ becomes
210210
* \f$ x \le 1 + \epsilon \f$.
211211
*
212-
* This method overload is now deprecated, since it cannot support
213-
* all finite element types; e.g. the Polygon1 type may differ from
214-
* element to element. Use \p Elem::on_reference_element() instead.
212+
* \deprecated This method overload does not support all finite
213+
* element types; e.g. the reference element for an arbitrary
214+
* polygon or polyhedron type may differ from element to element.
215+
* Use \p Elem::on_reference_element() instead.
215216
*/
216217
static bool on_reference_element(const Point & p,
217218
const ElemType t,

include/fe/fe_interface.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,8 +346,9 @@ class FEInterface
346346
* \f$ \xi \le 1 \f$ becomes \f$ \xi \le 1 + \epsilon \f$.
347347
*
348348
* \deprecated This method overload does not support all finite
349-
* element types; e.g. the Polygon1 type may differ from element to
350-
* element. Use \p Elem::on_reference_element() instead.
349+
* element types; e.g. the reference element for an arbitrary
350+
* polygon or polyhedron type may differ from element to element.
351+
* Use \p Elem::on_reference_element() instead.
351352
*/
352353
static bool on_reference_element(const Point & p,
353354
const ElemType t,

0 commit comments

Comments
 (0)