-
Notifications
You must be signed in to change notification settings - Fork 12
Update FW docs part 1 #3592
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
Update FW docs part 1 #3592
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3592 +/- ##
=======================================
Coverage 36.27% 36.28%
=======================================
Files 88 88
Lines 22231 22231
=======================================
+ Hits 8065 8066 +1
+ Misses 14166 14165 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
3183d11
to
cf5b42a
Compare
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.
Copilot reviewed 11 out of 13 changed files in this pull request and generated no comments.
Files not reviewed (2)
- source/fortran/fwbs_variables.f90: Language not supported
- tests/regression/input_files/st_regression.IN.DAT: Language not supported
Comments suppressed due to low confidence (3)
process/fw.py:351
- The parameter name in the docstring (':param t:') does not match the function signature ('temp'). Consider updating the docstring to use 'temp' for consistency.
def fw_thermal_conductivity(self, temp: float) -> float:
documentation/proc-pages/eng-models/fw-blanket.md:87
- There appears to be a typographical error in the image title ('First walld'). Consider correcting it to 'First wall'.
<img title="First walld" src="../../images/first_wall.png">
documentation/proc-pages/eng-models/fw-blanket.md:147
- The formula contains a double '×' which may be a typographical error. Please verify and correct the expression if needed.
× ×
90f70b7
to
d223d37
Compare
process/hcpb.py
Outdated
ccfe_hcpb_module.ip = int(output) | ||
ccfe_hcpb_module.ofile = self.outfile |
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 removed these a while back iirc
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.
Minor changes and a question, otherwise happy with the docs.
a0a66f5
to
07a01d5
Compare
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.
A NaN is occurring in the stellarator codes (see regression test failures) and the unit tests are failing and must be fixed.
… descriptions and improved formatting
…nductivity method with detailed parameter descriptions and references
…date related references throughout the codebase
…ers in Haaland equation and enhance documentation for clarity
…date related references throughout the codebase
…e roughness and radius parameters, and update related tests for improved clarity and functionality
…r heat transfer coefficient variable for clarity
…arameter descriptions in the Fw class
…od for improved code organization and clarity
…uracy. adjust expected values in tests
9a9829f
to
cf9064b
Compare
…roved geometry handling
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.
Happy with the docs.
Description
This pull request includes changes to the documentation and codebase related to the first wall (FW) thermo-hydraulic model and calculations. The changes primarily focus on updating variable names, improving documentation clarity, and enhancing the calculation methods.
🔄 Variable changes
roughness
->roughness_fw_channel
Documentation Updates:
documentation/proc-pages/eng-models/fw-blanket.md
to reflect the new naming conventions, such as changingroughness
toroughness_fw_channel
and adding detailed descriptions of the FW temperature calculation and heat transfer processes.Codebase Updates:
process/blanket_library.py
to use the new variableroughness_fw_channel
in thethermo_hydraulic_model
andpressure_drop
methods.set_fw_geometry
inprocess/fw.py
to set the geometry parameters for the first wall and updated thefw_temp
method to use the new variable names and improve the calculation process.These changes enhance the clarity and accuracy of the first wall thermo-hydraulic model documentation and improve the consistency and reliability of the related codebase.
Checklist
I confirm that I have completed the following checks: