🔄 Rename fbetatry to fbeta_max for consistency across data files and …

…documentation
ukaea · Dec 16, 2024 · 3deffdb · 3deffdb
1 parent b7fbabf
commit 3deffdb
Show file tree

Hide file tree

Showing 35 changed files with 131 additions and 131 deletions.
diff --git a/documentation/proc-pages/fusion-devices/stellarator.md b/documentation/proc-pages/fusion-devices/stellarator.md
@@ -123,7 +123,7 @@ Stellarators try to achieve zero plasma current in order to allow safe divertor
 ### Beta limit
 
 The stellarator version calculates the plasma beta based on the input parameter and it is thus not necessary to Differently to the tokamak version, 
-The beta limit is assumed to be 5%, based on 3-D MHD calculations[^7]. To apply the beta limit, constraint equation no. 24 should be turned on with iteration variable no. 36 (`fbetatry`).
+The beta limit is assumed to be 5%, based on 3-D MHD calculations[^7]. To apply the beta limit, constraint equation no. 24 should be turned on with iteration variable no. 36 (`fbeta_max`).
 
 ### Density limit
 

diff --git a/documentation/proc-pages/physics-models/error.txt b/documentation/proc-pages/physics-models/error.txt
@@ -390,7 +390,7 @@ defined with respect to the total equilibrium \(\mathbf{B}\)-field
   Reactor Study', AEA Fusion Report AEA FUS 172 (1992)}. The beta
 coefficient \(g\) is set using input parameter \texttt{beta_norm_limit_upper}. To apply
 the beta limit, constraint equation no. 24 should be turned on with
-iteration variable no. 36 (\texttt{fbetatry}). The limit can be applied
+iteration variable no. 36 (\texttt{fbeta_max}). The limit can be applied
 to either the total plasma beta, in which case switch \texttt{iculbl}
 should be set to 0, to only the thermal component of the plasma beta, in
 which case \texttt{iculbl} should be set to 1, or to the thermal plus

diff --git a/documentation/proc-pages/physics-models/plasma_beta/plasma_beta.md b/documentation/proc-pages/physics-models/plasma_beta/plasma_beta.md
@@ -101,16 +101,16 @@ $$\begin{aligned}
 where $B_0$ is the axial vacuum toroidal field. The beta
 coefficient $g$ is set using input parameter `beta_norm_limit_upper`. To apply the beta limit, 
 constraint equation 24 should be turned on with iteration variable 36
-(`fbetatry`). 
+(`fbeta_max`). 
 
 By default, $\beta$ is defined with respect to the total equilibrium B-field [^2]. 
 
 | `i_beta_component` | Description |
 | :-: | - |
-| 0 (default) | Apply the $\beta$ limit to the total plasma beta (including the contribution from fast ions) |
+| 0 (default) | Apply the $\beta$ limit to the total plasma beta (including the contribution from fast alphas and  neutral beams) |
 | 1 | Apply the $\beta$ limit to only the thermal component of beta |
 | 2 | Apply the $\beta$ limit to only the thermal plus neutral beam contributions to beta |
-| 3 | Apply the $\beta$ limit to the total beta (including the contribution from fast ions), calculated using only the toroidal field |
+| 3 | Apply the $\beta$ limit to the total toroidal beta (including the contribution from fast alphas and neutral beams) |
 
 ### Setting the Beta $g$ Coefficient
 
@@ -173,7 +173,7 @@ This constraint can be activated by stating `icc = 24` in the input file.
 
 It is the general setting of the $\beta$ limit depending on the $\beta_{\text{N}}$ value calculated in the [beta limit](#beta-limit) calculations.
 
-The upper limit value of beta is calculated by `calculate_beta_limit()`. The scaling value `fbetatry` can be varied also.
+The upper limit value of beta is calculated by `calculate_beta_limit()`. The scaling value `fbeta_max` can be varied also.
 
 **It is recommended to have this constraint on as it is a plasma stability model**
 

diff --git a/examples/data/large_tokamak_1_MFILE.DAT b/examples/data/large_tokamak_1_MFILE.DAT
@@ -47,9 +47,9 @@
  fpnetel_________________________________________________________________ (itvar008)____________________      1.0000E+00    
  fpnetel_(final_value/initial_value)_____________________________________ (xcm008)______________________      1.0000E+00    
  fpnetel_(range_normalised)______________________________________________ (nitvar008)___________________      1.0000E+00    
- fbetatry________________________________________________________________ (itvar009)____________________      5.0870E-01    
- fbetatry_(final_value/initial_value)____________________________________ (xcm009)______________________      1.0174E+00    
- fbetatry_(range_normalised)_____________________________________________ (nitvar009)___________________      5.0821E-01    
+ fbeta_max________________________________________________________________ (itvar009)____________________      5.0870E-01    
+ fbeta_max_(final_value/initial_value)____________________________________ (xcm009)______________________      1.0174E+00    
+ fbeta_max_(range_normalised)_____________________________________________ (nitvar009)___________________      5.0821E-01    
  fpeakb__________________________________________________________________ (itvar010)____________________      8.6988E-01    
  fpeakb_(final_value/initial_value)______________________________________ (xcm010)______________________      8.6988E-01    
  fpeakb_(range_normalised)_______________________________________________ (nitvar010)___________________      8.6975E-01    
@@ -1278,8 +1278,8 @@ pnetelin = 400.0
 * Beta upper limit *
 *------------------*
 icc = 24
-ixc = 36 * fbetatry
-fbetatry = 0.5
+ixc = 36 * fbeta_max
+fbeta_max = 0.5
 
 * Max TF field *
 *--------------*

diff --git a/examples/data/large_tokamak_2_MFILE.DAT b/examples/data/large_tokamak_2_MFILE.DAT
@@ -47,9 +47,9 @@
  fpnetel_________________________________________________________________ (itvar008)____________________      1.0000E+00    
  fpnetel_(final_value/initial_value)_____________________________________ (xcm008)______________________      1.0000E+00    
  fpnetel_(range_normalised)______________________________________________ (nitvar008)___________________      1.0000E+00    
- fbetatry________________________________________________________________ (itvar009)____________________      4.0370E-01    
- fbetatry_(final_value/initial_value)____________________________________ (xcm009)______________________      1.0174E+00    
- fbetatry_(range_normalised)_____________________________________________ (nitvar009)___________________      5.0821E-01    
+ fbeta_max________________________________________________________________ (itvar009)____________________      4.0370E-01    
+ fbeta_max_(final_value/initial_value)____________________________________ (xcm009)______________________      1.0174E+00    
+ fbeta_max_(range_normalised)_____________________________________________ (nitvar009)___________________      5.0821E-01    
  fpeakb__________________________________________________________________ (itvar010)____________________      8.5988E-01    
  fpeakb_(final_value/initial_value)______________________________________ (xcm010)______________________      8.6988E-01    
  fpeakb_(range_normalised)_______________________________________________ (nitvar010)___________________      8.6975E-01    
@@ -1278,8 +1278,8 @@ pnetelin = 400.0
 * Beta upper limit *
 *------------------*
 icc = 24
-ixc = 36 * fbetatry
-fbetatry = 0.5
+ixc = 36 * fbeta_max
+fbeta_max = 0.5
 
 * Max TF field *
 *--------------*

diff --git a/examples/data/large_tokamak_3_MFILE.DAT b/examples/data/large_tokamak_3_MFILE.DAT
@@ -47,9 +47,9 @@
  fpnetel_________________________________________________________________ (itvar008)____________________      1.0000E+00    
  fpnetel_(final_value/initial_value)_____________________________________ (xcm008)______________________      1.0000E+00    
  fpnetel_(range_normalised)______________________________________________ (nitvar008)___________________      1.0000E+00    
- fbetatry________________________________________________________________ (itvar009)____________________      5.0870E-01    
- fbetatry_(final_value/initial_value)____________________________________ (xcm009)______________________      1.0174E+00    
- fbetatry_(range_normalised)_____________________________________________ (nitvar009)___________________      5.0821E-01    
+ fbeta_max________________________________________________________________ (itvar009)____________________      5.0870E-01    
+ fbeta_max_(final_value/initial_value)____________________________________ (xcm009)______________________      1.0174E+00    
+ fbeta_max_(range_normalised)_____________________________________________ (nitvar009)___________________      5.0821E-01    
  fpeakb__________________________________________________________________ (itvar010)____________________      8.6988E-01    
  fpeakb_(final_value/initial_value)______________________________________ (xcm010)______________________      8.4988E-01    
  fpeakb_(range_normalised)_______________________________________________ (nitvar010)___________________      8.6975E-01    
@@ -1278,8 +1278,8 @@ pnetelin = 400.0
 * Beta upper limit *
 *------------------*
 icc = 24
-ixc = 36 * fbetatry
-fbetatry = 0.5
+ixc = 36 * fbeta_max
+fbeta_max = 0.5
 
 * Max TF field *
 *--------------*

diff --git a/examples/data/large_tokamak_4_MFILE.DAT b/examples/data/large_tokamak_4_MFILE.DAT
@@ -47,9 +47,9 @@
  fpnetel_________________________________________________________________ (itvar008)____________________      1.7000E+00    
  fpnetel_(final_value/initial_value)_____________________________________ (xcm008)______________________      1.0000E+00    
  fpnetel_(range_normalised)______________________________________________ (nitvar008)___________________      1.0000E+00    
- fbetatry________________________________________________________________ (itvar009)____________________      5.3870E-01    
- fbetatry_(final_value/initial_value)____________________________________ (xcm009)______________________      1.0174E+00    
- fbetatry_(range_normalised)_____________________________________________ (nitvar009)___________________      5.0821E-01    
+ fbeta_max________________________________________________________________ (itvar009)____________________      5.3870E-01    
+ fbeta_max_(final_value/initial_value)____________________________________ (xcm009)______________________      1.0174E+00    
+ fbeta_max_(range_normalised)_____________________________________________ (nitvar009)___________________      5.0821E-01    
  fpeakb__________________________________________________________________ (itvar010)____________________      8.5988E-01    
  fpeakb_(final_value/initial_value)______________________________________ (xcm010)______________________      8.4988E-01    
  fpeakb_(range_normalised)_______________________________________________ (nitvar010)___________________      8.6975E-01    
@@ -1278,8 +1278,8 @@ pnetelin = 400.0
 * Beta upper limit *
 *------------------*
 icc = 24
-ixc = 36 * fbetatry
-fbetatry = 0.5
+ixc = 36 * fbeta_max
+fbeta_max = 0.5
 
 * Max TF field *
 *--------------*

diff --git a/examples/data/large_tokamak_IN.DAT b/examples/data/large_tokamak_IN.DAT
@@ -90,8 +90,8 @@ pnetelin = 400.0
 * Beta upper limit *
 *------------------*
 icc = 24
-ixc = 36 * fbetatry
-fbetatry = 0.5
+ixc = 36 * fbeta_max
+fbeta_max = 0.5
 
 * Max TF field *
 *--------------*