♻️ Refactor Availability module part1

documentation/eng-models/plant-availability.md

@@ -1,15 +1,23 @@
 # Plant Availability
 
-Switch `iavail` is used to control how the overall plant availability factor `cfactr` is calculated, as follows:
+Switch `i_plant_availability` is used to control how the overall plant availability factor `f_t_plant_available` is calculated, as follows:
 
-If `iavail = 0`, the input value of `cfactr` is used.
+If `i_plant_availability = 0`, the input value of `f_t_plant_available` is used.
+
+If `i_plant_availability = 1`, a model by N. Taylor and D. Ward[^1] is used instead, in which `f_t_plant_available` is calculated taking into account the time taken to replace certain components of the fusion power core, and various unplanned unavailability fractions which may be set by the user, as summerised in Table 1.
+
+------------------
+
+## Availability Class | `Availability`
+
+
+### Taylor-Ward 1999 Model | `avail()`
 
-If `iavail = 1`, a model by N. Taylor and D. Ward[^1] is used instead, in which `cfactr` is calculated taking into account the time taken to replace certain components of the fusion power core, and various unplanned unavailability fractions which may be set by the user, as summerised in Table 1.
 
 | Input parameter | Description |
 | :-: | - |
-| `tbktrepl` | time needed to replace blanket (years) |
-| `tdivrepl` | time needed to replace divertor (years) |
+| `t_blkt_replace_yrs` | time needed to replace blanket (years) |
+| `t_div_replace_yrs` | time needed to replace divertor (years) |
 | `tcomrepl` | time  needed to replace both blanket and divertor (years) |
 | `uubop` | unplanned unavailability of balance of plant |
 | `uucd` | unplanned unavailability of current drive system |
@@ -19,9 +27,13 @@ If `iavail = 1`, a model by N. Taylor and D. Ward[^1] is used instead, in which
 | `uumag` | unplanned unavailability of magnets |
 | `uuves` | unplanned unavailability of vessel |
 
-Table 3.4: *Summary of the variables in `PROCESS` that relate to the Taylor-Ward availability model (`iavail=1`).*
+Table 3.4: *Summary of the variables in `PROCESS` that relate to the Taylor-Ward availability model (`i_plant_availability=1`).*
 
-If `iavail = 2`, the new Morris model is implemented[^2]. It estimates both planned and unplanned unavailability, and the time during which no power is being generated if the reactor is pulsed.
+---------------------
+
+### Morris 2015 Model | `avail_2()`
+
+If `i_plant_availability = 2`, the new Morris model is implemented[^2]. It estimates both planned and unplanned unavailability, and the time during which no power is being generated if the reactor is pulsed.
 
 The panned unavailability is linked to the lifetime of the blanket and the time taken to replace them. The lifetime of the blanket is based on the allowable fast neutron fluence. In contrast, the lifetime of the divertor is estimated using the particle and photon load. The time to replace the blanket and divertor have been estimated by Crofts et al, who studied the influence of the number of remote handling systems working in parallel. `PROCESS` uses a simple fit to their results, and adds a month to allow the dose rate to reduce to an acceptable level before remote handling operations start, and a month to allow for pump-down and preparation for operation for operation at the enf of the shutdown.
 
@@ -33,7 +45,11 @@ The unplanned downtime for the blanket is based on the number of cycles it exper
 
 It is assumed that the vacuum system can be maintained in parallel with blanket replacement, so it does not contribute to the planned downtime. The unplanned downtime is baed on an assumed failure rate for a cryo-pump, and a specified total number pumps, with some of them being redundant. The resulting downtime can be reduced to a negligible level if there are several redundant pumps, but in addition, there is a fixed unavailability to allow for common mode failures affecting several pumps.
 
-If `iavail = 3`, the availability model for Spherical Tokamaks (ST) is implemented. 
+-------------------
+
+### ST Model 2023 | `avail_st()`
+
+If `i_plant_availability = 3`, the availability model for Spherical Tokamaks (ST) is implemented. 
 
 This model takes the user-specified time to replace a centrepost `tmain` and the centrepost lifetime `cplife` (calculated, see below) and calculates the number of maintenance cycles
 
@@ -59,16 +75,53 @@ $$ A_{\text{tot}} = 1 - (U_{\text{planned}} + U_{\text{unplanned}} + U_{\text{pl
 
 where $U_{\text{unplanned}}$ is unplanned unavailability. The cross term takes account of overlap between planned and unplanned unavailability.
 
-This model uses the unplanned unavailability calculations implemented in `iavail = 2` (see above). This includes the magnets, divertor, first wall and blanket, balance of plant, heating and current drive, and vacuum systems. The centrepost unplanned unavailability $U_{\text{unplanned,CP}}$ is provided by the user i.e. how often do you expect the centrepost to break over its lifetime. These unplanned unavailabilities are then added to $U_{\text{unplanned,CP}}$ to give $U_{\text{unplanned}}$.
+This model uses the unplanned unavailability calculations implemented in `i_plant_availability = 2` (see above). This includes the magnets, divertor, first wall and blanket, balance of plant, heating and current drive, and vacuum systems. The centrepost unplanned unavailability $U_{\text{unplanned,CP}}$ is provided by the user i.e. how often do you expect the centrepost to break over its lifetime. These unplanned unavailabilities are then added to $U_{\text{unplanned,CP}}$ to give $U_{\text{unplanned}}$.
 
 Finally, the capcity factor is given by
 
 $$ C = A_{\text{tot}} (t_{\text{burn}} / t_{\text{cycle}}) $$
 
 where $t_{\text{burn}}$ is the burn time and $t_{\text{cycle}}$ is the full cycle time.
 
+
+-------------------------
+
+### Planned unavailability | `calc_u_planned()`
+
+
+
+------------------------
+
+### Unplanned unavailability magnets | `calc_u_unplanned_magnets()`
+
+-------------------------
+
+### Unplanned unavailability divertor | `calc_u_unplanned_divertor()`
+
+-------------------------
+
+### Unplanned unavailability fwbs | `calc_u_unplanned_fwbs()`
+
+-------------------------
+
+### Unplanned unavailability BOP | `calc_u_unplanned_bop()`
+
+-------------------------
+
+### Unplanned unavailability HCD | `calc_u_unplanned_hcd()`
+
+-------------------------
+
+### Unplanned unavailability vacuum | `calc_u_unplanned_vacuum()`
+
+-------------------------
+
+
+
 ## Centrepost Lifetime
 
+--------------
+
 All availability models in PROCESS require the calculation of the centerpost lifetime, which is detailed here.
 
 !!! Note "Note" 
@@ -86,6 +139,8 @@ $$ t_{\text{CP,life}} = \min(f_{\text{CP, allowable}}/P_{\text{wall}}, t_{\text{
 
 where $f_{\text{CP, allowable}}$ is the allowable centrepost neutron fluence and $P_{\text{wall}}$ is the average neutron wall load ($\mathrm{MW} \mathrm{m}^{-2}$).
 
+---------------
+
 ## Divertor lifetime
 
 The divertor lifetime is calculated as
@@ -94,6 +149,11 @@ $$ t_{\text{div, life}} = \max (0, \min(f_{\text{div, allowable}} / P_{\text{div
 
 where $f_{\text{div, allowable}}$ is the allowable divertor heat fluence ($\mathrm{MW}\text{-}\mathrm{yr} \mathrm{m}^{-2}$) and $P_{\text{div}}$ is the heat load to the divertor ($\mathrm{MW} \mathrm{m}^{-2}$).
 
+
+----------------
+
+
+
 [^1]: P. J. Knight, *"PROCESS 3020: Plant Availability Model"*, Work File Note
 F/PL/PJK/PROCESS/CODE/<br>
 [^2]: M. Kovari, F. Fox, C. Harrington, R. Kembleton, P. Knight, H. Lux, J. Morris *"PROCESS: a systems code for fusion power plants - Part 2: Engineering"*, Fus. Eng. & Des. 104, 9-20 (2016)

documentation/io/python-lib-guide.md

@@ -49,7 +49,7 @@ To change the value or add/remove a regular input
 ```python
 # Add parameter will change the parameter value if it already exists
 i.add_parameter("blnktthdsd", 0.5)
-i.add_parameter("iavail", 1)
+i.add_parameter("i_plant_availability", 1)
 i.remove_parameter("blnkithsddd")
 i.remove_parameter("dr_blkt_inboard")
 i.add_parameter("sweep", [3.0, 3.0])

examples/data/large_tokamak_1_MFILE.DAT

@@ -268,7 +268,7 @@ TF_coil_conduit_stress_upper_lim__normalised_residue_____________________ (eq_co
 # Final Feasible Point #
 # Power Reactor Costs (1990 US$) #
 First_wall_/_blanket_life_(years)________________________________________ (life_blkt)____________________ 4.87888030705478215e+00 
-Divertor_life_(years)____________________________________________________ (divlife_cal)__________________ 1.02473304239948826e+00 
+Divertor_life_(years)____________________________________________________ (life_div)________________ 1.02473304239948826e+00 
 Cost_of_electricity_(m$/kWh)_____________________________________________ (coe)__________________________ 5.09300727575910003e+02 
 # Detailed Costings (1990 US$) #
 Acc.22_multiplier_for_Nth_of_a_kind______________________________________ (fkind)________________________ 1.00000000000000000e+00 
@@ -394,10 +394,10 @@ Total_capital_investment_(M$)____________________________________________ (capco
 Allowable_blanket_neutron_fluence_(MW-yr/m2)_____________________________ (abktflnc)_____________________ 5.00000000000000000e+00 
 Allowable_divertor_heat_fluence_(MW-yr/m2)_______________________________ (adivflnc)_____________________ 7.00000000000000000e+00 
 First_wall_/_blanket_lifetime_(years)____________________________________ (life_blkt_fpy)________________ 6.09860038381847769e+00 OP 
-Divertor_lifetime_(years)________________________________________________ (divlife)______________________ 1.28091630299936021e+00 OP 
-Heating/CD_system_lifetime_(years)_______________________________________ (cdrlife)______________________ 6.09860038381847769e+00 OP 
-Total_plant_lifetime_(years)_____________________________________________ (tlife)________________________ 3.00000000000000000e+01 
-Total_plant_availability_fraction________________________________________ (cfactr)_______________________ 8.00000000000000044e-01 
+Divertor_lifetime_(years)________________________________________________ (life_div_fpy)______________________ 1.28091630299936021e+00 OP 
+Heating/CD_system_lifetime_(years)_______________________________________ (life_hcd_fpy)______________________ 6.09860038381847769e+00 OP 
+Total_plant_lifetime_(years)_____________________________________________ (life_plant)________________________ 3.00000000000000000e+01 
+Total_plant_availability_fraction________________________________________ (f_t_plant_available)_______________________ 8.00000000000000044e-01 
 Number_of_fusion_cycles_to_reach_allowable_fw/blanket_DPA________________ (bktcycles)____________________ 1.56507395752278735e+04 
 # Plasma #
 Tokamak_aspect_ratio_=_Conventional,_itart_=_0___________________________ (itart)________________________            0 
@@ -8210,10 +8210,10 @@ output_costs = 1
 cost_model = 0
 
 * Total plant availability fraction;
-cfactr = 0.80
+f_t_plant_available = 0.80
 
 * Switch for plant availability model
-iavail = 0
+i_plant_availability = 0
 
 * PF Coils *
 ************

examples/data/large_tokamak_2_MFILE.DAT

@@ -268,7 +268,7 @@ TF_coil_conduit_stress_upper_lim__normalised_residue_____________________ (eq_co
 # Final Feasible Point #
 # Power Reactor Costs (1990 US$) #
 First_wall_/_blanket_life_(years)________________________________________ (life_blkt)____________________ 5.17963270862489455e+00 
-Divertor_life_(years)____________________________________________________ (divlife_cal)__________________ 1.02532710123514570e+00 
+Divertor_life_(years)____________________________________________________ (life_div)________________ 1.02532710123514570e+00 
 Cost_of_electricity_(m$/kWh)_____________________________________________ (coe)__________________________ 5.34929618118524104e+02 
 # Detailed Costings (1990 US$) #
 Acc.22_multiplier_for_Nth_of_a_kind______________________________________ (fkind)________________________ 1.00000000000000000e+00 
@@ -394,10 +394,10 @@ Total_capital_investment_(M$)____________________________________________ (capco
 Allowable_blanket_neutron_fluence_(MW-yr/m2)_____________________________ (abktflnc)_____________________ 5.00000000000000000e+00 
 Allowable_divertor_heat_fluence_(MW-yr/m2)_______________________________ (adivflnc)_____________________ 7.00000000000000000e+00 
 First_wall_/_blanket_lifetime_(years)____________________________________ (life_blkt_fpy)________________ 6.47454088578111797e+00 OP 
-Divertor_lifetime_(years)________________________________________________ (divlife)______________________ 1.28165887654393207e+00 OP 
-Heating/CD_system_lifetime_(years)_______________________________________ (cdrlife)______________________ 6.47454088578111797e+00 OP 
-Total_plant_lifetime_(years)_____________________________________________ (tlife)________________________ 3.00000000000000000e+01 
-Total_plant_availability_fraction________________________________________ (cfactr)_______________________ 8.00000000000000044e-01 
+Divertor_lifetime_(years)________________________________________________ (life_div_fpy)______________________ 1.28165887654393207e+00 OP 
+Heating/CD_system_lifetime_(years)_______________________________________ (life_hcd_fpy)______________________ 6.47454088578111797e+00 OP 
+Total_plant_lifetime_(years)_____________________________________________ (life_plant)________________________ 3.00000000000000000e+01 
+Total_plant_availability_fraction________________________________________ (f_t_plant_available)_______________________ 8.00000000000000044e-01 
 Number_of_fusion_cycles_to_reach_allowable_fw/blanket_DPA________________ (bktcycles)____________________ 1.66107236620331023e+04 
 # Plasma #
 Tokamak_aspect_ratio_=_Conventional,_itart_=_0___________________________ (itart)________________________            0 
@@ -8210,10 +8210,10 @@ output_costs = 1
 cost_model = 0
 
 * Total plant availability fraction;
-cfactr = 0.80
+f_t_plant_available = 0.80
 
 * Switch for plant availability model
-iavail = 0
+i_plant_availability = 0
 
 * PF Coils *
 ************

examples/data/large_tokamak_3_MFILE.DAT

@@ -268,7 +268,7 @@ TF_coil_conduit_stress_upper_lim__normalised_residue_____________________ (eq_co
 # Final Feasible Point #
 # Power Reactor Costs (1990 US$) #
 First_wall_/_blanket_life_(years)________________________________________ (life_blkt)____________________ 5.43373544317899348e+00 
-Divertor_life_(years)____________________________________________________ (divlife_cal)__________________ 1.02647128898011353e+00 
+Divertor_life_(years)____________________________________________________ (life_div)________________ 1.02647128898011353e+00 
 Cost_of_electricity_(m$/kWh)_____________________________________________ (coe)__________________________ 5.63699801678242579e+02 
 # Detailed Costings (1990 US$) #
 Acc.22_multiplier_for_Nth_of_a_kind______________________________________ (fkind)________________________ 1.00000000000000000e+00 
@@ -394,10 +394,10 @@ Total_capital_investment_(M$)____________________________________________ (capco
 Allowable_blanket_neutron_fluence_(MW-yr/m2)_____________________________ (abktflnc)_____________________ 5.00000000000000000e+00 
 Allowable_divertor_heat_fluence_(MW-yr/m2)_______________________________ (adivflnc)_____________________ 7.00000000000000000e+00 
 First_wall_/_blanket_lifetime_(years)____________________________________ (life_blkt_fpy)________________ 6.79216930397374163e+00 OP 
-Divertor_lifetime_(years)________________________________________________ (divlife)______________________ 1.28308911122514191e+00 OP 
-Heating/CD_system_lifetime_(years)_______________________________________ (cdrlife)______________________ 6.79216930397374163e+00 OP 
-Total_plant_lifetime_(years)_____________________________________________ (tlife)________________________ 3.00000000000000000e+01 
-Total_plant_availability_fraction________________________________________ (cfactr)_______________________ 8.00000000000000044e-01 
+Divertor_lifetime_(years)________________________________________________ (life_div_fpy)______________________ 1.28308911122514191e+00 OP 
+Heating/CD_system_lifetime_(years)_______________________________________ (life_hcd_fpy)______________________ 6.79216930397374163e+00 OP 
+Total_plant_lifetime_(years)_____________________________________________ (life_plant)________________________ 3.00000000000000000e+01 
+Total_plant_availability_fraction________________________________________ (f_t_plant_available)_______________________ 8.00000000000000044e-01 
 Number_of_fusion_cycles_to_reach_allowable_fw/blanket_DPA________________ (bktcycles)____________________ 1.74155681155038001e+04 
 # Plasma #
 Tokamak_aspect_ratio_=_Conventional,_itart_=_0___________________________ (itart)________________________            0 
@@ -8211,10 +8211,10 @@ output_costs = 1
 cost_model = 0
 
 * Total plant availability fraction;
-cfactr = 0.80
+f_t_plant_available = 0.80
 
 * Switch for plant availability model
-iavail = 0
+i_plant_availability = 0
 
 * PF Coils *
 ************

examples/data/large_tokamak_4_MFILE.DAT

@@ -268,7 +268,7 @@ TF_coil_conduit_stress_upper_lim__normalised_residue_____________________ (eq_co
 # Final Feasible Point #
 # Power Reactor Costs (1990 US$) #
 First_wall_/_blanket_life_(years)________________________________________ (life_blkt)____________________ 5.56530219956865579e+00 
-Divertor_life_(years)____________________________________________________ (divlife_cal)__________________ 1.03662639598136219e+00 
+Divertor_life_(years)____________________________________________________ (life_div)________________ 1.03662639598136219e+00 
 Cost_of_electricity_(m$/kWh)_____________________________________________ (coe)__________________________ 5.87092647488882903e+02 
 # Detailed Costings (1990 US$) #
 Acc.22_multiplier_for_Nth_of_a_kind______________________________________ (fkind)________________________ 1.00000000000000000e+00 
@@ -394,10 +394,10 @@ Total_capital_investment_(M$)____________________________________________ (capco
 Allowable_blanket_neutron_fluence_(MW-yr/m2)_____________________________ (abktflnc)_____________________ 5.00000000000000000e+00 
 Allowable_divertor_heat_fluence_(MW-yr/m2)_______________________________ (adivflnc)_____________________ 7.00000000000000000e+00 
 First_wall_/_blanket_lifetime_(years)____________________________________ (life_blkt_fpy)________________ 6.95662774946081974e+00 OP 
-Divertor_lifetime_(years)________________________________________________ (divlife)______________________ 1.29578299497670257e+00 OP 
-Heating/CD_system_lifetime_(years)_______________________________________ (cdrlife)______________________ 6.95662774946081974e+00 OP 
-Total_plant_lifetime_(years)_____________________________________________ (tlife)________________________ 3.00000000000000000e+01 
-Total_plant_availability_fraction________________________________________ (cfactr)_______________________ 8.00000000000000044e-01 
+Divertor_lifetime_(years)________________________________________________ (life_div_fpy)______________________ 1.29578299497670257e+00 OP 
+Heating/CD_system_lifetime_(years)_______________________________________ (life_hcd_fpy)______________________ 6.95662774946081974e+00 OP 
+Total_plant_lifetime_(years)_____________________________________________ (life_plant)________________________ 3.00000000000000000e+01 
+Total_plant_availability_fraction________________________________________ (f_t_plant_available)_______________________ 8.00000000000000044e-01 
 Number_of_fusion_cycles_to_reach_allowable_fw/blanket_DPA________________ (bktcycles)____________________ 1.78074347984943815e+04 
 # Plasma #
 Tokamak_aspect_ratio_=_Conventional,_itart_=_0___________________________ (itart)________________________            0 
@@ -8211,10 +8211,10 @@ output_costs = 1
 cost_model = 0
 
 * Total plant availability fraction;
-cfactr = 0.80
+f_t_plant_available = 0.80
 
 * Switch for plant availability model
-iavail = 0
+i_plant_availability = 0
 
 * PF Coils *
 ************

examples/data/large_tokamak_IN.DAT

@@ -522,10 +522,10 @@ output_costs = 1
 cost_model = 0
 
 * Total plant availability fraction;
-cfactr = 0.80
+f_t_plant_available = 0.80
 
 * Switch for plant availability model
-iavail = 0
+i_plant_availability = 0
 
 * PF Coils *
 ************