# frozen_string_literal: true

# *******************************************************************************
# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# (1) Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# (2) Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# (3) Neither the name of the copyright holder nor the names of any contributors
# may be used to endorse or promote products derived from this software without
# specific prior written permission from the respective party.
#
# (4) Other than as required in clauses (1) and (2), distributions in any form
# of modifications or other derivative works may not use the "OpenStudio"
# trademark, "OS", "os", or any other confusingly similar designation without
# specific prior written permission from Alliance for Sustainable Energy, LLC.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# *******************************************************************************

# start the measure
class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasure
  # define the name that a user will see
  def name
    return 'Reduce Electric Equipment Loads by Percentage'
  end

  # human readable description
  def description
    return 'Reduce Electric Equipment Loads by Percentage</display_name>
  <description>Reduce electric equipment loads. This will affect equipment that have a, power, power per area (LPD), or power per person value. This can be applied to the entire building or a specific space type. A positive percentage represents an increase electric equipment power, while a negative percentage can be used for an increase in electric equipment power.'
  end

  # human readable description of modeling approach
  def modeler_description
    return 'Loop through all electric equipment objects in the specified space type or the entire building. Clone the definition if it has not already been cloned, rename and adjust the power based on the specified percentage. Link the new definition to the existing electric equipment instance. Loop through objects first in space types and then in spaces, but only for spaces that are in the specified space type, unless entire building has been chosen.'
  end

  # define the arguments that the user will input
  def arguments(model)
    args = OpenStudio::Measure::OSArgumentVector.new

    # make a choice argument for model objects
    space_type_handles = OpenStudio::StringVector.new
    space_type_display_names = OpenStudio::StringVector.new

    # putting model object and names into hash
    space_type_args = model.getSpaceTypes
    space_type_args_hash = {}
    space_type_args.each do |space_type_arg|
      space_type_args_hash[space_type_arg.name.to_s] = space_type_arg
    end

    # looping through sorted hash of model objects
    space_type_args_hash.sort.map do |key, value|
      # only include if space type is used in the model
      if !value.spaces.empty?
        space_type_handles << value.handle.to_s
        space_type_display_names << key
      end
    end

    # add building to string vector with space type
    building = model.getBuilding
    space_type_handles << building.handle.to_s
    space_type_display_names << '*Entire Building*'

    # make a choice argument for space type
    space_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('space_type', space_type_handles, space_type_display_names)
    space_type.setDisplayName('Apply the Measure to a Specific Space Type or to the Entire Model')
    space_type.setDefaultValue('*Entire Building*') # if no space type is chosen this will run on the entire building
    args << space_type

    # make an argument for reduction percentage
    elecequip_power_reduction_percent = OpenStudio::Measure::OSArgument.makeDoubleArgument('elecequip_power_reduction_percent', true)
    elecequip_power_reduction_percent.setDisplayName('Electric Equipment Power Reduction')
    elecequip_power_reduction_percent.setDefaultValue(30.0)
    elecequip_power_reduction_percent.setUnits('%')
    args << elecequip_power_reduction_percent

    # make an argument for material and installation cost
    material_and_installation_cost = OpenStudio::Measure::OSArgument.makeDoubleArgument('material_and_installation_cost', true)
    material_and_installation_cost.setDisplayName('Increase in Material and Installation Cost for Electric Equipment per Floor Area')
    material_and_installation_cost.setDefaultValue(0.0)
    material_and_installation_cost.setUnits('%')
    args << material_and_installation_cost

    # make an argument for demolition cost
    demolition_cost = OpenStudio::Measure::OSArgument.makeDoubleArgument('demolition_cost', true)
    demolition_cost.setDisplayName('Increase in Demolition Costs for Electric Equipment per Floor Area')
    demolition_cost.setDefaultValue(0.0)
    demolition_cost.setUnits('%')
    args << demolition_cost

    # make an argument for years until costs start
    years_until_costs_start = OpenStudio::Measure::OSArgument.makeIntegerArgument('years_until_costs_start', true)
    years_until_costs_start.setDisplayName('Years Until Costs Start')
    years_until_costs_start.setDefaultValue(0)
    years_until_costs_start.setUnits('whole years')
    args << years_until_costs_start

    # make a choice argument for when demo costs occur
    demo_cost_initial_const = OpenStudio::Measure::OSArgument.makeBoolArgument('demo_cost_initial_const', true)
    demo_cost_initial_const.setDisplayName('Demolition Costs Occur During Initial Construction')
    demo_cost_initial_const.setDefaultValue(false)
    args << demo_cost_initial_const

    # make an argument for expected life
    expected_life = OpenStudio::Measure::OSArgument.makeIntegerArgument('expected_life', true)
    expected_life.setDisplayName('Expected Life')
    expected_life.setDefaultValue(15)
    expected_life.setUnits('whole years')
    args << expected_life

    # make an argument for O & M cost
    om_cost = OpenStudio::Measure::OSArgument.makeDoubleArgument('om_cost', true)
    om_cost.setDisplayName('Increase O & M Costs for Electric Equipment per Floor Area')
    om_cost.setDefaultValue(0.0)
    om_cost.setUnits('%')
    args << om_cost

    # make an argument for O & M frequency
    om_frequency = OpenStudio::Measure::OSArgument.makeIntegerArgument('om_frequency', true)
    om_frequency.setDisplayName('O & M Frequency')
    om_frequency.setDefaultValue(1)
    om_frequency.setUnits('whole years')
    args << om_frequency

    return args
  end

  # define what happens when the measure is run
  def run(model, runner, user_arguments)
    super(model, runner, user_arguments)

    # use the built-in error checking
    if !runner.validateUserArguments(arguments(model), user_arguments)
      return false
    end

    # assign the user inputs to variables
    object = runner.getOptionalWorkspaceObjectChoiceValue('space_type', user_arguments, model)
    elecequip_power_reduction_percent = runner.getDoubleArgumentValue('elecequip_power_reduction_percent', user_arguments)
    material_and_installation_cost = runner.getDoubleArgumentValue('material_and_installation_cost', user_arguments)
    demolition_cost = runner.getDoubleArgumentValue('demolition_cost', user_arguments)
    years_until_costs_start = runner.getIntegerArgumentValue('years_until_costs_start', user_arguments)
    demo_cost_initial_const = runner.getBoolArgumentValue('demo_cost_initial_const', user_arguments)
    expected_life = runner.getIntegerArgumentValue('expected_life', user_arguments)
    om_cost = runner.getDoubleArgumentValue('om_cost', user_arguments)
    om_frequency = runner.getIntegerArgumentValue('om_frequency', user_arguments)

    # check the space_type for reasonableness and see if measure should run on space type or on the entire building
    apply_to_building = false
    space_type = nil
    if object.empty?
      handle = runner.getStringArgumentValue('space_type', user_arguments)
      if handle.empty?
        runner.registerError('No space type was chosen.')
      else
        runner.registerError("The selected space type with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
      end
      return false
    else
      if !object.get.to_SpaceType.empty?
        space_type = object.get.to_SpaceType.get
      elsif !object.get.to_Building.empty?
        apply_to_building = true
      else
        runner.registerError('Script Error - argument not showing up as space type or building.')
        return false
      end
    end

    # check the elecequip_power_reduction_percent and for reasonableness
    if elecequip_power_reduction_percent > 100
      runner.registerError('Please Enter a Value less than or equal to 100 for the Electric Equipment Power Reduction Percentage.')
      return false
    elsif elecequip_power_reduction_percent == 0
      runner.registerInfo('No electric electric equipment power adjustment requested, but some life cycle costs may still be affected.')
    elsif (elecequip_power_reduction_percent < 1) && (elecequip_power_reduction_percent > -1)
      runner.registerWarning("A Electric Equipment Power Reduction Percentage of #{elecequip_power_reduction_percent} percent is abnormally low.")
    elsif elecequip_power_reduction_percent > 90
      runner.registerWarning("A Electric Equipment Power Reduction Percentage of #{elecequip_power_reduction_percent} percent is abnormally high.")
    elsif elecequip_power_reduction_percent < 0
      runner.registerInfo('The requested value for electric equipment power reduction percentage was negative. This will result in an increase in electric eqipment power.')
    end

    # check lifecycle cost arguments for reasonableness
    if material_and_installation_cost < -100
      runner.registerError("Material and Installation Cost percentage increase can't be less than -100.")
      return false
    end

    if demolition_cost < -100
      runner.registerError("Demolition Cost percentage increase can't be less than -100.")
      return false
    end

    if years_until_costs_start < 0
      runner.registerError('Enter an integer greater than or equal to 0 for Years Until Costs Start.')
      return false
    end

    if expected_life < 1
      runner.registerError('Enter an integer greater than or equal to 1 for Expected Life.')
      return false
    end

    if om_cost < -100
      runner.registerError("O & M Cost percentage increase can't be less than -100.")
      return false
    end

    if om_frequency < 1
      runner.registerError('Choose an integer greater than 0 for O & M Frequency.')
    end

    # helper to make numbers pretty (converts 4125001.25641 to 4,125,001.26 or 4,125,001). The definition be called through this measure.
    def neat_numbers(number, roundto = 2) # round to 0 or 2)
      if roundto == 2
        number = format '%.2f', number
      else
        number = number.round
      end
      # regex to add commas
      number.to_s.reverse.gsub(/([0-9]{3}(?=([0-9])))/, '\\1,').reverse
    end

    # helper to make it easier to do unit conversions on the fly.  The definition be called through this measure.
    def unit_helper(number, from_unit_string, to_unit_string)
      converted_number = OpenStudio.convert(OpenStudio::Quantity.new(number, OpenStudio.createUnit(from_unit_string).get), OpenStudio.createUnit(to_unit_string).get).get.value
    end

    # helper that loops through lifecycle costs getting total costs under "Construction" or "Salvage" category and add to counter if occurs during year 0
    def get_total_costs_for_objects(objects)
      counter = 0
      objects.each do |object|
        object_LCCs = object.lifeCycleCosts
        object_LCCs.each do |object_LCC|
          if (object_LCC.category == 'Construction') || (object_LCC.category == 'Salvage')
            if object_LCC.yearsFromStart == 0
              counter += object_LCC.totalCost
            end
          end
        end
      end
      return counter
    end

    # counter for demo cost of baseline objects
    demo_costs_of_baseline_objects = 0

    # counter for year 0 capital costs
    yr0_capital_totalCosts = 0

    # get initial electric equipment costs and multiply by -1
    yr0_capital_totalCosts +=  get_total_costs_for_objects(model.getElectricEquipmentDefinitions) * -1

    # report initial condition
    building = model.getBuilding
    building_equip_power = building.electricEquipmentPower
    building_EPD = unit_helper(building.electricEquipmentPowerPerFloorArea, 'W/m^2', 'W/ft^2')
    runner.registerInitialCondition("The model's initial building electric equipment power was  #{neat_numbers(building_equip_power, 0)} watts, an electric equipment power density of #{neat_numbers(building_EPD)} w/ft^2.")

    # get space types in model
    if apply_to_building
      space_types = model.getSpaceTypes

    else
      space_types = []
      space_types << space_type # only run on a single space type
    end

    # helper def to add to demo cost related to baseline objects
    def add_to_baseline_demo_cost_counter(baseline_object, demo_cost_initial_const)
      counter = 0
      if demo_cost_initial_const == true
        baseline_object_LCCs = baseline_object.lifeCycleCosts
        baseline_object_LCCs.each do |baseline_object_LCC|
          if baseline_object_LCC.category == 'Salvage'
            counter += baseline_object_LCC.totalCost
          end
        end
      end
      return counter
    end

    # def to alter performance and life cycle costs of objects
    def alter_performance_and_lcc(object, elecequip_power_reduction_percent, material_and_installation_cost, demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)
      # edit clone based on percentage reduction
      new_def = object
      if !new_def.designLevel.empty?
        new_electric_equipment_level = new_def.setDesignLevel(new_def.designLevel.get - new_def.designLevel.get * elecequip_power_reduction_percent * 0.01)
      elsif !new_def.wattsperSpaceFloorArea.empty?
        new_electric_equipment_per_area = new_def.setWattsperSpaceFloorArea(new_def.wattsperSpaceFloorArea.get - new_def.wattsperSpaceFloorArea.get * elecequip_power_reduction_percent * 0.01)
      elsif !new_def.wattsperPerson.empty?
        new_electric_equipment_per_person = new_def.setWattsperPerson(new_def.wattsperPerson.get - new_def.wattsperPerson.get * elecequip_power_reduction_percent * 0.01)
      else
        runner.registerWarning("'#{new_def.name}' is used by one or more instances and has no load values. Its performance was not altered.")
      end

      new_def_LCCs = new_def.lifeCycleCosts
      if new_def_LCCs.empty?
        if material_and_installation_cost.abs + demolition_cost.abs + om_cost.abs != 0
          runner.registerWarning("'#{new_def.name}' had no life cycle cost objects. No cost was added for it.")
        end
      else
        new_def_LCCs.each do |new_def_LCC|
          if new_def_LCC.category == 'Construction'
            new_def_LCC.setCost(new_def_LCC.cost * (1 + material_and_installation_cost / 100))
            new_def_LCC.setYearsFromStart(years_until_costs_start) # just uses argument value, does not need existing value
            new_def_LCC.setRepeatPeriodYears(expected_life) # just uses argument value, does not need existing value
          elsif new_def_LCC.category == 'Salvage'
            new_def_LCC.setCost(new_def_LCC.cost * (1 + demolition_cost / 100))
            new_def_LCC.setYearsFromStart(years_until_costs_start + expected_life) # just uses argument value, does not need existing value
            new_def_LCC.setRepeatPeriodYears(expected_life) # just uses argument value, does not need existing value
          elsif new_def_LCC.category == 'Maintenance'
            new_def_LCC.setCost(new_def_LCC.cost * (1 + om_cost / 100))
            new_def_LCC.setRepeatPeriodYears(om_frequency) # just uses argument value, does not need existing value
          end

          # reset any month durations
          new_def_LCC.resetRepeatPeriodMonths
          new_def_LCC.resetMonthsFromStart
        end

      end
    end

    # make a hash of old defs and new electric equipment defs
    cloned_elecequip_defs = {}

    # loop through space types
    space_types.each do |space_type|
      next if space_type.spaces.size <= 0
      space_type_equipments = space_type.electricEquipment
      space_type_equipments.each do |space_type_equipment|
        new_def = nil

        # clone def if it has not already been cloned
        exist_def = space_type_equipment.electricEquipmentDefinition
        if !cloned_elecequip_defs[exist_def.name.get.to_s].nil?
          new_def = cloned_elecequip_defs[exist_def.name.get.to_s]
        else
          # clone rename and add to hash
          new_def = exist_def.clone(model)
          new_def_name = new_def.setName("#{exist_def.name.get} - #{elecequip_power_reduction_percent} percent reduction")
          new_def = new_def.to_ElectricEquipmentDefinition.get
          cloned_elecequip_defs[exist_def.name.get.to_s] = new_def

          # add demo cost of object being removed to one counter for one time demo cost for baseline objects
          demo_costs_of_baseline_objects += add_to_baseline_demo_cost_counter(exist_def, demo_cost_initial_const)

          # call def to alter performance and life cycle costs
          alter_performance_and_lcc(new_def, elecequip_power_reduction_percent, material_and_installation_cost, demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)

        end

        # link instance with clone and rename
        updated_instance = space_type_equipment.setElectricEquipmentDefinition(new_def.to_ElectricEquipmentDefinition.get)
        updated_instance_name = space_type_equipment.setName("#{space_type_equipment.name} #{elecequip_power_reduction_percent} percent reduction")
      end
    end

    # getting spaces in the model
    spaces = model.getSpaces

    # get space types in model
    if apply_to_building
      spaces = model.getSpaces
    else
      if !space_type.spaces.empty?
        spaces = space_type.spaces # only run on a single space type
      end
    end

    spaces.each do |space|
      space_equipments = space.electricEquipment
      space_equipments.each do |space_equipment|
        # clone def if it has not already been cloned
        exist_def = space_equipment.electricEquipmentDefinition
        if cloned_elecequip_defs.any? { |k, v| k.to_s == exist_def.name.get.to_s }
          new_def = cloned_elecequip_defs[exist_def.name.get.to_s]
        else
          # clone rename and add to hash
          new_def = exist_def.clone(model)
          new_def_name = new_def.setName("#{new_def.name} - #{elecequip_power_reduction_percent} percent reduction")
          cloned_elecequip_defs[exist_def.name.get] = new_def
          new_def = new_def.to_ElectricEquipmentDefinition.get

          # add demo cost of object being removed to one counter for one time demo cost for baseline objects
          demo_costs_of_baseline_objects += add_to_baseline_demo_cost_counter(exist_def, demo_cost_initial_const)

          # call def to alter performance and life cycle costs
          alter_performance_and_lcc(new_def, elecequip_power_reduction_percent, material_and_installation_cost, demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)

        end

        # link instance with clone and rename
        updated_instance = space_equipment.setElectricEquipmentDefinition(new_def.to_ElectricEquipmentDefinition.get)
        updated_instance_name = space_equipment.setName("#{space_equipment.name} #{elecequip_power_reduction_percent} percent reduction")
      end
    end

    if cloned_elecequip_defs.empty?
      runner.registerAsNotApplicable('No electric equipment objects were found in the specified space type(s).')
    end

    # get final electric equipment costs to use in final condition
    yr0_capital_totalCosts +=  get_total_costs_for_objects(model.getElectricEquipmentDefinitions)

    # add one time demo cost of removed electric equipment if appropriate
    if demo_cost_initial_const == true
      building = model.getBuilding
      lcc_baseline_demo = OpenStudio::Model::LifeCycleCost.createLifeCycleCost('LCC_baseline_demo', building, demo_costs_of_baseline_objects, 'CostPerEach', 'Salvage', 0, years_until_costs_start).get # using 0 for repeat period since one time cost.
      runner.registerInfo("Adding one time cost of $#{neat_numbers(lcc_baseline_demo.totalCost, 0)} related to demolition of baseline objects.")

      # if demo occurs on year 0 then add to initial capital cost counter
      if lcc_baseline_demo.yearsFromStart == 0
        yr0_capital_totalCosts += lcc_baseline_demo.totalCost
      end
    end

    # report final condition
    final_building = model.getBuilding
    final_building_equip_power = final_building.electricEquipmentPower
    final_building_EPD = unit_helper(final_building.electricEquipmentPowerPerFloorArea, 'W/m^2', 'W/ft^2')
    runner.registerFinalCondition("The model's final building electric equipment power was  #{neat_numbers(final_building_equip_power, 0)} watts, an electric equipment power density of #{neat_numbers(final_building_EPD)} w/ft^2. Initial capital costs associated with the improvements are $#{neat_numbers(yr0_capital_totalCosts, 0)}.")

    return true
  end
end

# this allows the measure to be used by the application
ReduceElectricEquipmentLoadsByPercentage.new.registerWithApplication