Module: CoilDX

Included in:
OpenStudio::Model::CoilCoolingDXSingleSpeed, OpenStudio::Model::CoilCoolingDXTwoSpeed, OpenStudio::Model::CoilHeatingDXSingleSpeed
Defined in:
lib/openstudio-standards/standards/Standards.CoilDX.rb

Overview

A variety of DX coil methods that are the same regardless of coil type. These methods are available to: CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed

Instance Method Summary collapse

Instance Method Details

#find_search_criteria(template) ⇒ hash

Finds the search criteria

Parameters:

  • template (String) —

    valid choices: ‘DOE Ref Pre-1980’, ‘DOE Ref 1980-2004’, ‘90.1-2004’, ‘90.1-2007’, ‘90.1-2010’, ‘90.1-2013’

Returns:

  • (hash) —

    has for search criteria to be used for find object



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/openstudio-standards/standards/Standards.CoilDX.rb', line 114

def find_search_criteria(template)
  search_criteria = {}
  search_criteria['template'] = template

  search_criteria['cooling_type'] = case iddObjectType.valueName.to_s
                                    when 'OS_Coil_Cooling_DX_SingleSpeed',
                                         'OS_Coil_Cooling_DX_TwoSpeed',
                                         'OS_Coil_Cooling_DX_MultiSpeed'
                                      condenserType
                                    else
                                      'AirCooled'
                                    end

  # Get the subcategory
  search_criteria['subcategory'] = subcategory

  # Add the heating type to the search criteria
  unless heating_type.nil?
    search_criteria['heating_type'] = heating_type
  end

  # Unitary heat pumps don't have a heating type
  # as part of the search
  if heat_pump?
    if airLoopHVAC.empty?
      if containingHVACComponent.is_initialized
        containing_comp = containingHVACComponent.get
        if containing_comp.to_AirLoopHVACUnitaryHeatPumpAirToAir.is_initialized
          search_criteria['heating_type'] = nil
        end # TODO: Add other unitary systems
      end
    end
  end

  return search_criteria
end

#heat_pump? ⇒ Bool

Determine if it is a heat pump

Returns:

  • (Bool) —

    true if it is a heat pump, false if not



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/openstudio-standards/standards/Standards.CoilDX.rb', line 32

def heat_pump?
  heat_pump = false

  heating_type = nil
  if airLoopHVAC.empty?
    if containingHVACComponent.is_initialized
      containing_comp = containingHVACComponent.get
      if containing_comp.to_AirLoopHVACUnitaryHeatPumpAirToAir.is_initialized
        heat_pump = true
      end # TODO: Add other unitary systems
    elsif containingZoneHVACComponent.is_initialized
      containing_comp = containingZoneHVACComponent.get
      # PTHP
      if containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
        heat_pump = true
      end # TODO: Add other zone hvac systems
    end
  end

  return heat_pump
end

#heating_type ⇒ String

Determine the heating type. Possible choices are: Electric Resistance or None, All Other

Returns:

  • (String) —

    the heating type



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/openstudio-standards/standards/Standards.CoilDX.rb', line 57

def heating_type
  htg_type = nil

  # If Unitary or Zone HVAC
  if airLoopHVAC.empty?
    if containingHVACComponent.is_initialized
      containing_comp = containingHVACComponent.get
      if containing_comp.to_AirLoopHVACUnitaryHeatPumpAirToAir.is_initialized
        htg_type = 'Electric Resistance or None'
      end # TODO: Add other unitary systems
    elsif containingZoneHVACComponent.is_initialized
      containing_comp = containingZoneHVACComponent.get
      # PTAC
      if containing_comp.to_ZoneHVACPackagedTerminalAirConditioner.is_initialized
        htg_coil = containing_comp.to_ZoneHVACPackagedTerminalAirConditioner.get.heatingCoil
        if htg_coil.to_CoilHeatingElectric.is_initialized
          htg_type = 'Electric Resistance or None'
        elsif htg_coil.to_CoilHeatingWater.is_initialized || htg_coil.to_CoilHeatingGas.is_initialized
          htg_type = 'All Other'
        end
      # PTHP
      elsif containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
        htg_type = 'Electric Resistance or None'
      end # TODO: Add other zone hvac systems

    end
  end

  # If on an AirLoop
  if airLoopHVAC.is_initialized
    air_loop = airLoopHVAC.get
    htg_type = if !air_loop.supplyComponents('OS:Coil:Heating:Electric'.to_IddObjectType).empty?
                     'Electric Resistance or None'
                   elsif !air_loop.supplyComponents('OS:Coil:Heating:Gas'.to_IddObjectType).empty?
                     'All Other'
                   elsif !air_loop.supplyComponents('OS:Coil:Heating:Water'.to_IddObjectType).empty?
                     'All Other'
                   elsif !air_loop.supplyComponents('OS:Coil:Heating:DX:SingleSpeed'.to_IddObjectType).empty?
                     'All Other'
                   elsif !air_loop.supplyComponents('OS:Coil:Heating:Gas:MultiStage'.to_IddObjectType).empty?
                     'All Other'
                   elsif !air_loop.supplyComponents('OS:Coil:Heating:Desuperheater'.to_IddObjectType).empty?
                     'All Other'
                   elsif !air_loop.supplyComponents('OS:Coil:Heating:WaterToAirHeatPump:EquationFit'.to_IddObjectType).empty?
                     'All Other'
                   else
                     'Electric Resistance or None'
                   end
  end
  
  return htg_type
end

#subcategory ⇒ String

TODO:

Add add split system vs single package to model object

Finds the subcategory. Possible choices are: Single Package, Split System, PTAC, or PTHP

Returns:

  • (String) —

    the subcategory



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/openstudio-standards/standards/Standards.CoilDX.rb', line 11

def subcategory
  sub_category = 'Single Package'

  if airLoopHVAC.empty?
    if containingZoneHVACComponent.is_initialized
      containing_comp = containingZoneHVACComponent.get
      # PTAC
      if containing_comp.to_ZoneHVACPackagedTerminalAirConditioner.is_initialized
        sub_category = 'PTAC'
      # PTHP
      elsif containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
        sub_category = 'PTHP'
      end # TODO: Add other zone hvac systems
    end
  end

  return sub_category
end