More namespace standards for physics and engineering variables

[chris-ashe]

Following on from #3353 a few more ideas have come up about standardising the namespace and increasing readability.

A general rule for naming could be of the form:

var = <data type>_<system>_<description>

For physics based variables it could just be:

var = <physics variable>_<description> Eg: beta_poloidal

Example for a switch that controls the different types of TF coil winding pack shapes:

i_tf_wp_shape

A few ideas that have come to mind are:

• r_ for radial positions

• z_ for vertical positions

• dr_ for radial thicknesses Example: ohcth -> dr_cs

• dz_ for vertical thicknesses

• n_ for integer countable items Example: The total number of TF coils = n_tf_coils

• b_ to represent magnetic field strengths

• a_ to represent areas? Example: TF winding pack area = a_tf_wp

• dt_ to represent time intervals

• dtor_ to represent toroidal thicknesses?

• p_ for powers

• t_ for times?

• l_ for generic lengths. This may cause confusion between a lower case L and a capital i. Maybe len_ would be better in this case

• c_ for currents?

• w_ for generic widths?

• m_ for masses`

• j_ for current densities

• res_ for resistances.

• den_ or rho_ for densities

Alot of the above may be overdoing it or could be combined.

@stuartmuldrew @mkovari @jonmaddock @geograham @j-a-foster @timothy-nunn Please add your comments and opinions. Hopefully this can start moving us to a more readable and verbose code.

[mkovari]

Looks good to me.

All the best, Michael From: Christopher Ashe @.> Sent: Thursday, November 28, 2024 4:19 PM To: ukaea/PROCESS @.> Cc: Kovari, Michael D @.>; Mention @.> Subject: [ukaea/PROCESS] More namespace standards for physics and engineering variables (Issue #3410)

Following on from #3353https://github.com/ukaea/PROCESS/pull/3353 a few more ideas have come up about standardising the namespace and increasing readability.

A general rule for naming could be of the form:

var =

Example for a switch that controls the different types of TF coil winding pack shapes:

i_tf_wp_shape

A few ideas that have come to mind are:

• r_ for radial positions
• z_ for vertical positions
• dr_ for radial thicknesses Example: ohcth -> dr_cs
• dz_ for vertical thicknesses
• n_ for integer countable items Example: The total number of TF coils = n_tf_coils
• b_ to represent magnetic field strengths
• a_ to represent areas?
• dt_ to represent time intervals
• dtor_ to represent toroidal thicknesses?
• p_ for powers
• t_ for times?
• l_ for generic lengths. This may cause confusion between a lower case L and a capital i
• c_ for currents?
• w_ for generic widths?

Alot of the above may be overdoing it or could be combined.

@stuartmuldrewhttps://github.com/stuartmuldrew @mkovarihttps://github.com/mkovari @jonmaddockhttps://github.com/jonmaddock @geograhamhttps://github.com/geograham @j-a-fosterhttps://github.com/j-a-foster @timothy-nunnhttps://github.com/timothy-nunn Please add your comments and opinions. Hopefully this can start moving us to a more readable and verbose code.

— Reply to this email directly, view it on GitHubhttps://github.com/ukaea/PROCESS/issues/3410, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ACKEVEADJUJFLEGPB6QBGO32C4653AVCNFSM6AAAAABSVPH5WCVHI2DSMVQWIX3LMV43ASLTON2WKOZSG4YDENRVGY2DEOI. You are receiving this because you were mentioned.Message ID: @.**@.>>