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

Jump to bottom

[GeoMechanicsApplication] Add documentation for the thermal element #11986

Merged

mnabideltares merged 21 commits into master from geo/11977-thermal-documentation

Feb 7, 2024

Contributor

mnabideltares commented Jan 26, 2024

📝 Description
Add documentation as README.md for the theory and formulations behind the thermal element.

🆕 Changelog

Added README.md in the same directory as the thermal element class, namely in custom_elements

mnabideltares self-assigned this

mnabideltares requested review from rfaasse, indigocoral and WPK4FEM

January 26, 2024 10:49

mnabideltares added the Documentation label

WPK4FEM reviewed

View reviewed changes

Contributor

WPK4FEM left a comment

Dear Mohammed,
Very good start of documentation, I greatly appreciate that we can read formulas in the documentation.
Still I have quite a number of remarks. Please check which make sense.

applications/GeoMechanicsApplication/custom_elements/README.md Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

rfaasse reviewed

View reviewed changes

Contributor

rfaasse left a comment

Thank you for adding this documentation, this is very helpful in understanding the physics behind our new element. I have a couple of minor remarks.

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

mnabideltares requested review from WPK4FEM and rfaasse

January 30, 2024 12:31

WPK4FEM reviewed

View reviewed changes

Contributor

WPK4FEM left a comment

Nice. Sorry that I'm still nagging about details.

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

mnabideltares requested review from WPK4FEM, avdg81 and markelov208

January 31, 2024 14:06

markelov208 reviewed

View reviewed changes

Contributor

markelov208 left a comment

Hi Mohamed, thank you for the documentation, it is my first reading on this topic. Looking forward to Wijtze-Pieter's comments. ;)

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Outdated Show resolved Hide resolved

applications/GeoMechanicsApplication/custom_elements/README.md Show resolved Hide resolved

WPK4FEM reviewed

View reviewed changes

applications/GeoMechanicsApplication/custom_elements/README.md Outdated

+              - $\Omega$ = domain region
+              - $\Gamma$ = boundary region
+              The supercripts $^l$ and $^r$ for Robin boundary condition indicate the left hands side (matrix) and righ hand side (vector), respectively. The supercripts $^e$ and $^{ep}$ for $\Omega$ and $\Gamma$ indicate values in the element volume and perpendicular to element boundaries, respectively.

Contributor

WPK4FEM Feb 7, 2024

Sorry Mohammed, found another typo.
supercripts -> superscripts 2 times on this line.

Almost there...

mnabideltares added 14 commits

February 7, 2024 13:53


          Readme.md for thermal element is added, update 01

b7bf093


          Readme.md for thermal element is added, update 02

fb5a07c


          Readme.md for thermal element is added, update 03

c0cd293


          Readme.md for thermal element is added, update 04

a6b7656


          Readme.md for thermal element is added, update 05

616eb84


          Readme.md for thermal element is added, update 06

98af7b8


          Readme.md for thermal element is added, update 07

fd177df


          Readme.md for thermal element is added, update 08

84c08a1


          Readme.md for thermal element is added, update 09

45fd2ee


          Readme.md for thermal element is added, update 10

46d4a08


          Readme.md for thermal element is added, update 11

3f91c8e


          Readme.md for thermal element is added, update 12

93cd179


          Readme.md for thermal element is added, update 13

794bd07


          Readme.md for thermal element is added, update 14

c40a2ce

Modified based of reviews

mnabideltares added 7 commits

February 7, 2024 13:53


          Readme.md for thermal element is added, update 15

e363f24

Modified based of reviews


          Readme.md for thermal element is added, update 16

b6007c6

Modified based of reviews


          Readme.md for thermal element is added, update 17

6c87e76

Modified based of reviews


          Readme.md for thermal element is added, update 18

24551a7

Modified based of reviews


          Readme.md for thermal element is added, update 19

ba601ac

Modified based of reviews


          Readme.md for thermal element is added, update 20

59d892c

Modified based of reviews


          Readme.md for thermal element is added, update 21

c48c0bf

Modified based on Codacy

mnabideltares force-pushed the geo/11977-thermal-documentation branch from 558b659 to c48c0bf Compare

February 7, 2024 12:53

rfaasse approved these changes

View reviewed changes

Contributor

rfaasse left a comment

Thanks for incorporating the changes, it looks good to go from my side.

markelov208 approved these changes

View reviewed changes

mnabideltares merged commit 7edecdc into master

15 of 17 checks passed

mnabideltares deleted the geo/11977-thermal-documentation branch

February 7, 2024 16:19

rfaasse linked an issue

that may be closed by this pull request

[GeoMechanicsApplication] Thermal documentation #11977

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

WPK4FEM WPK4FEM left review comments

markelov208 markelov208 approved these changes

rfaasse rfaasse approved these changes

indigocoral Awaiting requested review from indigocoral

avdg81 Awaiting requested review from avdg81

Labels