Define separate output parameter for Interest Rate instead of setting discountrate's preferred units to percent, addressing FIXME in outputs re: discount rate's unit discrepancy

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -846,7 +846,7 @@ def __init__(self, model: Model):
             Min=0.0,
             Max=1.0,
             UnitType=Units.PERCENT,
-            PreferredUnits=PercentUnit.PERCENT,
+            PreferredUnits=PercentUnit.TENTH,
             CurrentUnits=PercentUnit.TENTH,
             ErrMessage=f'assume default discount rate ({discount_rate_default_val})',
             ToolTipText="Discount rate used in the Standard Levelized Cost Model"
@@ -1712,6 +1712,12 @@ def __init__(self, model: Model):
             PreferredUnits=MassUnit.LB,
             CurrentUnits=MassUnit.LB
         )
+        self.interest_rate = self.OutputParameterDict[self.interest_rate.Name] = OutputParameter(
+            Name='Interest Rate',
+            UnitType=Units.PERCENT,
+            PreferredUnits=PercentUnit.PERCENT,
+            CurrentUnits=PercentUnit.PERCENT
+        )
         self.TotalRevenue = self.OutputParameterDict[self.TotalRevenue.Name] = OutputParameter(
             Name="Annual Revenue from Project",
             UnitType=Units.CURRENCYFREQUENCY,
@@ -2155,11 +2161,11 @@ def read_parameters(self, model: Model) -> None:
                 break
 
         coerce_int_params_to_enum_values(self.ParameterDict)
-        self.sync_discount_rate_and_fixed_internal_rate(model)
+        self.sync_interest_rate(model)
 
         model.logger.info(f'complete {__class__!s}: {sys._getframe().f_code.co_name}')
 
-    def sync_discount_rate_and_fixed_internal_rate(self, model):
+    def sync_interest_rate(self, model):
         if self.discountrate.Provided ^ self.FixedInternalRate.Provided:
             if self.discountrate.Provided:
                 self.FixedInternalRate.value = self.discountrate.quantity().to(
@@ -2180,6 +2186,8 @@ def sync_discount_rate_and_fixed_internal_rate(self, model):
                                  f'values ({self.discountrate.value}; {self.FixedInternalRate.quantity()}). '
                                  f'It is recommended to only provide one of these values.')
 
+        self.interest_rate.value = self.discountrate.quantity().to(convertible_unit(self.interest_rate.CurrentUnits)).magnitude
+
     def Calculate(self, model: Model) -> None:
         """
         The Calculate function is where all the calculations are done.

src/geophires_x/Outputs.py

@@ -23,6 +23,7 @@
     PlantType
 from geophires_x.GeoPHIRESUtils import UpgradeSymbologyOfUnits, render_default, InsertImagesIntoHTML
 from geophires_x.Parameter import Parameter
+from geophires_x.Units import convertible_unit, Units, PercentUnit
 
 NL = '\n'
 validFilenameChars = "-_.() %s%s" % (string.ascii_letters, string.digits)
@@ -1637,10 +1638,7 @@ def PrintOutputs(self, model: Model):
                     f.write(f'      Fixed Charge Rate (FCR):                          {model.economics.FCR.value*100.0:10.2f} ' + model.economics.FCR.CurrentUnits.value + NL)
                 elif model.economics.econmodel.value == EconomicModel.STANDARDIZED_LEVELIZED_COST:
                     f.write('      Economic Model = ' + model.economics.econmodel.value.value + NL)
-
-                    # FIXME discountrate should not be multiplied by 100 here -
-                    #  it appears to be incorrectly claiming its units are percent when the actual value is in tenths.
-                    f.write(f'      Interest Rate:                                    {model.economics.discountrate.value*100.0:10.2f} {model.economics.discountrate.CurrentUnits.value}\n')
+                    f.write(f'      {model.economics.interest_rate.Name}:                                    {model.economics.interest_rate.value:10.2f} {model.economics.interest_rate.CurrentUnits.value}\n')
 
                 elif model.economics.econmodel.value == EconomicModel.BICYCLE:
                     f.write('      Economic Model  = ' + model.economics.econmodel.value.value + NL)

src/geophires_x/SUTRAEconomics.py

@@ -330,6 +330,8 @@ def read_parameters(self, model: Model) -> None:
         else:
             model.logger.info('No parameters read because no content provided')
 
+        self.sync_interest_rate(model)
+
         model.logger.info(f'Complete {__class__!s}: {sys._getframe().f_code.co_name}')
 
     def Calculate(self, model: Model) -> None:

src/geophires_x/SUTRAOutputs.py

@@ -88,7 +88,7 @@ def PrintOutputs(self, model: Model):
 
                     # FIXME discountrate should not be multiplied by 100 here -
                     #  it appears to be incorrectly claiming its units are percent when the actual value is in tenths.
-                    f.write(f"      Interest Rate:                                    {model.economics.discountrate.value*100.0:10.2f} {model.economics.discountrate.CurrentUnits.value}\n")
+                    f.write(f'      {model.economics.interest_rate.Name}:                                    {model.economics.interest_rate.value:10.2f} {model.economics.interest_rate.CurrentUnits.value}\n')
 
                 elif model.economics.econmodel.value == EconomicModel.BICYCLE:
                     f.write("      Economic Model  = " + model.economics.econmodel.value.value + NL)

tests/examples/SUTRAExample1.out

@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.6.0
- Simulation Date: 2024-10-15
- Simulation Time:  13:07
- Calculation Time:      0.507 sec
+ GEOPHIRES Version: 3.6.2
+ Simulation Date: 2024-10-18
+ Simulation Time:  10:43
+ Calculation Time:      0.516 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -23,7 +23,7 @@ Simulation Metadata
                            ***ECONOMIC PARAMETERS***
 
       Economic Model = Standard Levelized Cost
-      Interest Rate:                                          7.00
+      Interest Rate:                                          7.00 %
       Accrued financing during construction:                  0.00 %
       Project lifetime:                                      30 yr