Skip to content

Fix quadrature docstrings #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pbrubeck merged 1 commit into from
Dec 19, 2025
Merged

Fix quadrature docstrings #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion FIAT/quadrature_schemes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def create_quadrature(ref_el, degree, scheme="default", entity=None):
:kwarg scheme: The quadrature scheme, can be choosen from ["default", "canonical", "KMV"]
"default" -> hard-coded scheme for low degree and collapsed Gauss scheme for high degree,
"canonical" -> collapsed Gauss scheme,
"KMV" -> spectral lumped scheme for low degree (<=5 on triangles, <=3 on tetrahedra).
"KMV" -> spectral lumped scheme for low degree (<=6 on triangles, <=3 on tetrahedra).
:kwarg entity: A tuple of entity dimension and entity id specifying the
integration domain. If not provided, the domain is the entire cell.
"""
Expand Down
6 changes: 5 additions & 1 deletion finat/quadrature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,18 @@ def make_quadrature(ref_el, degree, scheme="default"):
Generate quadrature rule for given reference element
that will integrate an polynomial of order 'degree' exactly.

For low-degree (<=6) polynomials on triangles and tetrahedra, this
For low-degree polynomials on triangles (<=50) and tetrahedra (<=15), this
uses hard-coded rules, otherwise it falls back to a collapsed
Gauss scheme on simplices. On tensor-product cells, it is a
tensor-product quadrature rule of the subcells.

:arg ref_el: The FIAT cell to create the quadrature for.
:arg degree: The degree of polynomial that the rule should
integrate exactly.
:kwarg scheme: The quadrature scheme, can be choosen from ["default", "canonical", "KMV"]
"default" -> hard-coded scheme for low degree and collapsed Gauss scheme for high degree,
"canonical" -> collapsed Gauss scheme,
"KMV" -> spectral lumped scheme for low degree (<=6 on triangles, <=3 on tetrahedra).
"""
if ref_el.get_shape() == TENSORPRODUCT:
try:
Expand Down