Economics.py

import math
import sys
import os
import numpy as np
import Model
from OptionList import WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PowerPlantType
from Parameter import intParameter, floatParameter, OutputParameter, ReadParameter
from Units import *

class Economics:
    """
     Class to support the default economic calculations in GEOPHIRES
    """
    def __init__(self, model:Model):
        """
        The __init__ function is called automatically when a class is instantiated. 
        It initializes the attributes of an object, and sets default values for certain arguments that can be overridden by user input. 
        The __init__ function is used to set up all the parameters in Economics.
        
        :param self: Store data that will be used by the class
        :param model: The container class of the application, giving access to everything else, including the logger
        :return: None
        :doc-author: Malcolm Ross
        """

        model.logger.info("Init " + str(__class__) + ": " + sys._getframe().f_code.co_name)

        #Set up all the Parameters that will be predefined by this class using the different types of parameter classes.  Setting up includes giving it a name, a default value, The Unit Type (length, volume, temperature, etc) and Unit Name of that value, sets it as required (or not), sets allowable range, the error message if that range is exceeded, the ToolTip Text, and the name of teh class that created it.
        #This includes setting up temporary variables that will be available to all the class but noy read in by user, or used for Output
        #This also includes all Parameters that are calculated and then published using the Printouts function.
        #If you choose to sublass this master class, you can do so before or after you create your own parameters.  If you do, you can also choose to call this method from you class, which will effectively add and set all these parameters to your class.
         
        #These disctionarie contains a list of all the parameters set in this object, stored as "Parameter" and OutputParameter Objects.  This will alow us later to access them in a user interface and get that list, along with unit type, preferred units, etc. 
        self.ParameterDict = {}
        self.OutputParameterDict = {}
        
        #Note: setting Valid to False for any of the cost parmeters forces GEOPHIRES to use it's builtin cost engine.  This is the default.
        self.econmodel = self.ParameterDict[self.econmodel.Name] = intParameter("Economic Model", value = EconomicModel.STANDARDIZED_LEVELIZED_COST, AllowableRange=[1,2,3], Required=True, ErrMessage="assume default economic model (2)", ToolTipText="Specify the economic model to calculate the levelized cost of energy. 1: Fixed Charge Rate Model, 2: Standard Levelized Cost Model, 3: BICYCLE Levelized Cost Model")
        self.ccstimfixed = self.ParameterDict[self.ccstimfixed.Name] = floatParameter("Reservoir Stimulation Capital Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ToolTipText = "Total reservoir stimulation capital cost")
        self.ccstimadjfactor = self.ParameterDict[self.ccstimadjfactor.Name] = floatParameter("Reservoir Stimulation Capital Cost Adjustment Factor", value = 1.0, Min=0, Max=10, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = True, ToolTipText = "Multiplier for built-in reservoir stimulation capital cost correlation")
        self.ccexplfixed = self.ParameterDict[self.ccexplfixed.Name] = floatParameter("Exploration Capital Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ToolTipText = "Total exploration capital cost")
        self.ccexpladjfactor = self.ParameterDict[self.ccexpladjfactor.Name] = floatParameter("Exploration Capital Cost Adjustment Factor", value = 1.0, Min=0, Max=10, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = True, ToolTipText = "Multiplier for built-in exploration capital cost correlation")
        self.ccwellfixed = self.ParameterDict[self.ccwellfixed.Name] = floatParameter("Well Drilling and Completion Capital Cost", value = -1.0, Min=0, Max=200, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ToolTipText = "Well Drilling and Completion Capital Cost")
        self.ccwelladjfactor = self.ParameterDict[self.ccwelladjfactor.Name] = floatParameter("Well Drilling and Completion Capital Cost Adjustment Factor", value = 1.0, Min=0, Max=10, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = True, ToolTipText = "Well Drilling and Completion Capital Cost Adjustment Factor")
        self.oamwellfixed = self.ParameterDict[self.oamwellfixed.Name] = floatParameter("Wellfield O&M Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, Provided = False, Valid = False, ToolTipText = "Total annual wellfield O&M cost")
        self.oamwelladjfactor = self.ParameterDict[self.oamwelladjfactor.Name] = floatParameter("Wellfield O&M Cost Adjustment Factor", value = 1.0, Min=0, Max=10, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = True, ToolTipText = "Multiplier for built-in wellfield O&M cost correlation")
        self.ccplantfixed = self.ParameterDict[self.ccplantfixed.Name] = floatParameter("Surface Plant Capital Cost", value = -1.0, Min=0, Max=1000, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ToolTipText = "Total surface plant capital cost")
        self.ccplantadjfactor = self.ParameterDict[self.ccplantadjfactor.Name] = floatParameter("Surface Plant Capital Cost Adjustment Factor", value = 1.0, Min=0, Max=10, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = True, ToolTipText = "Multiplier for built-in surface plant capital cost correlation")
        self.ccgathfixed = self.ParameterDict[self.ccgathfixed.Name] = floatParameter("Field Gathering System Capital Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ToolTipText = "Total field gathering system capital cost")
        self.ccgathadjfactor = self.ParameterDict[self.ccgathadjfactor.Name] = floatParameter("Field Gathering System Capital Cost Adjustment Factor", value = 1.0, Min=0, Max=10, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = True, ToolTipText = "Multiplier for built-in field gathering system capital cost correlation")
        self.oamplantfixed = self.ParameterDict[self.oamplantfixed.Name] = floatParameter("Surface Plant O&M Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, Provided = False, Valid = False, ToolTipText = "Total annual surface plant O&M cost")
        self.oamplantadjfactor = self.ParameterDict[self.oamplantadjfactor.Name] = floatParameter("Surface Plant O&M Cost Adjustment Factor", value = 1.0, Min=0, Max=10, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = True, ToolTipText = "Multiplier for built-in surface plant O&M cost correlation")
        self.oamwaterfixed = self.ParameterDict[self.oamwaterfixed.Name] = floatParameter("Water Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, Provided = False, Valid = False, ToolTipText = "Total annual make-up water cost")
        self.oamwateradjfactor = self.ParameterDict[self.oamwateradjfactor.Name] = floatParameter("Water Cost Adjustment Factor", value = 1.0, Min=0, Max=10, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = True, ToolTipText = "Multiplier for built-in make-up water cost correlation")
        self.totalcapcost = self.ParameterDict[self.totalcapcost.Name] = floatParameter("Total Capital Cost", value = -1.0, Min=0, Max=1000, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ErrMessage="calculate total capital cost using user-provided costs or built-in correlations for each category.", ToolTipText="Total initial capital cost.")
        self.oamtotalfixed = self.ParameterDict[self.oamtotalfixed.Name] = floatParameter("Total O&M Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, Provided = False, Valid = False, ErrMessage="calculate total O&M cost using user-provided costs or built-in correlations for each category.", ToolTipText="Total initial O&M cost.")
        self.timestepsperyear = self.ParameterDict[self.timestepsperyear.Name] = intParameter("Time steps per year", value = 4, AllowableRange=list(range(1,101,1)), UnitType = Units.NONE, Required=True, ErrMessage="assume default number of time steps per year (4)", ToolTipText="Number of internal simulation time steps per year")
        self.FCR = self.ParameterDict[self.FCR.Name] = floatParameter("Fixed Charge Rate", value = 0.1, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default fixed charge rate (0.1)", ToolTipText="Fixed charge rate (FCR) used in the Fixed Charge Rate Model")
        self.discountrate = self.ParameterDict[self.discountrate.Name] = floatParameter("Discount Rate", value=0.07, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default discount rate (0.07)", ToolTipText="Discount rate used in the Standard Levelized Cost Model")
        self.FIB = self.ParameterDict[self.FIB.Name] = floatParameter("Fraction of Investment in Bonds", value = 0.5, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default fraction of investment in bonds (0.5)", ToolTipText="Fraction of geothermal project financing through bonds (see docs)")
        self.BIR = self.ParameterDict[self.BIR.Name] = floatParameter("Inflated Bond Interest Rate", value = 0.05, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default inflated bond interest rate (0.05)", ToolTipText="Inflated bond interest rate (see docs)")
        self.EIR = self.ParameterDict[self.EIR.Name] = floatParameter("Inflated Equity Interest Rate", value = 0.1, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default inflated equity interest rate (0.1)", ToolTipText="Inflated equity interest rate (see docs)")
        self.RINFL = self.ParameterDict[self.RINFL.Name] = floatParameter("Inflation Rate", value = 0.02, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default inflation rate (0.02)", ToolTipText="Inflation rate")
        self.CTR = self.ParameterDict[self.CTR.Name] = floatParameter("Combined Income Tax Rate", value = 0.02, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default combined income tax rate (0.3)", ToolTipText="Combined income tax rate (see docs)")
        self.GTR = self.ParameterDict[self.GTR.Name] = floatParameter("Gross Revenue Tax Rate", value = 0.02, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default gross revenue tax rate (0)", ToolTipText="Gross revenue tax rate (see docs)")
        self.RITC = self.ParameterDict[self.RITC.Name] = floatParameter("Investment Tax Credit Rate", value = 0.0, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default investment tax credit rate (0)", ToolTipText="Investment tax credit rate (see docs)")
        self.PTR = self.ParameterDict[self.PTR.Name] = floatParameter("Property Tax Rate", value = 0.0, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default property tax rate (0)", ToolTipText="Property tax rate (see docs)")
        self.inflrateconstruction = self.ParameterDict[self.inflrateconstruction.Name] = floatParameter("Inflation Rate During Construction", value = 0.0, Min=0.0, Max = 1.0, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, ErrMessage="assume default inflation rate during construction (0)")
        self.wellcorrelation = self.ParameterDict[self.wellcorrelation.Name] = intParameter("Well Drilling Cost Correlation", value = WellDrillingCostCorrelation.VERTICAL_SMALL, AllowableRange=[1,2,3,4], UnitType = Units.NONE, ErrMessage="assume default well drilling cost correlation (1)", ToolTipText="Select the built-in well drilling and completion cost correlation. 1: vertical open-hole, small diameter; 2: deviated liner, small diameter; 3: vertical open-hole, large diameter; 4: deviated liner, large diameter")
        
        #absorption chiller
        self.chillercapex = self.ParameterDict[self.chillercapex.Name] = floatParameter("Absorption Chiller Capital Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ToolTipText = "Absorption chiller capital cost")
        self.chilleropex = self.ParameterDict[self.chilleropex.Name] = floatParameter("Absorption Chiller O&M Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, Provided = False, Valid = False, ToolTipText = "Absorption chiller O&M cost")

        #heat pump
        self.heatpumpcapex = self.ParameterDict[self.heatpumpcapex.Name] = floatParameter("Heat Pump Capital Cost", value = -1.0, Min=0, Max=100, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ToolTipText = "Heat pump capital cost")

        #district heating
        self.ngprice = self.ParameterDict[self.ngprice.Name] = floatParameter("Peaking Fuel Cost Rate", value = 0.034, Min = 0.0, Max=1.0, UnitType = Units.ENERGYCOST, PreferredUnits = EnergyCostUnit.DOLLARSPERKWH, CurrentUnits = EnergyCostUnit.DOLLARSPERKWH, ErrMessage="assume default peaking fuel rate ($0.034/kWh)", ToolTipText="Price of peaking fuel for peaking boilers")
        self.peakingboilerefficiency = self.ParameterDict[self.peakingboilerefficiency.Name] = floatParameter("Peaking Boiler Efficiency", value = 0.85, Min=0, Max=1, UnitType = Units.PERCENT, PreferredUnits = PercentUnit.TENTH, CurrentUnits = PercentUnit.TENTH, Provided = False, Valid = False, ErrMessage="assume default peaking boiler efficiency (85%)", ToolTipText = "Peaking boiler efficiency")
        self.dhpipingcostrate = self.ParameterDict[self.dhpipingcostrate.Name] = floatParameter("District Heating Piping Cost Rate", value = 1200, Min=0, Max=10000, UnitType = Units.COSTPERLENGTH, PreferredUnits = CostPerLengthUnit.DOLLARSPERMETER, CurrentUnits = CostPerLengthUnit.DOLLARSPERMETER, Provided = False, Valid = False, ErrMessage="assume default district heating piping cost rate ($1,200/m)", ToolTipText = "District heating piping cost rate ($/m)")
        self.dhtotaldistrictnetworkcost = self.ParameterDict[self.dhtotaldistrictnetworkcost.Name] = floatParameter("Total District Heating Network Cost", value = 10, Min=0, Max=1000, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS, Provided = False, Valid = False, ErrMessage="assume default district heating network cost ($10M)", ToolTipText = "Total district heating network cost ($M)")
        self.dhoandmcost = self.ParameterDict[self.dhoandmcost.Name] = floatParameter("District Heating O&M Cost", value = 1, Min=0, Max=100, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, Provided = False, Valid = False, ToolTipText = "Total annual district heating O&M cost ($M/year)")
        self.dhpipinglength = self.ParameterDict[self.dhpipinglength.Name] = floatParameter("District Heating Network Piping Length", value = 10.0, Min= 0, Max=1000, UnitType = Units.LENGTH, PreferredUnits = LengthUnit.KILOMETERS, CurrentUnits = LengthUnit.KILOMETERS, ErrMessage="assume default district heating network piping length (10 km)", ToolTipText = "District heating network piping length (km)")
        self.dhroadlength = self.ParameterDict[self.dhroadlength.Name] = floatParameter("District Heating Road Length", value = 10.0, Min= 0, Max=1000, UnitType = Units.LENGTH, PreferredUnits = LengthUnit.KILOMETERS, CurrentUnits = LengthUnit.KILOMETERS, ErrMessage="assume default district heating road length (10 km)", ToolTipText = "District heating road length (km)")
        self.dhlandarea = self.ParameterDict[self.dhlandarea.Name] = floatParameter("District Heating Land Area", value = 10.0, Min= 0, Max=1000, UnitType = Units.AREA, PreferredUnits = AreaUnit.KILOMETERS2, CurrentUnits = AreaUnit.KILOMETERS2, ErrMessage="assume default district heating land area (10 km2)", ToolTipText = "District heating land area (km2)")
        self.dhpopulation = self.ParameterDict[self.dhpopulation.Name] = floatParameter("District Heating Population", value = 200, Min=0, Max = 1000000, UnitType = Units.NONE, ErrMessage="assume default population (200)", ToolTipText="Specify the population in the district heating network")
                

        #local variable initialization
        self.Claborcorrelation = 0.0
        self.Cpumps = 0.0
        self.annualelectricityincome = 0.0
        self.annualheatincome = 0.0
        self.InputFile = ""
        self.Cplantcorrelation = 0.0
        self.C1well = 0.0
        sclass = str(__class__).replace("<class \'", "")
        self.MyClass = sclass.replace("\'>","")
        self.MyPath = os.path.abspath(__file__)

        #results
        self.LCOE = self.OutputParameterDict[self.LCOE.Name] = OutputParameter(Name = "LCOE", value=0.0, UnitType = Units.ENERGYCOST, PreferredUnits = EnergyCostUnit.CENTSSPERKWH, CurrentUnits = EnergyCostUnit.CENTSSPERKWH)
        self.LCOH = self.OutputParameterDict[self.LCOH.Name] = OutputParameter(Name = "LCOH", value=0.0, UnitType = Units.ENERGYCOST, PreferredUnits = EnergyCostUnit.DOLLARSPERMMBTU, CurrentUnits = EnergyCostUnit.DOLLARSPERMMBTU)    #$/MMBTU
        self.LCOC = self.OutputParameterDict[self.LCOH.Name] = OutputParameter(Name = "LCOC", value=0.0, UnitType = Units.ENERGYCOST, PreferredUnits = EnergyCostUnit.DOLLARSPERMMBTU, CurrentUnits = EnergyCostUnit.DOLLARSPERMMBTU)    #$/MMBTU
        self.Cstim = self.OutputParameterDict[self.Cstim.Name] = OutputParameter(Name = "O&M Surface Plant costs", value=-999.9, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.Cexpl = self.OutputParameterDict[self.Cexpl.Name] = OutputParameter(Name = "Exploration cost", value=-999.9, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.Cwell = self.OutputParameterDict[self.Cwell.Name] = OutputParameter(Name = "Wellfield cost", value=-999.9, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.Coamwell = self.OutputParameterDict[self.Coamwell.Name] = OutputParameter(Name = "O&M Wellfield cost", value=-999.9, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)
        self.Cplant = self.OutputParameterDict[self.Cplant.Name] = OutputParameter(Name = "Surface Plant cost", value=-999.9, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.Coamplant = self.OutputParameterDict[self.Coamplant.Name] = OutputParameter(Name = "O&M Surface Plant costs", value=-999.9, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)
        self.Cgath = self.OutputParameterDict[self.Cgath.Name] = OutputParameter(Name = "Field gathering system cost", value=-999.9, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.Cpiping = self.OutputParameterDict[self.Cpiping.Name] = OutputParameter(Name = "Transmission pipeline costs", value=-999.9, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.Coamwater = self.OutputParameterDict[self.Coamwater.Name] = OutputParameter(Name = "O&M Make-up Water costs", value=-999.9, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)
        self.CCap = self.OutputParameterDict[self.CCap.Name] = OutputParameter(Name = "Total Capital Cost", value=-999.9, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.Coam = self.OutputParameterDict[self.Coam.Name] = OutputParameter(Name = "Total O & M Cost", value=-999.9, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)
        self.averageannualpumpingcosts = self.OutputParameterDict[self.averageannualpumpingcosts.Name] = OutputParameter(Name = "Average Annual Pumping Costs", value=-0.0, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)

        #heat pump
        self.averageannualheatpumpelectricitycost = self.OutputParameterDict[self.averageannualheatpumpelectricitycost.Name] = OutputParameter(Name = "Average Annual Heat Pump Electricity Cost", value=0.0, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)        
        
        #district heating
        self.peakingboilercost = self.OutputParameterDict[self.peakingboilercost.Name] = OutputParameter(Name = "Peaking boiler cost", value=0, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.dhdistrictcost = self.OutputParameterDict[self.dhdistrictcost.Name] = OutputParameter(Name = "District Heating System Cost", value=0, UnitType = Units.CURRENCY, PreferredUnits = CurrencyUnit.MDOLLARS, CurrentUnits = CurrencyUnit.MDOLLARS)
        self.populationdensity = self.OutputParameterDict[self.populationdensity.Name] = OutputParameter(Name = "District Heating System Population Density", value=0, UnitType = Units.POPDENSITY, PreferredUnits = PopDensityUnit.perkm2, CurrentUnits = PopDensityUnit.perkm2)
        self.annualngcost = self.OutputParameterDict[self.annualngcost.Name] = OutputParameter(Name = "Annual Peaking Fuel Cost", value=0, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)
        self.dhdistrictoandmcost = self.OutputParameterDict[self.dhdistrictoandmcost.Name] = OutputParameter(Name = "Annual District Heating O&M Cost", value=0, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)
        self.averageannualngcost = self.OutputParameterDict[self.averageannualngcost.Name] = OutputParameter(Name = "Average Annual Peaking Fuel Cost", value=0, UnitType = Units.CURRENCYFREQUENCY, PreferredUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR, CurrentUnits = CurrencyFrequencyUnit.MDOLLARSPERYEAR)        
        
        model.logger.info("Complete "+ str(__class__) + ": " + sys._getframe().f_code.co_name)

    def read_parameters(self, model:Model) -> None:
        """
        read_parameters read and update the Economics parmeters and handle the special cases 

        Args:
            model (Model): The container class of the application, giving access to everything else, including the logger
        """
        model.logger.info("Init " + str(__class__) + ": " + sys._getframe().f_code.co_name)

        #Deal with all the parameter values that the user has provided.  They should really only provide values that they want to change from the default values, but they can provide a value that is already set because it is a defaulr value set in __init__.  It will ignore those.
        #This also deals with all the special cases that need to be talen care of after a vlaue has been read in and checked.
        #If you choose to sublass this master class, you can also choose to override this method (or not), and if you do, do it before or after you call you own version of this method.  If you do, you can also choose to call this method from you class, which can effectively modify all these superclass parameters in your class.

        if len(model.InputParameters) > 0:
            #loop thru all the parameters that the user wishes to set, looking for parameters that match this object
            for item in self.ParameterDict.items():
                ParameterToModify = item[1]
                #print(ParameterToModify.Name)
                key = ParameterToModify.Name.strip()
                if key in model.InputParameters:
                    ParameterReadIn = model.InputParameters[key]
                    ParameterToModify.CurrentUnits = ParameterToModify.PreferredUnits    #Before we change the paremeter, let's assume that the unit preferences will match - if they don't, the later code will fix this.
                    ReadParameter(ParameterReadIn, ParameterToModify, model)   #this should handle all the non-special cases

                    #handle special cases
                    if ParameterToModify.Name == "Economic Model":
                        if ParameterReadIn.sValue == '1': ParameterToModify.value = EconomicModel.FCR
                        elif ParameterReadIn.sValue == '2': ParameterToModify.value = EconomicModel.STANDARDIZED_LEVELIZED_COST  #use standard LCOE/LCOH calculation as found on wikipedia (requries an interest rate).
                        else: ParameterToModify.value = EconomicModel.BICYCLE  #use Bicycle LCOE/LCOH model (requires several financial input parameters)
                    elif ParameterToModify.Name == "Well Drilling Cost Correlation":
                        if ParameterReadIn.sValue == '1': ParameterToModify.value = WellDrillingCostCorrelation.VERTICAL_SMALL
                        elif ParameterReadIn.sValue == '2': ParameterToModify.value = WellDrillingCostCorrelation.DEVIATED_SMALL
                        elif ParameterReadIn.sValue == '3': ParameterToModify.value = WellDrillingCostCorrelation.VERTCAL_LARGE
                        else: ParameterToModify.value = WellDrillingCostCorrelation.DEVIATED_LARGE
                    elif ParameterToModify.Name == "Reservoir Stimulation Capital Cost Adjustment Factor":
                        if self.ccstimfixed.Valid and ParameterToModify.Valid:
                            print("Warning: Provided reservoir stimulation cost adjustment factor not considered because valid total reservoir stimulation cost provided.")
                            model.logger.warning("Provided reservoir stimulation cost adjustment factor not considered because valid total reservoir stimulation cost provided.")
                        elif not self.ccstimfixed.Provided and not ParameterToModify.Provided:
                            ParameterToModify.value = 1.0
                            print("Warning: No valid reservoir stimulation total cost or adjustment factor provided. GEOPHIRES will assume default built-in reservoir stimulation cost correlation with adjustment factor = 1.")
                            model.logger.warning("No valid reservoir stimulation total cost or adjustment factor provided. GEOPHIRES will assume default built-in reservoir stimulation cost correlation with adjustment factor = 1.")
                        elif self.ccstimfixed.Provided and not self.ccstimfixed.Valid:
                            print("Warning: Provided reservoir stimulation cost outside of range 0-100. GEOPHIRES will assume default built-in reservoir stimulation cost correlation with adjustment factor = 1.")
                            model.logger.warning("Provided reservoir stimulation cost outside of range 0-100. GEOPHIRES will assume default built-in reservoir stimulation cost correlation with adjustment factor = 1.")
                            ParameterToModify.value = 1.0
                        elif not self.ccstimfixed.Provided and ParameterToModify.Provided and not ParameterToModify.Valid:
                            print("Warning: Provided reservoir stimulation cost adjustment factor outside of range 0-10. GEOPHIRES will assume default reservoir stimulation cost correlation with adjustment factor = 1.")
                            model.logger.warning("Provided reservoir stimulation cost adjustment factor outside of range 0-10. GEOPHIRES will assume default reservoir stimulation cost correlation with adjustment factor = 1.")
                            ParameterToModify.value = 1.0
                    elif ParameterToModify.Name == "Exploration Capital Cost Adjustment Factor":
                        if self.totalcapcost.Valid:
                            if self.ccexplfixed.Provided:
                                print("Warning: Provided exploration cost not considered because valid total capital cost provided.")
                                model.logger.warning("Warning: Provided exploration cost not considered because valid total capital cost provided.")
                            if ParameterToModify.Provided:
                                print("Warning: Provided exploration cost adjustment factor not considered because valid total capital cost provided.")
                                model.logger.warning("Warning: Provided exploration cost not considered because valid total capital cost provided.")
                        else:
                            if self.ccexplfixed.Valid and ParameterToModify.Valid:
                                print("Warning: Provided exploration cost adjustment factor not considered because valid total exploration cost provided.")
                                model.logger.warning("Provided exploration cost adjustment factor not considered because valid total exploration cost provided.")
                            elif not self.ccexplfixed.Provided and not ParameterToModify.Provided:
                                ParameterToModify.value = 1.0
                                print("Warning: No valid exploration total cost or adjustment factor provided. GEOPHIRES will assume default built-in exploration cost correlation with adjustment factor = 1.")
                                model.logger.warning("No valid exploration total cost or adjustment factor provided. GEOPHIRES will assume default built-in exploration cost correlation with adjustment factor = 1.")
                            elif self.ccexplfixed.Provided and not self.ccexplfixed.Valid:
                                print("Warning: Provided exploration cost outside of range 0-100. GEOPHIRES will assume default built-in exploration cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided exploration cost outside of range 0-100. GEOPHIRES will assume default built-in exploration cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                            elif not self.ccexplfixed.Provided and ParameterToModify.Provided and not ParameterToModify.Valid:
                                print("Warning: Provided exploration cost adjustment factor outside of range 0-10. GEOPHIRES will assume default exploration cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided exploration cost adjustment factor outside of range 0-10. GEOPHIRES will assume default exploration cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                    elif ParameterToModify.Name == "Well Drilling and Completion Capital Cost Adjustment Factor":
                        if self.ccwellfixed.Valid and ParameterToModify.Valid:
                            print("Warning: Provided well drilling and completion cost adjustment factor not considered because valid total well drilling and completion cost provided.")
                            model.logger.warning("Provided well drilling and completion cost adjustment factor not considered because valid total well drilling and completion cost provided.")
                        elif not self.ccwellfixed.Provided and not self.ccwelladjfactor.Provided:
                            ParameterToModify.value = 1.0
                            print("Warning: No valid well drilling and completion total cost or adjustment factor provided. GEOPHIRES will assume default built-in well drilling and completion cost correlation with adjustment factor = 1.")
                            model.logger.warning("No valid well drilling and completion total cost or adjustment factor provided. GEOPHIRES will assume default built-in well drilling and completion cost correlation with adjustment factor = 1.")
                        elif self.ccwellfixed.Provided and not self.ccwellfixed.Valid:
                            print("Warning: Provided well drilling and completion cost outside of range 0-1000. GEOPHIRES will assume default built-in well drilling and completion cost correlation with adjustment factor = 1.")
                            model.logger.warning("Provided well drilling and completion cost outside of range 0-1000. GEOPHIRES will assume default built-in well drilling and completion cost correlation with adjustment factor = 1.")
                            self.ccwelladjfactor.value = 1.0
                        elif not self.ccwellfixed.Provided and self.ccwelladjfactor.Provided and not self.ccwelladjfactor.Valid:
                            print("Warning: Provided well drilling and completion cost adjustment factor outside of range 0-10. GEOPHIRES will assume default built-in well drilling and completion cost correlation with adjustment factor = 1.")
                            model.logger.warning("Provided well drilling and completion cost adjustment factor outside of range 0-10. GEOPHIRES will assume default built-in well drilling and completion cost correlation with adjustment factor = 1.")
                            self.ccwelladjfactor.value = 1.0
                    elif ParameterToModify.Name == "Wellfield O&M Cost Adjustment Factor":
                        if self.oamtotalfixed.Valid:
                            if self.oamwellfixed.Provided:
                                print("Warning: Provided total wellfield O&M cost not considered because valid total annual O&M cost provided.")
                                model.logger.warning("Provided total wellfield O&M cost not considered because valid total annual O&M cost provided.")
                            if ParameterToModify.Provided:
                                print("Warning: Provided wellfield O&M cost adjustment factor not considered because valid total annual O&M cost provided.")
                                model.logger.warning("Provided wellfield O&M cost adjustment factor not considered because valid total annual O&M cost provided.")
                        else:
                            if self.oamwellfixed.Valid and ParameterToModify.Valid:
                                print("Warning: Provided wellfield O&M cost adjustment factor not considered because valid total wellfield O&M cost provided.")
                                model.logger.warning("Provided wellfield O&M cost adjustment factor not considered because valid total wellfield O&M cost provided.")
                            elif not self.oamwellfixed.Provided and not ParameterToModify.Provided:
                                ParameterToModify.value = 1.0
                                print("Warning: No valid total wellfield O&M cost or adjustment factor provided. GEOPHIRES will assume default built-in wellfield O&M cost correlation with adjustment factor = 1.")
                                model.logger.warning("No valid total wellfield O&M cost or adjustment factor provided. GEOPHIRES will assume default built-in wellfield O&M cost correlation with adjustment factor = 1.")
                            elif self.oamwellfixed.Provided and not self.oamwellfixed.Valid:
                                print("Warning: Provided total wellfield O&M cost outside of range 0-100. GEOPHIRES will assume default built-in wellfield O&M cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided total wellfield O&M cost outside of range 0-100. GEOPHIRES will assume default built-in wellfield O&M cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                            elif not self.oamwellfixed.Provided and self.oamwelladjfactor.Provided and not self.oamwelladjfactor.Valid:
                                print("Warning: Provided wellfield O&M cost adjustment factor outside of range 0-10. GEOPHIRES will assume default wellfield O&M cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided wellfield O&M cost adjustment factor outside of range 0-10. GEOPHIRES will assume default wellfield O&M cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                    elif ParameterToModify.Name == "Surface Plant Capital Cost Adjustment Factor":
                        if self.totalcapcost.Valid:
                            if self.ccplantfixed.Provided:
                                print("Warning: Provided surface plant cost not considered because valid total capital cost provided.")
                                model.logger.warning("Provided surface plant cost not considered because valid total capital cost provided.")
                            if ParameterToModify.Provided:
                                print("Warning: Provided surface plant cost adjustment factor not considered because valid total capital cost provided.")
                                model.logger.warning("Provided surface plant cost adjustment factor not considered because valid total capital cost provided.")
                        else:
                            if self.ccplantfixed.Valid and ParameterToModify.Valid:
                                print("Warning: Provided surface plant cost adjustment factor not considered because valid total surface plant cost provided.")
                                model.logger.warning("Provided surface plant cost adjustment factor not considered because valid total surface plant cost provided.")
                            elif not self.ccplantfixed.Provided and not ParameterToModify.Provided:
                                ParameterToModify.value = 1.0
                                print("Warning: No valid surface plant total cost or adjustment factor provided. GEOPHIRES will assume default built-in surface plant cost correlation with adjustment factor = 1.")
                                model.logger.warning("No valid surface plant total cost or adjustment factor provided. GEOPHIRES will assume default built-in surface plant cost correlation with adjustment factor = 1.")
                            elif self.ccplantfixed.Provided and not self.ccplantfixed.Valid:
                                print("Warning: Provided surface plant cost outside of range 0-1000. GEOPHIRES will assume default built-in surface plant cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided surface plant cost outside of range 0-1000. GEOPHIRES will assume default built-in surface plant cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                            elif not self.ccplantfixed.Provided and self.ccplantadjfactor.Provided and not self.ccplantadjfactor.Valid:
                                print("Warning: Provided surface plant cost adjustment factor outside of range 0-10. GEOPHIRES will assume default surface plant cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided surface plant cost adjustment factor outside of range 0-10. GEOPHIRES will assume default surface plant cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                    elif ParameterToModify.Name == "Field Gathering System Capital Cost Adjustment Factor":
                        if self.totalcapcost.Valid:
                            if self.ccgathfixed.Provided:
                                print("Warning: Provided field gathering system cost not considered because valid total capital cost provided.")
                                model.logger.warning("Provided field gathering system cost not considered because valid total capital cost provided.")
                            if ParameterToModify.Provided:
                                print("Warning: Provided field gathering system cost adjustment factor not considered because valid total capital cost provided.")
                                model.logger.warning("Provided field gathering system cost adjustment factor not considered because valid total capital cost provided.")
                        else:
                            if self.ccgathfixed.Valid and ParameterToModify.Valid:
                                print("Warning: Provided field gathering system cost adjustment factor not considered because valid total field gathering system cost provided.")
                                model.logger.warning("Provided field gathering system cost adjustment factor not considered because valid total field gathering system cost provided.")
                            elif not self.ccgathfixed.Provided and not ParameterToModify.Provided:
                                ParameterToModify.value = 1.0
                                print("Warning: No valid field gathering system total cost or adjustment factor provided. GEOPHIRES will assume default built-in field gathering system cost correlation with adjustment factor = 1.")
                                model.logger.warning("No valid field gathering system total cost or adjustment factor provided. GEOPHIRES will assume default built-in field gathering system cost correlation with adjustment factor = 1.")
                            elif self.ccgathfixed.Provided and not self.ccgathfixed.Valid:
                                print("Warning: Provided field gathering system cost outside of range 0-100. GEOPHIRES will assume default built-in field gathering system cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided field gathering system cost outside of range 0-100. GEOPHIRES will assume default built-in field gathering system cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                            elif not self.ccgathfixed.Provided and ParameterToModify.Provided and not ParameterToModify.Valid:
                                print("Warning: Provided field gathering system cost adjustment factor outside of range 0-10. GEOPHIRES will assume default field gathering system cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided field gathering system cost adjustment factor outside of range 0-10. GEOPHIRES will assume default field gathering system cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                    elif ParameterToModify.Name == "Water Cost Adjustment Factor":
                        if self.oamtotalfixed.Valid:
                            if self.oamwaterfixed.Provided:
                                print("Warning: Provided total water cost not considered because valid total annual O&M cost provided.")
                                model.logger.warning("Provided total water cost not considered because valid total annual O&M cost provided.")
                            if ParameterToModify.Provided:
                                print("Warning: Provided water cost adjustment factor not considered because valid total annual O&M cost provided.")
                                model.logger.warning("Provided water cost adjustment factor not considered because valid total annual O&M cost provided.")
                        else:
                            if self.oamwaterfixed.Valid and ParameterToModify.Valid:
                                print("Warning: Provided water cost adjustment factor not considered because valid total water cost provided.")
                                model.logger.warning("Provided water cost adjustment factor not considered because valid total water cost provided.")
                            elif not self.oamwaterfixed.Provided and not ParameterToModify.Provided:
                                ParameterToModify.value = 1.0
                                print("Warning: No valid total water cost or adjustment factor provided. GEOPHIRES will assume default built-in water cost correlation with adjustment factor = 1.")
                                model.logger.warning("No valid total water cost or adjustment factor provided. GEOPHIRES will assume default built-in water cost correlation with adjustment factor = 1.")
                            elif self.oamwaterfixed.Provided and not self.oamwaterfixed.Valid:
                                print("Warning: Provided total water cost outside of range 0-100. GEOPHIRES will assume default built-in water cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided total water cost outside of range 0-100. GEOPHIRES will assume default built-in water cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                            elif not self.oamwaterfixed.Provided and ParameterToModify.Provided and not ParameterToModify.Valid:
                                print("Warning: Provided water cost adjustment factor outside of range 0-10. GEOPHIRES will assume default water cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided water cost adjustment factor outside of range 0-10. GEOPHIRES will assume default water cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                    elif ParameterToModify.Name == "Surface Plant O&M Cost Adjustment Factor":
                        if self.oamtotalfixed.Valid:
                            if self.oamplantfixed.Provided:
                                print("Warning: Provided total surface plant O&M cost not considered because valid total annual O&M cost provided.")
                                model.logger.warning("Provided total surface plant O&M cost not considered because valid total annual O&M cost provided.")
                            if ParameterToModify.Provided:
                                print("Warning: Provided surface plant O&M cost adjustment factor not considered because valid total annual O&M cost provided.")
                                model.logger.warning("Provided surface plant O&M cost adjustment factor not considered because valid total annual O&M cost provided.")
                        else:
                            if self.oamplantfixed.Valid and ParameterToModify.Valid:
                                print("Warning: Provided surface plant O&M cost adjustment factor not considered because valid total surface plant O&M cost provided.")
                                model.logger.warning("Provided surface plant O&M cost adjustment factor not considered because valid total surface plant O&M cost provided.")
                            elif not self.oamplantfixed.Provided and not ParameterToModify.Provided:
                                ParameterToModify.value = 1.0
                                print("Warning: No valid surface plant O&M cost or adjustment factor provided. GEOPHIRES will assume default built-in surface plant O&M cost correlation with adjustment factor = 1.")
                                model.logger.warning("No valid surface plant O&M cost or adjustment factor provided. GEOPHIRES will assume default built-in surface plant O&M cost correlation with adjustment factor = 1.")
                            elif self.oamplantfixed.Provided and not self.oamplantfixed.Valid:
                                print("Warning: Provided surface plant O&M cost outside of range 0-100. GEOPHIRES will assume default built-in surface plant O&M cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided surface plant O&M cost outside of range 0-100. GEOPHIRES will assume default built-in surface plant O&M cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
                            elif not self.oamplantfixed.Provided and ParameterToModify.Provided and not ParameterToModify.Valid:
                                print("Warning: Provided surface plant O&M cost adjustment factor outside of range 0-10. GEOPHIRES will assume default surface plant O&M cost correlation with adjustment factor = 1.")
                                model.logger.warning("Provided surface plant O&M cost adjustment factor outside of range 0-10. GEOPHIRES will assume default surface plant O&M cost correlation with adjustment factor = 1.")
                                ParameterToModify.value = 1.0
        else:
            model.logger.info("No parameters read becuase no content provided")
        model.logger.info("complete "+ str(__class__) + ": " + sys._getframe().f_code.co_name)

    def Calculate(self, model:Model) -> None:
        """
        The Calculate function is where all the calculations are done.
        This function can be called multiple times, and will only recalculate what has changed each time it is called.
        
        :param self: Access variables that belongs to the class
        :param model: The container class of the application, giving access to everything else, including the logger
        :return: Nothing, but it does make calculations and set values in the model
        :doc-author: Malcolm Ross
        """
        model.logger.info("Init " + str(__class__) + ": " + sys._getframe().f_code.co_name)

        #This is where all the calcualtions are made using all the values that have been set.
        #If you sublcass this class, you can choose to run these calculations before (or after) your calculations, but that assumes you have set all the values that are required for these calculations
        #If you choose to sublass this master class, you can also choose to override this method (or not), and if you do, do it before or after you call you own version of this method.  If you do, you can also choose to call this method from you class, which can effectively run the calculations of the superclass, making all thr values available to your methods. but you had n=betteer have set all the paremeters!
        
        #-------------
        #capital costs
        #-------------
        #well costs (using GeoVision drilling correlations). These are calculated whether or not totalcapcostvalid = 1  
        if self.ccwellfixed.Valid:
            self.C1well = self.ccwellfixed.value
            self.Cwell.value = self.C1well*(model.wellbores.nprod.value+model.wellbores.ninj.value)
        else:
            if self.wellcorrelation.value == WellDrillingCostCorrelation.VERTICAL_SMALL:
                self.C1well = (0.3021*model.reserv.depth.value**2 + 584.9112*model.reserv.depth.value + 751368.)*1E-6 #well drilling and completion cost in M$/well
            elif self.wellcorrelation.value == WellDrillingCostCorrelation.DEVIATED_SMALL:
                self.C1well = (0.2898*model.reserv.depth.value**2 + 822.1507*model.reserv.depth.value + 680563.)*1E-6
            elif self.wellcorrelation.value == WellDrillingCostCorrelation.VERTICAL_LARGE:
                self.C1well = (0.2818*model.reserv.depth.value**2 + 1275.5213*model.reserv.depth.value + 632315.)*1E-6
            elif self.wellcorrelation.value == WellDrillingCostCorrelation.DEVIATED_LARGE:
                self.C1well = (0.2553*model.reserv.depth.value**2 + 1716.7157*model.reserv.depth.value + 500867.)*1E-6
            if model.reserv.depth.value < 500.:
                print ("Warning: drilling cost correlation extrapolated for drilling depth < 500 m")
                model.logger.warning("Drilling cost correlation extrapolated for drilling depth < 500 m")
            if model.reserv.depth.value > 7000.:
                print ("Warning: drilling cost correlation extrapolated for drilling depth > 7000 m")
                model.logger.warning("drilling cost correlation extrapolated for drilling depth > 7000 m")
            self.C1well = self.ccwelladjfactor.value*self.C1well
            self.Cwell.value = 1.05*self.C1well*(model.wellbores.nprod.value+model.wellbores.ninj.value) #1.05 for 5% indirect costs

        #reservoir stimulation costs (M$/injection well). These are calculated whether or not totalcapcost.Valid = 1
        if self.ccstimfixed.Valid: self.Cstim.value = self.ccstimfixed.value
        else: self.Cstim.value = 1.05*1.15*self.ccstimadjfactor.value*model.wellbores.ninj.value*1.25 #1.15 for 15% contingency and 1.05 for 5% indirect costs

        #field gathering system costs (M$)
        if self.ccgathfixed.Valid: self.Cgath.value = self.ccgathfixed.value
        else:
            #self.Cgath.value = self.ccgathadjfactor.value*50-6*np.max(model.surfaceplant.HeatExtracted.value)*1000. (GEOPHIRES v1 correlation)
            if model.wellbores.impedancemodelused.value:
                pumphp = np.max(model.wellbores.PumpingPower.value)*1341
                numberofpumps = np.ceil(pumphp/2000) #pump can be maximum 2,000 hp
                if numberofpumps == 0: self.Cpumps = 0.0
                else:
                    pumphpcorrected = pumphp/numberofpumps
                    self.Cpumps = numberofpumps*1.5*((1750*(pumphpcorrected)**0.7)*3*(pumphpcorrected)**(-0.11)) 
            else:
                if model.wellbores.productionwellpumping.value:
                    prodpumphp = np.max(model.wellbores.PumpingPowerProd.value)/model.wellbores.nprod.value*1341
                    Cpumpsprod = model.wellbores.nprod.value*1.5*(1750*(prodpumphp)**0.7 + 5750*(prodpumphp)**0.2  + 10000 + np.max(model.wellbores.pumpdepth.value)*50*3.281) #see page 46 in user's manual asusming rental of rig for 1 day.
                else: Cpumpsprod = 0
            
                injpumphp = np.max(model.wellbores.PumpingPowerInj.value)*1341
                numberofinjpumps = np.ceil(injpumphp/2000) #pump can be maximum 2,000 hp
                if numberofinjpumps == 0: Cpumpsinj=0
                else:
                    injpumphpcorrected = injpumphp/numberofinjpumps
                    Cpumpsinj = numberofinjpumps*1.5*(1750*(injpumphpcorrected)**0.7)*3*(injpumphpcorrected)**(-0.11)
           
                self.Cpumps = (Cpumpsinj + Cpumpsprod)*1.15 #*1.15 to convert pump cost across the board from 2016 to 2022
        
        self.Cgath.value = 1.15*self.ccgathadjfactor.value*1.12*((model.wellbores.nprod.value+model.wellbores.ninj.value)*750*500. + self.Cpumps)/1E6 #Based on GETEM 2016 #1.15 for 15% contingency and 1.12 for 12% indirect costs

        #plant costs
        #direct-use
        if model.surfaceplant.enduseoption.value == EndUseOptions.HEAT:
            if self.ccplantfixed.Valid:
                self.Cplant.value = self.ccplantfixed.value
            else:
                self.Cplant.value = 1.12*1.15*self.ccplantadjfactor.value*250E-6*np.max(model.surfaceplant.HeatExtracted.value)*1000. #1.15 for 15% contingency and 1.12 for 12% indirect costs
        
        #absorption chiller
        elif model.surfaceplant.enduseoption.value == EndUseOptions.ABSORPTION_CHILLER: #absorption chiller
            if self.ccplantfixed.Valid:
                self.Cplant.value = self.ccplantfixed.value
            else:
                #this is for the direct-use part all the way up to the absorprtion chiller
                self.Cplant.value = 1.12*1.15*self.ccplantadjfactor.value*250E-6*np.max(model.surfaceplant.HeatExtracted.value)*1000. #1.15 for 15% contingency and 1.12 for 12% indirect costs
                if self.chillercapex.value == -1: #no value provided by user, use built-in correlation ($2500/ton)
                    self.chillercapex.value = 1.12*1.15*np.max(model.surfaceplant.CoolingProduced.value)*1000/3.517*2500/1e6 #$2,500/ton of cooling. 1.15 for 15% contingency and 1.12 for 12% indirect costs  
                
                #now add chiller cost to surface plant cost
                self.Cplant.value += self.chillercapex.value
        
        #heat pump
        elif model.surfaceplant.enduseoption.value == EndUseOptions.HEAT_PUMP:
            if self.ccplantfixed.Valid:
                self.Cplant.value = self.ccplantfixed.value
            else:
                #this is for the direct-use part all the way up to the heat pump
                self.Cplant.value = 1.12*1.15*self.ccplantadjfactor.value*250E-6*np.max(model.surfaceplant.HeatExtracted.value)*1000. #1.15 for 15% contingency and 1.12 for 12% indirect costs
                if self.heatpumpcapex.value == -1: #no value provided by user, use built-in correlation ($150/kWth)
                    self.heatpumpcapex.value = 1.12*1.15*np.max(model.surfaceplant.HeatProduced.value)*1000*150/1e6 #$150/kW. 1.15 for 15% contingency and 1.12 for 12% indirect costs  
                
                #now add heat pump cost to surface plant cost
                self.Cplant.value += self.heatpumpcapex.value
        
        #district heating
        elif model.surfaceplant.enduseoption.value == EndUseOptions.DISTRICT_HEATING:
            if self.ccplantfixed.Valid:
                self.Cplant.value = self.ccplantfixed.value
            else:
                self.Cplant.value = 1.12*1.15*self.ccplantadjfactor.value*250E-6*np.max(model.surfaceplant.HeatExtracted.value)*1000. #1.15 for 15% contingency and 1.12 for 12% indirect costs
                self.peakingboilercost.value = 65*model.surfaceplant.maxpeakingboilerdemand.value/1000 #add 65$/KW for peaking boiler 
                self.Cplant.value += self.peakingboilercost.value                       #add peaking boiler cost to surface plant cost       
        
        else: #all other options have power plant
            if model.surfaceplant.pptype.value == PowerPlantType.SUB_CRITICAL_ORC:
                MaxProducedTemperature = np.max(model.surfaceplant.TenteringPP.value)
                if (MaxProducedTemperature < 150.):
                    C3 = -1.458333E-3
                    C2 = 7.6875E-1 
                    C1 = -1.347917E2 
                    C0 = 1.0075E4 
                    CCAPP1 = C3*MaxProducedTemperature**3 + C2*MaxProducedTemperature**2 + C1*MaxProducedTemperature + C0
                else:
                    CCAPP1 = 2231 - 2*(MaxProducedTemperature-150.) 
                x = np.max(model.surfaceplant.ElectricityProduced.value)
                y = np.max(model.surfaceplant.ElectricityProduced.value)
                z=math.pow(y/15.,-0.06)
                self.Cplantcorrelation = CCAPP1*z*x*1000./1E6

            elif model.surfaceplant.pptype.value == PowerPlantType.SUPER_CRITICAL_ORC:
                MaxProducedTemperature = np.max(model.surfaceplant.TenteringPP.value)
                if (MaxProducedTemperature < 150.):
                    C3 = -1.458333E-3
                    C2 = 7.6875E-1 
                    C1 = -1.347917E2 
                    C0 = 1.0075E4 
                    CCAPP1 = C3*MaxProducedTemperature**3 + C2*MaxProducedTemperature**2 + C1*MaxProducedTemperature + C0
                else:
                    CCAPP1 = 2231 - 2*(MaxProducedTemperature-150.) 
                self.Cplantcorrelation = 1.1*CCAPP1*math.pow(np.max(model.surfaceplant.ElectricityProduced.value)/15.,-0.06)*np.max(model.surfaceplant.ElectricityProduced.value)*1000./1E6        #factor 1.1 to make supercritical 10% more expansive than subcritical
        
            elif model.surfaceplant.pptype.value == PowerPlantType.SINGLE_FLASH:
                if (np.max(model.surfaceplant.ElectricityProduced.value)<10.):
                    C2 = 4.8472E-2 
                    C1 = -35.2186
                    C0 = 8.4474E3
                    D2 = 4.0604E-2 
                    D1 = -29.3817
                    D0 = 6.9911E3
                    PLL = 5.
                    PRL = 10.
                elif (np.max(model.surfaceplant.ElectricityProduced.value)<25.):
                    C2 = 4.0604E-2 
                    C1 = -29.3817
                    C0 = 6.9911E3	  
                    D2 = 3.2773E-2 
                    D1 = -23.5519
                    D0 = 5.5263E3        
                    PLL = 10.
                    PRL = 25.
                elif (np.max(model.surfaceplant.ElectricityProduced.value)<50.):
                    C2 = 3.2773E-2 
                    C1 = -23.5519
                    C0 = 5.5263E3
                    D2 = 3.4716E-2 
                    D1 = -23.8139
                    D0 = 5.1787E3	          
                    PLL = 25.
                    PRL = 50.
                elif (np.max(model.surfaceplant.ElectricityProduced.value)<75.):
                    C2 = 3.4716E-2 
                    C1 = -23.8139
                    C0 = 5.1787E3	
                    D2 = 3.5271E-2 
                    D1 = -24.3962
                    D0 = 5.1972E3          
                    PLL = 50.
                    PRL = 75.
                else:
                    C2 = 3.5271E-2 
                    C1 = -24.3962
                    C0 = 5.1972E3	
                    D2 = 3.3908E-2 
                    D1 = -23.4890
                    D0 = 5.0238E3          
                    PLL = 75.
                    PRL = 100.
                maxProdTemp = np.max(model.surfaceplant.TenteringPP.value)
                CCAPPLL = C2*maxProdTemp**2 + C1*maxProdTemp + C0
                CCAPPRL = D2*maxProdTemp**2 + D1*maxProdTemp + D0  
                b = math.log(CCAPPRL/CCAPPLL)/math.log(PRL/PLL)
                a = CCAPPRL/PRL**b
                self.Cplantcorrelation = 0.8*a*math.pow(np.max(model.surfaceplant.ElectricityProduced.value),b)*np.max(self.ElectricityProduced.value)*1000./1E6 #factor 0.75 to make double flash 25% more expansive than single flash
        
            elif model.surfaceplant.pptype.value == PowerPlantType.DOUBLE_FLASH:
                if (np.max(model.surfaceplant.ElectricityProduced.value)<10.):
                    C2 = 4.8472E-2 
                    C1 = -35.2186
                    C0 = 8.4474E3
                    D2 = 4.0604E-2 
                    D1 = -29.3817
                    D0 = 6.9911E3
                    PLL = 5.
                    PRL = 10.
                elif (np.max(model.surfaceplant.ElectricityProduced.value)<25.):
                    C2 = 4.0604E-2 
                    C1 = -29.3817
                    C0 = 6.9911E3	  
                    D2 = 3.2773E-2 
                    D1 = -23.5519
                    D0 = 5.5263E3        
                    PLL = 10.
                    PRL = 25.
                elif (np.max(model.surfaceplant.ElectricityProduced.value)<50.):
                    C2 = 3.2773E-2 
                    C1 = -23.5519
                    C0 = 5.5263E3
                    D2 = 3.4716E-2 
                    D1 = -23.8139
                    D0 = 5.1787E3	          
                    PLL = 25.
                    PRL = 50.
                elif (np.max(model.surfaceplant.ElectricityProduced.value)<75.):
                    C2 = 3.4716E-2 
                    C1 = -23.8139
                    C0 = 5.1787E3	
                    D2 = 3.5271E-2 
                    D1 = -24.3962
                    D0 = 5.1972E3          
                    PLL = 50.
                    PRL = 75.
                else:
                    C2 = 3.5271E-2 
                    C1 = -24.3962
                    C0 = 5.1972E3	
                    D2 = 3.3908E-2 
                    D1 = -23.4890
                    D0 = 5.0238E3          
                    PLL = 75.
                    PRL = 100.
                maxProdTemp = np.max(model.surfaceplant.TenteringPP.value)
                CCAPPLL = C2*maxProdTemp**2 + C1*maxProdTemp + C0
                CCAPPRL = D2*maxProdTemp**2 + D1*maxProdTemp + D0  
                b = math.log(CCAPPRL/CCAPPLL)/math.log(PRL/PLL)
                a = CCAPPRL/PRL**b
                self.Cplantcorrelation = a*math.pow(np.max(model.surfaceplant.ElectricityProduced.value),b)*np.max(model.surfaceplant.ElectricityProduced.value)*1000./1E6
    
            if self.ccplantfixed.Valid: self.Cplant.value = self.ccplantfixed.value
            else: self.Cplant.value = 1.12*1.15*self.ccplantadjfactor.value*self.Cplantcorrelation*1.02*1.10 #1.02 to convert cost from 2012 to 2016; *1.10 to convert from 2016 to 2022 #factor 1.15 for 15% contingency and 1.12 for 12% indirect costs.

         #add direct-use plant cost of co-gen system to Cplant (only of no total ccplant was provided)
        if not self.ccplantfixed.Valid: #1.15 below for contingency and 1.12 for indirect costs
            if model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT]: #enduseoption = 3: cogen topping cycle
                self.Cplant.value = self.Cplant.value + 1.12*1.15*self.ccplantadjfactor.value*250E-6*np.max(model.surfaceplant.HeatProduced.value/model.surfaceplant.enduseefficiencyfactor.value)*1000.
            elif model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICTY]: #enduseoption = 4: cogen bottoming cycle
                self.Cplant = self.Cplant.value + 1.12*1.15*self.ccplantadjfactor.value*250E-6*np.max(model.surfaceplant.HeatProduced.value/model.surfaceplant.enduseefficiencyfactor.value)*1000.
            elif model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT]: #cogen parallel cycle
                self.Cplant.value = self.Cplant.value + 1.12*1.15*self.ccplantadjfactor.value*250E-6*np.max(model.surfaceplant.HeatProduced.value/model.surfaceplant.enduseefficiencyfactor.value)*1000.
  
        if not self.totalcapcost.Valid:  
            #exploration costs (same as in Geophires v1.2) (M$)
            if self.ccexplfixed.Valid: self.Cexpl.value = self.ccexplfixed.value
            else: self.Cexpl.value = 1.15*self.ccexpladjfactor.value*1.12*(1. + self.C1well*0.6) #1.15 for 15% contingency and 1.12 for 12% indirect costs
 
            #Surface Piping Length Costs (M$) #assumed $750k/km (the piping costs can be in addition to the district heat network cost)
            self.Cpiping.value = 750/1000*model.surfaceplant.pipinglength.value
            
            #district heating network costs
            if model.surfaceplant.enduseoption.value == EndUseOptions.DISTRICT_HEATING: #district heat
                if self.dhtotaldistrictnetworkcost.Provided:
                    self.dhdistrictcost.value = self.dhtotaldistrictnetworkcost.value
                elif self.dhpipinglength.Provided:
                    self.dhdistrictcost.value = self.dhpipinglength.value*self.dhpipingcostrate.value/1000 #M$
                elif self.dhroadlength.Provided:          #check if road length is provided to calculate cost    
                    self.dhdistrictcost.value = self.dhroadlength.value*0.75*self.dhpipingcostrate.value/1000 #M$ (assuming 75% of road length is used for district network piping)           
                else: #calculate district network cost based on population density
                    if self.dhlandarea.Provided == False:
                        model.logger.warning("District heating network cost calculated based on default district area")
                    if self.dhpopulation.Provided:
                        self.populationdensity.value = self.dhpopulation.value/self.dhlandarea.value
                    elif model.surfaceplant.dhnumberofhousingunits.Provided:
                        self.populationdensity.value = model.surfaceplant.dhnumberofhousingunits.value*2.6/self.dhlandarea.value #estimate population based on 2.6 number of people per household
                    else:
                        model.logger.warning("District heating network cost calculated based on default number of people in district")
                        self.populationdensity.value = self.dhpopulation.value/self.dhlandarea.value

                    if self.populationdensity.value > 1000:                      
                        self.dhpipinglength.value = 7.5*self.dhlandarea.value             #using constant 7.5km of pipe per km^2 when population density is >1500
                    else:
                        self.dhpipinglength.value = max(self.populationdensity.value/1000*7.5*self.dhlandarea.value, self.dhlandarea.value)   #scale the piping length based on population density, but with a minimum of 1 km of piping per km^2 of area
                    self.dhdistrictcost.value = self.dhpipingcostrate.value*self.dhpipinglength.value/1000                    


            else:
                self.dhdistrictcost.value = 0
            
        
            self.CCap.value = self.Cexpl.value + self.Cwell.value + self.Cstim.value + self.Cgath.value + self.Cplant.value + self.Cpiping.value + self.dhdistrictcost.value
        else:
            self.CCap.value = self.totalcapcost.value

        #add in the O&M costs of the AddOns
        self.CCap.value = self.CCap.value

        #---------
        #O&M costs
        #---------
        #calculate first O&M costs independent of wheter oamtotalfixed is provided or not
        #additional electricity cost for heat pump as end-use
        if model.surfaceplant.enduseoption.value ==  EndUseOptions.HEAT_PUMP: #heat pump:
            self.averageannualheatpumpelectricitycost.value = np.average(model.surfaceplant.HeatPumpElectricitykWhUsed.value)*model.surfaceplant.elecprice.value/1E6 #M$/year
        #district heating peaking fuel annual cost
        if model.surfaceplant.enduseoption.value ==  EndUseOptions.DISTRICT_HEATING: #district heating
            self.annualngcost.value = model.surfaceplant.annualngdemand.value*self.ngprice.value/1000/self.peakingboilerefficiency.value #array with annual O&M cost for peaking fuel
            self.averageannualngcost.value = np.average(self.annualngcost.value)
                            
        #calculate average annual pumping costs in case no electricity is provided
        if model.surfaceplant.enduseoption.value in [EndUseOptions.HEAT, EndUseOptions.ABSORPTION_CHILLER, EndUseOptions.HEAT_PUMP, EndUseOptions.DISTRICT_HEATING]:
            self.averageannualpumpingcosts.value = np.average(model.surfaceplant.PumpingkWh.value)*model.surfaceplant.elecprice.value/1E6 #M$/year
        
        if not self.oamtotalfixed.Valid:
            #labor cost
            if model.surfaceplant.enduseoption.value == EndUseOptions.ELECTRICITY: #electricity
                if np.max(model.surfaceplant.ElectricityProduced.value) < 2.5: self.Claborcorrelation = 236./1E3 #M$/year
                else: self.Claborcorrelation = (589.*math.log(np.max(model.surfaceplant.ElectricityProduced.value))-304.)/1E3 #M$/year
            else:
                if np.max(model.surfaceplant.HeatExtracted.value) < 2.5*5.: self.Claborcorrelation = 236./1E3 #M$/year
                else: self.Claborcorrelation = (589.*math.log(np.max(model.surfaceplant.HeatExtracted.value)/5.)-304.)/1E3 #M$/year
            self.Claborcorrelation = self.Claborcorrelation*1.1*1.15  #1.1 to convert from 2012 to 2016$ with BLS employment cost index (for utilities in March); *1.15 to convert from 2016 to 2022 using the BLS employment cost index for utilities.
    
            #plant O&M cost
            if self.oamplantfixed.Valid: self.Coamplant.value = self.oamplantfixed.value
            else: self.Coamplant.value = self.oamplantadjfactor.value*(1.5/100.*self.Cplant.value + 0.75*self.Claborcorrelation)     

            #wellfield O&M cost
            if self.oamwellfixed.Valid: self.Coamwell.value = self.oamwellfixed.value
            else: self.Coamwell.value = self.oamwelladjfactor.value*(1./100.*(self.Cwell.value + self.Cgath.value) + 0.25*self.Claborcorrelation)

            #water O&M cost
            if self.oamwaterfixed.Valid: self.Coamwater.value = self.oamwaterfixed.value
            else: self.Coamwater.value = self.oamwateradjfactor.value*(model.wellbores.nprod.value*model.wellbores.prodwellflowrate.value*model.reserv.waterloss.value*model.surfaceplant.utilfactor.value*365.*24.*3600./1E6*925./1E6) #here is assumed 1 l per kg maybe correct with real temp. (M$/year) 925$/ML = 3.5$/1,000 gallon            


            #additional O&M cost for absorption chiller if used (this has to be fixed here)
            if model.surfaceplant.enduseoption.value == EndUseOptions.ABSORPTION_CHILLER: #absorption chiller:
                if self.chilleropex.value == -1:
                    self.chilleropex.value = self.chillercapex.value*2/100 #assumed annual O&M for chiller is 2% of investment cost
                    
                #correct plant O&M cost as otherwise chiller opex would be counted double (subtract chiller capex from plant cost when calculating Coandmplant)
                if self.oamplantfixed.Valid == False:
                    self.Coamplant.value = self.oamplantadjfactor.value*(1.5/100.*(self.Cplant.value-self.chillercapex.value) + 0.75*self.Claborcorrelation)     
                
                
            else: 
                self.chilleropex.value = 0
            
            #district heating O&M cost
            if model.surfaceplant.enduseoption.value == EndUseOptions.DISTRICT_HEATING: #district heating
                self.annualngcost.value = model.surfaceplant.annualngdemand.value*self.ngprice.value/1000 #array with annual O&M cost for peaking fuel
                
                if self.dhoandmcost.Provided:
                    self.dhdistrictoandmcost.value = self.dhoandmcost.value #M$/yr
                else:
                    self.dhdistrictoandmcost.value = 0.01*self.dhdistrictcost.value + 0.02*sum(model.surfaceplant.dailyheatingdemand.value)*model.surfaceplant.elecprice.value/1000  #[M$/year] we assume annual district OPEX equals 1% of district CAPEX and 2% of total heat demand for pumping costs
                    
            else:
                self.dhdistrictoandmcost.value = 0
                
                
                
            #total O&M cost            
            self.Coam.value = self.Coamwell.value + self.Coamplant.value + self.Coamwater.value + self.chilleropex.value + self.dhdistrictoandmcost.value #total O&M cost (M$/year)

                
        else: self.Coam.value = self.oamtotalfixed.value #total O&M cost (M$/year)

        #add in the O&M costs of the AddOns
        self.Coam.value = self.Coam.value

        if model.wellbores.redrill.value > 0: model.economics.Coam.value = model.economics.Coam.value + (self.Cwell.value + model.reserv.Cstim.value)*model.wellbores.redrill.value/model.surfaceplant.plantlifetime.value   #account for well redrilling

        #The Reservoir depth measure was arbitarily changed to meters, desipte being defined in the docs as kilometers.  For display consistency sake, we need to convert it back
        if model.reserv.depth.value > 500: model.reserv.depth.value = model.reserv.depth.value/1000.0

        #Calculate LCOE/LCOH
        self.CalculateLCOELCOH(model)

        model.logger.info("complete "+ str(__class__) + ": " + sys._getframe().f_code.co_name)

    def CalculateLCOELCOH(self, model:Model) -> None:
        model.logger.info("Init " + str(__class__) + ": " + sys._getframe().f_code.co_name)
        #---------------------------
        #Calculate LCOE/LCOH
        #---------------------------
        if self.econmodel.value == EconomicModel.FCR:
            if model.surfaceplant.enduseoption.value == EndUseOptions.ELECTRICITY:
                self.LCOE.value = (self.FCR.value*(1+self.inflrateconstruction.value)*self.CCap.value + self.Coam.value)/np.average(model.surfaceplant.NetkWhProduced.value)*1E8 #cents/kWh
            elif model.surfaceplant.enduseoption.value == EndUseOptions.HEAT:
                self.LCOH.value = (self.FCR.value*(1+self.inflrateconstruction.value)*self.CCap.value + self.Coam.value + self.averageannualpumpingcosts.value)/np.average(model.surfaceplant.HeatkWhProduced.value)*1E8 #cents/kWh
                self.LCOH.value = self.LCOH.value*2.931 #$/Million Btu
            elif model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICTY]: #co-gen
                if model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT]: #heat sales is additional income revenue stream
                    averageannualheatincome = np.average(self.HeatkWhProduced.value)*self.heatprice.value/1E6 #M$/year ASSUMING heatprice IS IN $/KWH FOR HEAT SALES
                    self.LCOE.value = (self.FCR.value*(1+self.inflrateconstruction.value)*self.CCap.value + self.Coam.value - averageannualheatincome)/np.average(model.surfaceplant.NetkWhProduced.value)*1E8 #cents/kWh   
                elif model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICTY]: #electricity sales is additional income revenue stream
                    averageannualelectricityincome =  np.average(model.surfaceplant.NetkWhProduced.value)*model.surfaceplant.elecprice.value/1E6 #M$/year
                    self.LCOH.value = (self.CCap.value + self.Coam.value - averageannualelectricityincome)/np.average(model.surfaceplant.HeatkWhProduced.value)*1E8 #cents/kWh
                    self.LCOH.value = self.LCOH.value*2.931 #$/MMBTU
            elif model.surfaceplant.enduseoption.value == EndUseOptions.ABSORPTION_CHILLER:
                self.LCOC.value = (self.FCR.value*(1+self.inflrateconstruction.value)*self.CCap.value + self.Coam.value + self.averageannualpumpingcosts.value)/np.average(model.surfaceplant.CoolingkWhProduced.value)*1E8 #cents/kWh
                self.LCOC.value = self.LCOC.value*2.931 #$/Million Btu    
            elif model.surfaceplant.enduseoption.value == EndUseOptions.HEAT_PUMP:
                self.LCOH.value = (self.FCR.value*(1+self.inflrateconstruction.value)*self.CCap.value + self.Coam.value + self.averageannualpumpingcosts.value + self.averageannualheatpumpelectricitycost.value)/np.average(model.surfaceplant.HeatkWhProduced.value)*1E8 #cents/kWh
                self.LCOH.value = self.LCOH.value*2.931 #$/Million Btu        
            elif model.surfaceplant.enduseoption.value == EndUseOptions.DISTRICT_HEATING:
                self.LCOH.value = (self.FCR.value*(1+self.inflrateconstruction.value)*self.CCap.value + self.Coam.value + self.averageannualpumpingcosts.value + self.averageannualngcost.value)/model.surfaceplant.annualheatingdemand.value*1E2 #cents/kWh
                self.LCOH.value = self.LCOH.value*2.931 #$/Million Btu      
                
        elif self.econmodel.value == EconomicModel.STANDARDIZED_LEVELIZED_COST:
            discountvector = 1./np.power(1+self.discountrate.value,np.linspace(0,model.surfaceplant.plantlifetime.value-1,model.surfaceplant.plantlifetime.value))
            if model.surfaceplant.enduseoption.value == EndUseOptions.ELECTRICITY:
                self.LCOE.value = ((1+self.inflrateconstruction.value)*self.CCap.value + np.sum(self.Coam.value*discountvector))/np.sum(model.surfaceplant.NetkWhProduced.value*discountvector)*1E8 #cents/kWh
            elif model.surfaceplant.enduseoption.value == EndUseOptions.HEAT:
                self.LCOH.value = ((1+self.inflrateconstruction.value)*self.CCap.value + np.sum((self.Coam.value+model.surfaceplant.PumpingkWh.value*model.surfaceplant.elecprice.value/1E6)*discountvector))/np.sum(model.surfaceplant.HeatkWhProduced.value*discountvector)*1E8 #cents/kWh
                self.LCOH.value = self.LCOH.value*2.931 #$/MMBTU
            elif model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICTY]: #co-gen
                if model.surfaceplant.enduseoption.value  in [EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT]: #heat sales is additional income revenue stream
                    annualheatincome = model.surfaceplant.HeatkWhProduced.value*model.surfaceplant.heatprice.value/1E6 #M$/year ASSUMING heatprice IS IN $/KWH FOR HEAT SALES
                    self.LCOE.value = ((1+self.inflrateconstruction.value)*self.CCap.value + np.sum((self.Coam.value-annualheatincome)*discountvector))/np.sum(model.surfaceplant.NetkWhProduced.value*discountvector)*1E8 #cents/kWh
                elif model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICTY]: #electricity sales is additional income revenue stream
                    annualelectricityincome = model.surfaceplant.NetkWhProduced.value*self.elecprice.value/1E6 #M$/year
                    self.LCOH.value = ((1+self.inflrateconstruction.value)*self.CCap.value + np.sum((self.Coam.value-annualelectricityincome)*discountvector))/np.sum(model.surfaceplant.HeatkWhProduced.value*discountvector)*1E8 #cents/kWh
                    self.LCOH.value = self.LCOH.value*2.931 #$/MMBTU
            elif model.surfaceplant.enduseoption.value == EndUseOptions.ABSORPTION_CHILLER:
                self.LCOC.value = ((1+self.inflrateconstruction.value)*self.CCap.value + np.sum((self.Coam.value+model.surfaceplant.PumpingkWh.value*model.surfaceplant.elecprice.value/1E6)*discountvector))/np.sum(model.surfaceplant.CoolingkWhProduced.value*discountvector)*1E8 #cents/kWh
                self.LCOC.value = self.LCOC.value*2.931 #$/Million Btu    
            elif model.surfaceplant.enduseoption.value == EndUseOptions.HEAT_PUMP:
                self.LCOH.value = ((1+self.inflrateconstruction.value)*self.CCap.value + np.sum((self.Coam.value+model.surfaceplant.PumpingkWh.value*model.surfaceplant.elecprice.value/1E6+\
                    model.surfaceplant.HeatPumpElectricitykWhUsed.value*model.surfaceplant.elecprice.value/1E6)*discountvector))/np.sum(model.surfaceplant.HeatkWhProduced.value*discountvector)*1E8 #cents/kWh
                self.LCOH.value = self.LCOH.value*2.931 #$/Million Btu 
            elif model.surfaceplant.enduseoption.value == EndUseOptions.DISTRICT_HEATING:
                self.LCOH.value = ((1+self.inflrateconstruction.value)*self.CCap.value + np.sum((self.Coam.value+model.surfaceplant.PumpingkWh.value*model.surfaceplant.elecprice.value/1E6+\
                    self.annualngcost.value)*discountvector))/np.sum(model.surfaceplant.annualheatingdemand.value*discountvector)*1E2 #cents/kWh
                self.LCOH.value = self.LCOH.value*2.931 #$/Million Btu 
                
                
        elif self.econmodel.value == EconomicModel.BICYCLE:
            iave = self.FIB.value*self.BIR.value*(1-self.CTR.value) + (1-self.FIB.value)*self.EIR.value #average return on investment (tax and inflation adjusted)
            CRF = iave/(1-np.power(1+iave,-model.surfaceplant.plantlifetime.value)) #capital recovery factor
            inflationvector = np.power(1+self.RINFL.value,np.linspace(1,model.surfaceplant.plantlifetime.value, model.surfaceplant.plantlifetime.value))
            discountvector = 1./np.power(1+iave,np.linspace(1, model.surfaceplant.plantlifetime.value, model.surfaceplant.plantlifetime.value))
            NPVcap = np.sum((1+self.inflrateconstruction.value)*self.CCap.value*CRF*discountvector)
            NPVfc = np.sum((1+self.inflrateconstruction.value)*self.CCap.value*self.PTR.value*inflationvector*discountvector)
            NPVit = np.sum(self.CTR.value/(1-self.CTR.value)*((1+self.inflrateconstruction.value)*self.CCap.value*CRF-self.CCap.value/model.surfaceplant.plantlifetime.value)*discountvector)
            NPVitc = (1+self.inflrateconstruction.value)*self.CCap.value*self.RITC.value/(1-self.CTR.value)
            if model.surfaceplant.enduseoption.value == EndUseOptions.ELECTRICITY:            
                NPVoandm = np.sum(self.Coam.value*inflationvector*discountvector)
                NPVgrt = self.GTR.value/(1-self.GTR.value)*(NPVcap + NPVoandm + NPVfc + NPVit - NPVitc)
                self.LCOE.value  = (NPVcap + NPVoandm + NPVfc + NPVit + NPVgrt - NPVitc)/np.sum(model.surfaceplant.NetkWhProduced.value*inflationvector*discountvector)*1E8
            elif model.surfaceplant.enduseoption.value == EndUseOptions.HEAT:
                PumpingCosts = model.surfaceplant.PumpingkWh.value*model.surfaceplant.elecprice.value/1E6
                NPVoandm = np.sum((self.Coam.value+PumpingCosts)*inflationvector*discountvector)
                NPVgrt = self.GTR.value/(1-self.GTR.value)*(NPVcap + NPVoandm + NPVfc + NPVit - NPVitc)
                self.LCOH.value  = (NPVcap + NPVoandm + NPVfc + NPVit + NPVgrt - NPVitc)/np.sum(model.surfaceplant.HeatkWhProduced.value*inflationvector*discountvector)*1E8
                self.LCOH.value = self.LCOH.value*2.931 #$/MMBTU
            elif model.surfaceplant.enduseoption.value in [EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICTY]: #co-gen
                if model.surfaceplant.enduseoption.value  in [EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT]: #heat sales is additional income revenue stream
                    annualheatincome = model.surfaceplant.HeatkWhProduced.value*model.surfaceplant.heatprice.value/1E6 #M$/year ASSUMING ELECPRICE IS IN $/KWH FOR HEAT SALES
                    NPVoandm = np.sum(self.Coam.value*inflationvector*discountvector)            
                    NPVgrt = self.GTR.value/(1-self.GTR.value)*(NPVcap + NPVoandm + NPVfc + NPVit - NPVitc)
                    self.LCOE.value  = (NPVcap + NPVoandm + NPVfc + NPVit + NPVgrt - NPVitc - np.sum(annualheatincome*inflationvector*discountvector))/np.sum(model.surfaceplant.NetkWhProduced.value*inflationvector*discountvector)*1E8 
                elif model.surfaceplant.enduseoption.value  in [EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICTY, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICTY]: #electricity sales is additional income revenue stream
                    annualelectricityincome = model.surfaceplant.NetkWhProduced.value*model.surfaceplant.elecprice.value/1E6 #M$/year
                    NPVoandm = np.sum(self.Coam.value*inflationvector*discountvector)
                    NPVgrt = self.GTR.value/(1-self.GTR.value)*(NPVcap + NPVoandm + NPVfc + NPVit - NPVitc)
                    self.LCOH.value  = (NPVcap + NPVoandm + NPVfc + NPVit + NPVgrt - NPVitc - np.sum(annualelectricityincome*inflationvector*discountvector))/np.sum(model.surfaceplant.HeatkWhProduced.value*inflationvector*discountvector)*1E8
                    self.LCOH.value = self.LCOELCOHCombined.value*2.931 #$/MMBTU
            elif model.surfaceplant.enduseoption.value == EndUseOptions.ABSORPTION_CHILLER:
                PumpingCosts = model.surfaceplant.PumpingkWh.value*model.surfaceplant.elecprice.value/1E6
                NPVoandm = np.sum((self.Coam.value+PumpingCosts)*inflationvector*discountvector)
                NPVgrt = self.GTR.value/(1-self.GTR.value)*(NPVcap + NPVoandm + NPVfc + NPVit - NPVitc)
                self.LCOC.value  = (NPVcap + NPVoandm + NPVfc + NPVit + NPVgrt - NPVitc)/np.sum(model.surfaceplant.CoolingkWhProduced.value*inflationvector*discountvector)*1E8
                self.LCOC.value = self.LCOC.value*2.931 #$/MMBTU
            elif model.surfaceplant.enduseoption.value == EndUseOptions.HEAT_PUMP:
                PumpingCosts = model.surfaceplant.PumpingkWh.value*model.surfaceplant.elecprice.value/1E6
                HeatPumpElecCosts = model.surfaceplant.HeatPumpElectricitykWhUsed.value*model.surfaceplant.elecprice.value/1E6
                NPVoandm = np.sum((self.Coam.value+PumpingCosts+HeatPumpElecCosts)*inflationvector*discountvector)
                NPVgrt = self.GTR.value/(1-self.GTR.value)*(NPVcap + NPVoandm + NPVfc + NPVit - NPVitc)
                self.LCOH.value  = (NPVcap + NPVoandm + NPVfc + NPVit + NPVgrt - NPVitc)/np.sum(model.surfaceplant.HeatkWhProduced.value*inflationvector*discountvector)*1E8
                self.LCOH.value = self.LCOH.value*2.931 #$/MMBTU
            elif model.surfaceplant.enduseoption.value == EndUseOptions.DISTRICT_HEATING:
                PumpingCosts = model.surfaceplant.PumpingkWh.value*model.surfaceplant.elecprice.value/1E6
                NPVoandm = np.sum((self.Coam.value+PumpingCosts+self.annualngcost.value)*inflationvector*discountvector)
                NPVgrt = self.GTR.value/(1-self.GTR.value)*(NPVcap + NPVoandm + NPVfc + NPVit - NPVitc)
                self.LCOH.value  = (NPVcap + NPVoandm + NPVfc + NPVit + NPVgrt - NPVitc)/np.sum(model.surfaceplant.annualheatingdemand.value*inflationvector*discountvector)*1E2
                self.LCOH.value = self.LCOH.value*2.931 #$/MMBTU                
                
        model.logger.info("complete "+ str(__class__) + ": " + sys._getframe().f_code.co_name)

    def __str__(self): return "Economics"