3410 more namespace standards for physics and engineering variables#3416
Merged
chris-ashe merged 10 commits intomainfrom Dec 9, 2024
Merged
Conversation
…efixes for various data types
…es, pressures, voltages, currents, energies, and frequencies
…cies, and angles in documentation
…and new prefixes for velocities
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3416 +/- ##
==========================================
+ Coverage 28.27% 29.80% +1.53%
==========================================
Files 77 77
Lines 18428 20836 +2408
==========================================
+ Hits 5210 6211 +1001
- Misses 13218 14625 +1407 ☔ View full report in Codecov by Sentry. |
jonmaddock
approved these changes
Dec 6, 2024
Contributor
jonmaddock
left a comment
There was a problem hiding this comment.
Looks great Chris, thanks for doing this.
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.
This pull request includes significant updates to the variable naming conventions in the
documentation/proc-pages/development/standards.mdfile. The changes introduce a standardized scheme for naming variables based on their data type, system, description, and units. Additionally, specific prefixes for different types of variables are defined to improve readability and consistency.Variable Naming Conventions:
var = <data type>_<system>_<description>_<units>. For physics variables not belonging to a system, the scheme isvar = <physics variable>_<description>.r_), thicknesses (dr_), integer countable items (n_), number densities (nd_), areas (a_), volumes (vol_), lengths (len_), velocities (vel_), mass (m_), pressures (pres_), densities (den_), voltages (v_), resistances (res_), resistivity (rho_), currents (c_), inductances (h_), current densities (j_), powers (p_), energies (e_), temperatures (temp_), times (t_), magnetic field strengths (b_), frequencies (freq_), and angles (deg_orrad_).Updates to Existing Variables:
plasma_currentis nowc_plasma, andmass_steelis nowm_steel.## DescriptionChecklist
I confirm that I have completed the following checks: