❄️ Update cryostat docs#3501
Merged
timothy-nunn merged 16 commits intomainfrom Jan 31, 2025
Merged
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3501 +/- ##
==========================================
+ Coverage 30.83% 30.84% +0.01%
==========================================
Files 80 80
Lines 19322 19325 +3
==========================================
+ Hits 5958 5961 +3
Misses 13364 13364 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ff8c516 to
327bb37
Compare
fd8350f to
33eec1e
Compare
…or clarity and consistency
…n documentation and code
…in documentation and code
…tion and cryostat volume section for improved clarity
33eec1e to
17d23bf
Compare
j-a-foster
approved these changes
Jan 31, 2025
Collaborator
j-a-foster
left a comment
There was a problem hiding this comment.
Regression test failures are acceptable - only constraint variables have changed significantly. Happy for this to be merged.
6 tasks
ajpearcey
pushed a commit
that referenced
this pull request
Feb 26, 2025
* 🔄Rename variable rdewex to r_cryostat_inboard for clarity and consistency * 🔄 Rename variable rpf2dewar to dr_pf_cryostat for clarity and consistency * 🔄 Rename variable hcryopf to dz_pf_cryostat for clarity and consistency * 🔄 Rename variable zdewex to dz_cryostat_half_inside for clarity and consistency * 🔄 Rename variable vdewex to vol_cryostat for clarity and consistency * 🔄 Rename variable ddwex to dr_cryostat for clarity and consistency * 🔄 Rename variable dz_cryostat_half_inside to z_cryostat_half_inside for clarity and consistency * 🎨 Refactor external_cryo_geometry method for improved clarity and documentation * 🔄 Rename variable clhsf to f_z_cryostat for clarity and consistency in documentation and code * 🔄 Rename variable clh1 to dz_tf_cryostat for clarity and consistency in documentation and code * 🎨 Update cryostat documentation to include vertical clearance calculation and cryostat volume section for improved clarity * 🎨 Enhance cryostat documentation and comments for volume calculation clarity * 🧪 Update expected values in ExternalCryoGeometryParam test for accuracy * ❇️ Add `vol_cryostat_internal` to represent the void space inside the cryostat. * 🎨 Add cryostat_output method to output cryostat geometry details to the output file * 🔥 Remove redundant output variables from CCFE_HCPB class for cleaner code
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request includes several changes to the naming conventions for cryostat-related variables across multiple files, ensuring consistency and clarity in the codebase. The most important changes involve renaming variables and updating documentation to reflect these changes.
🔄 Namespace changes
Variables
rdewex->r_cryostat_inboardrpf2dewar->dr_pf_cryostathcryopf->dz_pf_cryostatzdewex->z_cryostat_half_insidevdewex->vol_cryostatddwex->dr_cryostatclhsf->f_z_cryostatclh1->dz_tf_cryostat✨ New additions
vol_cryostat_internal: Represents the internal volume of the cryostatcryostat_output(): New function to output the cryostat details in a dedicated functionNew output from
OUT.dat🐛 Bugs
Which wasnt easy to interpret so a new model for the cryostat structure volume has been introduced which is simply$m^3$ )
dividing the cryostat into 2 nested cylinders and taking the internal volume from the bigger one. This caused a 1% change in the calculated volume compared to the tests (
810 -> 818Checklist
I confirm that I have completed the following checks: