-
Notifications
You must be signed in to change notification settings - Fork 33
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
add description of the plume feature #642
add description of the plume feature #642
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #642 +/- ##
==========================================
- Coverage 92.80% 92.78% -0.02%
==========================================
Files 92 105 +13
Lines 6474 7177 +703
==========================================
+ Hits 6008 6659 +651
- Misses 466 518 +52 see 24 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
|
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.
All text and pictures look good to me. @MFraters can you check if the structure that is suggested looks ok to you?
Plume | ||
====================== | ||
|
||
The plume feature allows it to add a mantle plume to a GWB world. Specifically, the plume is described in terms of its centerline and a number of cross sections. |
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.
Not wrong, but I would prefer:
The plume feature allows it to add a mantle plume to a GWB world. Specifically, the plume is described in terms of its centerline and a number of cross sections. | |
The plume feature allows to add a mantle plume to a GWB world. Specifically, the plume is described in terms of its centerline and a number of cross sections. |
The plume feature allows it to add a mantle plume to a GWB world. Specifically, the plume is described in terms of its centerline and a number of cross sections. | ||
The location of the centerline of the plume is prescribed through the `coordinates` and the `cross section depths` parameter. The coordinates express the location of the plume center projected onto the surface of the model. In other words, the coordinates are 2D points, defining the x and y location of the plume center (in a Cartesian geometry) or the latitude and longitude of the plume center (in a spherical geometry). The cross section depths describe the depth of each of these 2D points, and they have to be listed from top to bottom (in order of ascending depth). The plume centerline is then computed through a linear interpolation between these points. | ||
|
||
At each point on the plume centerline defined in this way, the shape of the cross section of the plume needs to be described. We assume that the cross section has an elliptical shape, so it can be defined in terms of the length of the semi-major axis, the direction of the semi-major axis, and the eccentricity of the ellipse. This combination of parameter allows it to prescribe a pipe-like structure with changing cross-sections. |
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.
Easier to read:
At each point on the plume centerline defined in this way, the shape of the cross section of the plume needs to be described. We assume that the cross section has an elliptical shape, so it can be defined in terms of the length of the semi-major axis, the direction of the semi-major axis, and the eccentricity of the ellipse. This combination of parameter allows it to prescribe a pipe-like structure with changing cross-sections. | |
At each central point defined in this way, the shape of the cross section of the plume needs to be described. We assume that the cross section has an elliptical shape, so it can be defined in terms of the length of the semi-major axis, the direction of the semi-major axis, and the eccentricity of the ellipse. This combination of parameters allows it to prescribe a pipe-like structure with changing cross-sections. |
I addressed your comments. |
doc/sphinx/user_manual/parameter_documentation/features/plume/plume.md
Outdated
Show resolved
Hide resolved
…plume.md Co-authored-by: Timo Heister <[email protected]>
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 writing this up and creating this new part for the manual!
No description provided.