Skip to content
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.

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

Documentation of GeometryInfo and ReferenceCell unclear #13308

Closed
nfehn opened this issue Jan 28, 2022 · 2 comments · Fixed by #13830
Closed

Documentation of GeometryInfo and ReferenceCell unclear #13308

nfehn opened this issue Jan 28, 2022 · 2 comments · Fixed by #13830
Milestone

Comments

@nfehn
Copy link
Contributor

nfehn commented Jan 28, 2022

The first paragraph in the documentation of GeometryInfo (https://www.dealii.org/developer/doxygen/deal.II/structGeometryInfo.html) says:

This class has been superseded by the ReferenceCell class – see there for more information.

Following the link "ReferenceCell", the first paragraph in the documentation of ReferenceCell (https://www.dealii.org/developer/doxygen/deal.II/classReferenceCell.html) says:

The purposes and intents of this class are described in the reference cell glossary entry.

Following the link "refence cell", the documentation in the glossary says:

The hypercube [0,1]dim, on which all parametric finite element shape functions are defined. Many properties of the reference cell are described by the GeometryInfo class.

again with a link to "GeometryInfo". A loop.

In particular, I hoped to find detailed information which parts of GeometryInfo can be used in the context of simplex. If GeometryInfo should not be used at all, this should be stated more clearly in the documentation of GeometryInfo in my opinion (the "superseded" comment is not explicit enough in my opinion), given that the above links redirected me to GeometryInfo in the end. I found neither the word "hypercube" nor "simplex" in GeometryInfo's documentation. Moreover, the glossary entry should probably be updated.

@bangerth
Copy link
Member

Yes, we ought to fix this.

@nfehn
Copy link
Contributor Author

nfehn commented Mar 11, 2022

Note that geometry info is also used in coding conventions, see https://www.dealii.org/developer/doxygen/deal.II/CodingConventions.html, which might be considered out-dated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants