Variable Renaming

[jonmaddock]

In GitLab by @jmorris-uk on Oct 3, 2019, 09:58

Summary

We have decided to start renaming the variables in PROCESS to have a more human readable format.

The new style of variables will be put onto the PROCESS documentation page to be used as a reference from there.

Naming conventions

Case

All variables should be lower case.

Length

Try to keep variable names to a sensible length. Abbreviations of some parts of the name are suitable e.g. div for divertor. Use underscores to separate words.

Physical Type

The physical type of the variable should form the first part of the variable name, e.g. for plasma resistance the variable should be named:

res_plasma = 1.0

Another example would be pulse length

time_pulse_length = 7200.0

Units

Inside PROCESS all variables should be in SI units unless otherwise stated. For example:

! Fusion power [W]
p_fusion = 1000.0d6

! Fusion power [MW]
p_fusion_mw = 1000.0d0

Coordinates and dimensions

Coordinates should be defined as

r_plasma_centre = 9.0d0

z_plasma_centre = 0.0d0

theta_ = 

For dimensions

dr_cs = 

dz_cs = 

dtheta_description =

Loop order

Loop variables that use I, j etc. should use

ii
    jj
        kk
            mm

Examples

Variable name	Description	Units
i_plasma	Plasma current	A
i_plasma_ma	Plasma current	MA
b_t_onaxis	Toroidal field on-axis	T
b_t_max	Max toroidal field	T
n_electron_vol	Volume average electron density	m-3
t_electron_vol_ev	Volume avgerage electron temperature	eV
m_steel	Mass of steel	kg
m_steel_tonne	Mass of steel	tonne
e_neutron_ev	Energy of neutron	eV
e_neutron_mev	Energy of neutron	MeV
v_tf_dump	TF dump voltage	V
time_plant_life	Plant lifetime	s
time_plant_life_yrs	Plant lifetime	years
dr_tf_inboard_leg	TF coil inboard leg radial thickness	m
dr_blanket_inboard	Inboard blanket thickness	m
velocity_coolant	TF centrepost coolant velocity	m/s
vol_plasma	Plasma volume	m3
a_plasma	Plasma area	m2
angle_div_target	Divertor target angle	radians
angle_div_target_deg	Divertor target angle	deg
sig_tf_r	TF radial stress	Pa
``

[jonmaddock]

In GitLab by @jmorris-uk on Oct 3, 2019, 10:37

@mkovari @ajpearcey @stuartmuldrew @asbrown @jonmaddock @skahn I think I have written down what we covered in the meeting.

Please add a comment to this issue if you think extra information needs to be added above. Otherwise I will begin to assign modules to people.

Also when renaming, if you want to discuss a particular variable use this issue to discuss.

[jonmaddock]

In GitLab by @skahn on Oct 4, 2019, 08:29

question :

Should we go for r_minor or dr_plasma ?

[jonmaddock]

In GitLab by @skahn on Oct 4, 2019, 08:47

General comment

We shoudl not go to the opposite extreme, which is having variables names that takes half of the line themselves.

For example, the inner radius of the inboard leg would be in this convention r_tf_inboard_leg_inner_side, which is a bit lengthy. Why not trying well defined acronym inleg for leg_inner and in for inner_side. Then r_tf_inboard_leg_inner_side becomes r_tf_inleg_in.

Cheers!
Seb

[jonmaddock]

In GitLab by @skahn on Nov 19, 2019, 15:45

mentioned in commit d131181247d5b475999f76855a04f36e963cd0c7

[jonmaddock]

In GitLab by @skahn on Nov 19, 2019, 16:34

mentioned in commit 419c9a4c9e6ff395d4efab9fcdc4d8f9cdfba2bf

[jonmaddock]

In GitLab by @jmorris-uk on Nov 20, 2019, 13:33

@asbrown could you update the GitLab pages with the renaming information from the issue. I believe there is already an empty page on the website for standards.

[jonmaddock]

In GitLab by @skahn on Nov 21, 2019, 16:38

To add on the table :
Number : no_
Height : z_/dz_

[jonmaddock]

In GitLab by @skahn on Feb 20, 2020, 10:51

For the toroidal thickness of the WP in the TF magnet, I am a bit idealess on the convention. This is not and angle, this us not a dr...

Is dtor ok for you ?

[jonmaddock]

In GitLab by @skahn on Dec 2, 2020, 11:37

@jmorris-uk, I think we should add a type, module abreviation and using table list.

Trying to do it at some point !

[jonmaddock]

In GitLab by @jmorris-uk on Jun 24, 2022, 11:06

@jonmaddock you could refer back to this when looking at naming conventions post-refactor. But the information should be in the documentation when you agree on what the standard should be.

[jonmaddock]

In GitLab by @jmorris-uk on Jun 24, 2022, 11:06

closed