-
Notifications
You must be signed in to change notification settings - Fork 248
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
[GeoMechanicsApplication] Create documentation for the new line interface geometry #12647
[GeoMechanicsApplication] Create documentation for the new line interface geometry #12647
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the good start of documentation for interfaces. Not much to complain about. The documentation may grow as point or plane interfaces and diff-order interfaces are added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice pictures! Maybe wise to indicate the \xi axis here (with origin in the middle of the mid-geometry.
Another question is how we clarify that this is 2 dimensional geometry.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the
## Line Interface Geometry | ||
The Line Interface Geometry is a custom geometry that can be used to define a line interface between two different domains. | ||
|
||
The geometry is defined by two lines, one on each side of the interface, where they can connect to the larger body of the domains separated by the interface. Most calculations are performed on the 'midline', which is defined by the midpoints of the two lines. They are depicted as the grey lines in the figures below. Meaning that if a certain property is queried at a certain position, the call is forwarded to the underlying midline geometry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first sentence is quite complex and with many comma's. I suggest make the last part a separate sentence. The lines connect to other model parts, that not necessarily are "larger bodies". ( you can also connect a line to a body using an interface. The line then still is "smaller" than the interface.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, let me know if this was what you meant!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rfaasse
Thank for for the documentation., I have just few minor comments
|
||
![3Plus3NodedGeometry](3Plus3NodedLineGeometry.svg) | ||
|
||
One thing to note, is that this line interface geometry does not implement functions from the Geometry base class which are related to the integration scheme. That is because most of the time, interface geometries are used with a Lobatto integration scheme, which is not supported by the Geometry base class. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It needs to be mentioned that this geometry is not independent, and it is based on line geometry of 2d_2n, and 2d_3n, which are available in the core
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I added links to the line_2d_2.h and line_2d_3.h files.
@@ -0,0 +1,18 @@ | |||
# Custom Geometries | |||
Geometries are responsible for calculating several geometric properties, such as the normal vector, shape function values at a given position and the (inverse/determinant of the) Jacobian. This folder contains custom geometries that are used in the GeoMechanicsApplication. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I remember, the inverse of jacobian is not defined for this geometry!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed, for our geometry, the inverse is not defined. This first part is a short intro on geometries in general (which could have them defined). Do you think we should mention explicitly here that the inverse of the jacobian is not implemented for the interface (because it isn't for the underlying lines?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is not necessary to mention that the inverse Jacobian is not calculated/defined for this geometry. It is too much details. So, maybe it is good to leave the text as it is.
At this point, the 2+2 and 3+3 line interface geometries are implemented. | ||
When creating The 2+2 line interface geometry (by inputting 4 nodes), the following node numbering is used: | ||
|
||
![2Plus2NodedGeometry](2Plus2NodedLineGeometry.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs to define the local coordinate in the picture
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think x-y is irrelevant here. It is in xi , one dimensional local coordinate(s).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the quick review, I processed the comments, let me know if this is what you had in mind.
@@ -0,0 +1,18 @@ | |||
# Custom Geometries | |||
Geometries are responsible for calculating several geometric properties, such as the normal vector, shape function values at a given position and the (inverse/determinant of the) Jacobian. This folder contains custom geometries that are used in the GeoMechanicsApplication. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed, for our geometry, the inverse is not defined. This first part is a short intro on geometries in general (which could have them defined). Do you think we should mention explicitly here that the inverse of the jacobian is not implemented for the interface (because it isn't for the underlying lines?)
|
||
![3Plus3NodedGeometry](3Plus3NodedLineGeometry.svg) | ||
|
||
One thing to note, is that this line interface geometry does not implement functions from the Geometry base class which are related to the integration scheme. That is because most of the time, interface geometries are used with a Lobatto integration scheme, which is not supported by the Geometry base class. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I added links to the line_2d_2.h and line_2d_3.h files.
## Line Interface Geometry | ||
The Line Interface Geometry is a custom geometry that can be used to define a line interface between two different domains. | ||
|
||
The geometry is defined by two lines, one on each side of the interface, where they can connect to the larger body of the domains separated by the interface. Most calculations are performed on the 'midline', which is defined by the midpoints of the two lines. They are depicted as the grey lines in the figures below. Meaning that if a certain property is queried at a certain position, the call is forwarded to the underlying midline geometry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, let me know if this was what you meant!
At this point, the 2+2 and 3+3 line interface geometries are implemented. | ||
When creating The 2+2 line interface geometry (by inputting 4 nodes), the following node numbering is used: | ||
|
||
![2Plus2NodedGeometry](2Plus2NodedLineGeometry.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rfaasse
Thank you for adressing the review points. I still have few minor suggestions
@@ -0,0 +1,18 @@ | |||
# Custom Geometries | |||
Geometries are responsible for calculating several geometric properties, such as the normal vector, shape function values at a given position and the (inverse/determinant of the) Jacobian. This folder contains custom geometries that are used in the GeoMechanicsApplication. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is not necessary to mention that the inverse Jacobian is not calculated/defined for this geometry. It is too much details. So, maybe it is good to leave the text as it is.
At this point, the 2+2 and 3+3 line interface geometries are implemented. | ||
When creating The 2+2 line interface geometry (by inputting 4 nodes), the following node numbering is used: | ||
|
||
![2Plus2NodedGeometry](2Plus2NodedLineGeometry.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think x-y is irrelevant here. It is in xi , one dimensional local coordinate(s).
|
||
Similarly, the 3+3 line interface geometry has the following node numbering for its six nodes: | ||
|
||
![3Plus3NodedGeometry](3Plus3NodedLineGeometry.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is more clear if the length is mentioned here, namely -1 to +1. However, as it is a dependent geometry, maybe a full picture is needs in the original geometry. So, I leave it up to you!!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to go for me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok to me
No description provided.