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

typo in docu of fourth order unit tensor (SymmetricTensor<4, dim, Number> identity_tensor()) #13145

Conversation

jfriedlein
Copy link
Contributor

Hello,

I found a minor typo in the documentation of SymmetricTensor<4, dim, Number> identity_tensor(); (docu of identity_tensor). In the index notation (line 101-102) the last index pair for \mathcal{I}_{ijkl} should be "jk" and not "jl". (compare for instance Wriggers "Nonlinear Finite Element Methods" p.79 eq. (3.270) or Notes on Continuum Mechanics - Tensors eq. (1.175)) This appears to be a copy-paste error from the previous line 101 that sneaked in with #9830.

Obviously the implementation is fine, it is just this one character in the documentation that I stumble over from time to time.
Normally, such a small thing would not bother me, but this documentation is so well written and very helpful that I often look things up there instead of opening a book. Overall, a fantastic work that is very much appreciated!
I took this opportunity to try a pull request, so please let me know if anything is out of order.

Copy link
Member

@jppelteret jppelteret left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well spotted! Thanks for fixing this @jfriedlein.

@masterleinad
Copy link
Member

We require all commits to be associated with a proper first and last name:

shell: /bin/bash -e {0}
invalid author 'jfriedlein' without firstname and lastname

hint: for possible solutions, consult the webpage:
      dealii/dealii/wiki/Indentation#commit-authorship

Would you mind fixing this by following the instructions in the link?

corrected minor typo in documentation of fourth order unit tensor (or "fourth order identity tensor") \mathcal{I}_{ijkl}, compare for instance Wriggers "Nonlinear Finite Element Methods" p.79 eq. (3.270) or [Notes on Continuum Mechanics - Tensors](http://mmc.rmee.upc.edu/documents/Tensor_Analysis/tensors.pdf) eq. (1.175); appears to be a copy-paste error from previous line 101
@jfriedlein jfriedlein force-pushed the jfriedlein-4th_order_unit_tensor_docu_typo branch from 0a0b838 to 5943af6 Compare December 29, 2021 10:07
@jppelteret jppelteret merged commit e446276 into dealii:master Dec 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants