Skip to content

Commit bccca57

Browse files
authored
Merge pull request #205 from firedrakeproject/pbrubeck/docs/quadrature
Fix quadrature docstrings
2 parents 17eae0d + ae114d3 commit bccca57

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

FIAT/quadrature_schemes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def create_quadrature(ref_el, degree, scheme="default", entity=None):
5858
:kwarg scheme: The quadrature scheme, can be choosen from ["default", "canonical", "KMV"]
5959
"default" -> hard-coded scheme for low degree and collapsed Gauss scheme for high degree,
6060
"canonical" -> collapsed Gauss scheme,
61-
"KMV" -> spectral lumped scheme for low degree (<=5 on triangles, <=3 on tetrahedra).
61+
"KMV" -> spectral lumped scheme for low degree (<=6 on triangles, <=3 on tetrahedra).
6262
:kwarg entity: A tuple of entity dimension and entity id specifying the
6363
integration domain. If not provided, the domain is the entire cell.
6464
"""

finat/quadrature.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,18 @@ def make_quadrature(ref_el, degree, scheme="default"):
1818
Generate quadrature rule for given reference element
1919
that will integrate an polynomial of order 'degree' exactly.
2020
21-
For low-degree (<=6) polynomials on triangles and tetrahedra, this
21+
For low-degree polynomials on triangles (<=50) and tetrahedra (<=15), this
2222
uses hard-coded rules, otherwise it falls back to a collapsed
2323
Gauss scheme on simplices. On tensor-product cells, it is a
2424
tensor-product quadrature rule of the subcells.
2525
2626
:arg ref_el: The FIAT cell to create the quadrature for.
2727
:arg degree: The degree of polynomial that the rule should
2828
integrate exactly.
29+
:kwarg scheme: The quadrature scheme, can be choosen from ["default", "canonical", "KMV"]
30+
"default" -> hard-coded scheme for low degree and collapsed Gauss scheme for high degree,
31+
"canonical" -> collapsed Gauss scheme,
32+
"KMV" -> spectral lumped scheme for low degree (<=6 on triangles, <=3 on tetrahedra).
2933
"""
3034
if ref_el.get_shape() == TENSORPRODUCT:
3135
try:

0 commit comments

Comments
 (0)