8000 Update FW docs part 1 by chris-ashe · Pull Request #3592 · ukaea/PROCESS · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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

Merged
merged 14 commits into from
May 16, 2025
Merged

Update FW docs part 1 #3592

merged 14 commits into from
May 16, 2025

Conversation

chris-ashe
Copy link
Collaborator
@chris-ashe chris-ashe commented Mar 18, 2025

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:

  • Updated variable names in documentation/proc-pages/eng-models/fw-blanket.md to reflect the new naming conventions, such as changing roughness to roughness_fw_channel and adding detailed descriptions of the FW temperature calculation and heat transfer processes.

Codebase Updates:

  • Updated process/blanket_library.py to use the new variable roughness_fw_channel in the thermo_hydraulic_model and pressure_drop methods.
  • Added a new method set_fw_geometry in process/fw.py to set the geometry parameters for the first wall and updated the fw_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:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@chris-ashe chris-ashe self-assigned this Mar 18, 2025
@chris-ashe chris-ashe added First Wall Documentation Improvements or additions to documentation labels Mar 18, 2025
@codecov-commenter
Copy link
codecov-commenter commented Mar 19, 2025

Codecov Report

Attention: Patch coverage is 82.35294% with 3 lines in your changes missing coverage. Please review.

Project coverage is 36.28%. Comparing base (89f2296) to head (1c4f627).

Files with missing lines Patch % Lines
process/fw.py 81.25% 3 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@chris-ashe chris-ashe force-pushed the update_fw_docs_1 branch 2 times, most recently from 3183d11 to cf5b42a Compare April 14, 2025 12:22
@chris-ashe chris-ashe requested a review from Copilot April 14, 2025 12:48
Copy link
Contributor
@Copilot Copilot AI left a 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.
× ×

@chris-ashe chris-ashe marked this pull request as ready for review April 14, 2025 12:50
@chris-ashe chris-ashe changed the title 🚧 Update FW docs Update FW docs part 1 Apr 14, 2025
process/hcpb.py Outdated
Comment on lines 43 to 44
ccfe_hcpb_module.ip = int(output)
ccfe_hcpb_module.ofile = self.outfile
Copy link
Contributor

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

Copy link
Collaborator
@j-a-foster j-a-foster left a 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.

@timothy-nunn timothy-nunn self-requested a review April 30, 2025 12:47
Copy link
Contributor
@timothy-nunn timothy-nunn left a 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.

chris-ashe added 11 commits May 16, 2025 10:00
…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
@timothy-nunn timothy-nunn self-requested a review May 16, 2025 09:35
Copy link
Collaborator
@j-a-foster j-a-foster left a 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.

@chris-ashe chris-ashe merged commit f9ebb46 into main May 16, 2025
18 checks passed
@timothy-nunn timothy-nunn deleted the update_fw_docs_1 branch May 16, 2025 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation First Wall
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0