# Custom changes for the SmallOffice prototype.
# These are changes that are inconsistent with other prototype
# building types.
module SmallOffice
  def model_custom_hvac_tweaks(building_type, climate_zone, prototype_input, model)
    # add extra infiltration for entry door
    add_door_infiltration(template, climate_zone, model)
    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Added door infiltration')

    # add extra infiltration for attic
    add_attic_infiltration(template, climate_zone, model)
    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Added attic infiltration')

    # reset defrost time fraction
    # TODO: set this to a reasonable defrost time fraction based on research and implement in Prototype.CoilHeatingDXSingleSpeed
    model.getCoilHeatingDXSingleSpeeds.each { |coil| coil.resetDefrostTimePeriodFraction }

    return true
  end

  def add_door_infiltration(template, climate_zone, model)
    # add extra infiltration for entry door in m3/s (there is no attic in 'DOE Ref Pre-1980')
    unless template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
      entry_space = model.getSpaceByName('Perimeter_ZN_1').get
      infiltration_entrydoor = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
      infiltration_entrydoor.setName('entry door Infiltration')
      infiltration_per_zone_entrydoor = 0
      if template == '90.1-2004'
        infiltration_per_zone_entrydoor = 0.129785425
        infiltration_entrydoor.setSchedule(model_add_schedule(model, 'OfficeSmall INFIL_Door_Opening_SCH'))
      elsif template == '90.1-2007' || template == '90.1-2010'|| template == '90.1-2013'
        case climate_zone
        when 'ASHRAE 169-2006-1A',
             'ASHRAE 169-2006-1B',
             'ASHRAE 169-2006-2A',
             'ASHRAE 169-2006-2B',
             'ASHRAE 169-2013-1A',
             'ASHRAE 169-2013-1B',
             'ASHRAE 169-2013-2A',
             'ASHRAE 169-2013-2B'
          infiltration_per_zone_entrydoor = 0.129785425
          infiltration_entrydoor.setSchedule(model_add_schedule(model, 'OfficeSmall INFIL_Door_Opening_SCH'))
        else
          infiltration_per_zone_entrydoor = 0.076455414
          infiltration_entrydoor.setSchedule(model_add_schedule(model, 'OfficeSmall INFIL_Door_Opening_SCH_2013'))
        end
      end
      infiltration_entrydoor.setDesignFlowRate(infiltration_per_zone_entrydoor)
      infiltration_entrydoor.setConstantTermCoefficient(1.0)
      infiltration_entrydoor.setTemperatureTermCoefficient(0.0)
      infiltration_entrydoor.setVelocityTermCoefficient(0.0)
      infiltration_entrydoor.setVelocitySquaredTermCoefficient(0.0)
      infiltration_entrydoor.setSpace(entry_space)
    end
  end

  def add_attic_infiltration(template, climate_zone, model)
    # add extra infiltration for attic in m3/s (there is no attic in 'DOE Ref Pre-1980')
    unless template == 'DOE Ref 1980-2004' || template == 'DOE Ref Pre-1980'
      entry_space = model.getSpaceByName('Attic').get
      infiltration_attic = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
      infiltration_attic.setName('attic Infiltration')
      infiltration_per_zone_attic = 0.2001
      infiltration_attic.setSchedule(model_add_schedule(model, 'Always On'))
      infiltration_attic.setDesignFlowRate(infiltration_per_zone_attic)
      infiltration_attic.setConstantTermCoefficient(1.0)
      infiltration_attic.setTemperatureTermCoefficient(0.0)
      infiltration_attic.setVelocityTermCoefficient(0.0)
      infiltration_attic.setVelocitySquaredTermCoefficient(0.0)
      infiltration_attic.setSpace(entry_space)
    end
  end

  def model_custom_daylighting_tweaks(building_type, climate_zone, prototype_input, model)
    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Adjusting daylight sensor positions and fractions')

    adjustments = [
                    { '90.1-2010' => { 'Perimeter_ZN_1' => { 'sensor_1_frac' => 0.02,
                                                             'sensor_2_frac' => 0.1,
                                                             'sensor_1_xyz' => [3.3236, 1.6002, 0.762],
                                                             'sensor_2_xyz' => [8.9611, 1.6002, 0.762],
																												},
                                       'Perimeter_ZN_2' => { 'sensor_1_frac' => 0.06,
                                                             'sensor_2_frac' => 0.15,
                                                             'sensor_1_xyz' => [26.0898, 3.3236, 0.762],
                                                             'sensor_2_xyz' => [26.0898, 9.23, 0.762],
																												},
                                       'Perimeter_ZN_3' => { 'sensor_1_frac' => 0.1,
                                                             'sensor_2_frac' => 0.02,
                                                             'sensor_1_xyz' => [13.8684, 16.8598, 0.762],
                                                             'sensor_2_xyz' => [24.3664, 16.8598, 0.762],
																												},
                                       'Perimeter_ZN_4' => { 'sensor_1_frac' => 0.06,
                                                             'sensor_2_frac' => 0.15,
                                                             'sensor_1_xyz' => [1.6002, 15.1364, 0.762],
                                                             'sensor_2_xyz' => [1.6002, 9.2446, 0.762],
																												},
                                      },
                      '90.1-2013' => { 'Perimeter_ZN_1' => { 'sensor_1_frac' => 0.2399,
                                                             'sensor_2_frac' => 0.0302,
                                                             'sensor_1_xyz' => [9.144, 1.6337, 0.762],
                                                             'sensor_2_xyz' => [9.144, 3.2675, 0.762],
																												},
                                       'Perimeter_ZN_2' => { 'sensor_1_frac' => 0.2399,
                                                             'sensor_2_frac' => 0.0302,
                                                             'sensor_1_xyz' => [26.0898, 9.144, 0.762],
                                                             'sensor_2_xyz' => [24.4561, 9.144, 0.762],
																												},
                                       'Perimeter_ZN_3' => { 'sensor_1_frac' => 0.2399,
                                                             'sensor_2_frac' => 0.0302,
                                                             'sensor_1_xyz' => [18.288, 16.825, 0.762],
                                                             'sensor_2_xyz' => [18.288, 15.1925, 0.762],
																												},
                                       'Perimeter_ZN_4' => { 'sensor_1_frac' => 0.2399,
                                                             'sensor_2_frac' => 0.0302,
                                                             'sensor_1_xyz' => [1.6337, 9.144, 0.762],
                                                             'sensor_2_xyz' => [3.2675, 9.144, 0.762],
																												},
                                      },
										}
                  ]

    # Adjust daylight sensors in each space
    model.getSpaces.each do |space|
      if adjustments[0].keys.include? (template)
        if adjustments[0][template].keys.include? (space.name.to_s)
          adj = adjustments[0][template][space.name.to_s]
          next if space.thermalZone.empty?
          zone = space.thermalZone.get
          next if space.spaceType.empty?
          spc_type = space.spaceType.get
          next if spc_type.standardsSpaceType.empty?
          stds_spc_type = spc_type.standardsSpaceType.get
          # Adjust the primary sensor
          if adj['sensor_1_frac'] && zone.primaryDaylightingControl.is_initialized
            OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "For #{zone.name}: Adjusting primary daylight sensor to control #{adj['sensor_1_frac']} of the lighting.")
            zone.setFractionofZoneControlledbyPrimaryDaylightingControl(adj['sensor_1_frac'])
            pri_ctrl = zone.primaryDaylightingControl.get
            if adj['sensor_1_xyz']
              x = adj['sensor_1_xyz'][0]
              y = adj['sensor_1_xyz'][1]
              z = adj['sensor_1_xyz'][2]
              OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "For #{zone.name}: Adjusting primary daylight sensor position to [#{x}, #{y}, #{z}].")
              pri_ctrl.setPositionXCoordinate(x)
              pri_ctrl.setPositionYCoordinate(y)
              pri_ctrl.setPositionZCoordinate(z)
            end
          end
          # Adjust the secondary sensor
          if adj['sensor_2_frac'] && zone.secondaryDaylightingControl.is_initialized
            OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "For #{zone.name}: Adjusting secondary daylight sensor to control #{adj['sensor_2_frac']} of the lighting.")
            zone.setFractionofZoneControlledbySecondaryDaylightingControl(adj['sensor_2_frac'])
            sec_ctrl = zone.secondaryDaylightingControl.get
            if adj['sensor_2_xyz']
              x = adj['sensor_2_xyz'][0]
              y = adj['sensor_2_xyz'][1]
              z = adj['sensor_2_xyz'][2]
              OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "For #{zone.name}: Adjusting secondary daylight sensor position to [#{x}, #{y}, #{z}].")
              sec_ctrl.setPositionXCoordinate(x)
              sec_ctrl.setPositionYCoordinate(y)
              sec_ctrl.setPositionZCoordinate(z)
            end
          end
        end
      end
    end

    return true
  end

  def model_custom_swh_tweaks(model, building_type, climate_zone, prototype_input)

    return true
  end

  def model_custom_geometry_tweaks(building_type, climate_zone, prototype_input, model)

    return true
  end
end