Internally distinguish between SAM econ royalty cost time series and main econ average annual value

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -13,7 +13,7 @@
 from geophires_x.EconomicsUtils import BuildPricingModel, wacc_output_parameter, nominal_discount_rate_parameter, \
     real_discount_rate_parameter, after_tax_irr_parameter, moic_parameter, project_vir_parameter, \
     project_payback_period_parameter, inflation_cost_during_construction_output_parameter, \
-    total_capex_parameter_output_parameter, royalties_opex_parameter_output_parameter
+    total_capex_parameter_output_parameter
 from geophires_x.GeoPHIRESUtils import quantity
 from geophires_x.OptionList import Configuration, WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PlantType, \
     _WellDrillingCostCorrelationCitation
@@ -1906,7 +1906,15 @@ def __init__(self, model: Model):
             PreferredUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
             CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR
         )
-        self.royalties_opex = self.OutputParameterDict[self.royalties_opex.Name] = royalties_opex_parameter_output_parameter()
+        self.royalties_average_annual_cost = self.OutputParameterDict[self.royalties_average_annual_cost.Name] = OutputParameter(
+            Name='Average Annual Royalty Cost',
+            UnitType=Units.CURRENCYFREQUENCY,
+            PreferredUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
+            CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
+            ToolTipText='The average annual cost paid to a royalty holder, calculated as a percentage of the '
+                        'project\'s gross annual revenue. This is modeled as a variable operating expense.'
+        )
+
 
         # district heating
         self.peakingboilercost = self.OutputParameterDict[self.peakingboilercost.Name] = OutputParameter(
@@ -2511,8 +2519,8 @@ def Calculate(self, model: Model) -> None:
                 self.sam_economics_calculations.royalties_opex.value[1:]  # ignore pre-revenue year(s) (Year 0)
             )
             if average_annual_royalties > 0:
-                self.royalties_opex.value = average_annual_royalties
-                self.Coam.value += self.royalties_opex.quantity().to(self.Coam.CurrentUnits.value).magnitude
+                self.royalties_average_annual_cost.value = average_annual_royalties
+                self.Coam.value += self.royalties_average_annual_cost.quantity().to(self.Coam.CurrentUnits.value).magnitude
 
             self.wacc.value = self.sam_economics_calculations.wacc.value
             self.nominal_discount_rate.value = self.sam_economics_calculations.nominal_discount_rate.value

src/geophires_x/EconomicsSam.py

@@ -39,7 +39,7 @@
     project_payback_period_parameter,
     inflation_cost_during_construction_output_parameter,
     total_capex_parameter_output_parameter,
-    royalties_opex_parameter_output_parameter,
+    royalty_cost_output_parameter,
 )
 from geophires_x.GeoPHIRESUtils import is_float, is_int, sig_figs, quantity
 from geophires_x.OptionList import EconomicModel, EndUseOptions
@@ -60,7 +60,7 @@ class SamEconomicsCalculations:
 
     capex: OutputParameter = field(default_factory=total_capex_parameter_output_parameter)
 
-    royalties_opex: OutputParameter = field(default_factory=royalties_opex_parameter_output_parameter)
+    royalties_opex: OutputParameter = field(default_factory=royalty_cost_output_parameter)
 
     project_npv: OutputParameter = field(
         default_factory=lambda: OutputParameter(

src/geophires_x/EconomicsUtils.py

@@ -146,12 +146,12 @@ def total_capex_parameter_output_parameter() -> OutputParameter:
     )
 
 
-def royalties_opex_parameter_output_parameter() -> OutputParameter:
+def royalty_cost_output_parameter() -> OutputParameter:
     return OutputParameter(
-            Name='Average Annual Royalty Cost',
+            Name='Royalty Cost',
             UnitType=Units.CURRENCYFREQUENCY,
             PreferredUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
             CurrentUnits=CurrencyFrequencyUnit.MDOLLARSPERYEAR,
-            ToolTipText='The average annual cost paid to a royalty holder, calculated as a percentage of the '
+            ToolTipText='The annual costs paid to a royalty holder, calculated as a percentage of the '
                         'project\'s gross annual revenue. This is modeled as a variable operating expense.'
         )

src/geophires_x/Outputs.py

@@ -556,8 +556,8 @@ def PrintOutputs(self, model: Model):
                         f.write(f'         {aoc_label}{model.addeconomics.AddOnOPEXTotalPerYear.value:10.2f} {model.addeconomics.AddOnOPEXTotalPerYear.CurrentUnits.value}\n')
 
                     if econ.royalty_rate.value > 0.0:
-                        royalties_label = Outputs._field_label(econ.royalties_opex.display_name, 47)
-                        f.write(f'         {royalties_label}{econ.royalties_opex.value:10.2f} {econ.royalties_opex.CurrentUnits.value}\n')
+                        royalties_label = Outputs._field_label(econ.royalties_average_annual_cost.display_name, 47)
+                        f.write(f'         {royalties_label}{econ.royalties_average_annual_cost.value:10.2f} {econ.royalties_average_annual_cost.CurrentUnits.value}\n')
 
                     f.write(f'      {econ.Coam.display_name}:            {(econ.Coam.value + econ.averageannualpumpingcosts.value + econ.averageannualheatpumpelectricitycost.value):10.2f} {econ.Coam.CurrentUnits.value}\n')
                 else: