Class: ModifyEnergyPlusCoilCoolingDXSingleSpeedObjects

Inherits:
OpenStudio::Measure::EnergyPlusMeasure
  • Object
show all
Defined in:
lib/measures/ModifyEnergyPlusCoilCoolingDXSingleSpeedObjects/measure.rb

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(workspace) ⇒ Object

define the arguments that the user will input



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/measures/ModifyEnergyPlusCoilCoolingDXSingleSpeedObjects/measure.rb', line 27

def arguments(workspace)
  args = OpenStudio::Measure::OSArgumentVector.new

  # make an argument
  ratedTotalCoolingCapacity = OpenStudio::Measure::OSArgument.makeDoubleArgument('ratedTotalCoolingCapacity', true)
  ratedTotalCoolingCapacity.setDisplayName('Rated Total Cooling Capacity (W).')
  # ratedTotalCoolingCapacity.setDefaultValue(10.76)
  args << ratedTotalCoolingCapacity

  # make an argument
  ratedCOP = OpenStudio::Measure::OSArgument.makeDoubleArgument('ratedCOP', true)
  ratedCOP.setDisplayName('Rated COP (W/W).')
  # ratedCOP.setDefaultValue(10.76)
  args << ratedCOP

  # make an argument
  ratedAirFlowRate = OpenStudio::Measure::OSArgument.makeDoubleArgument('ratedAirFlowRate', true)
  ratedAirFlowRate.setDisplayName('Rated Air Flow Rate (m^3/s).')
  # ratedAirFlowRate.setDefaultValue(10.76)
  args << ratedAirFlowRate

  # make an argument
  condensateRemovalStart = OpenStudio::Measure::OSArgument.makeDoubleArgument('condensateRemovalStart', true)
  condensateRemovalStart.setDisplayName('Nominal Time for Condensate Removal to Begin (s).')
  # condensateRemovalStart.setDefaultValue(10.76)
  args << condensateRemovalStart

  # make an argument
  evapLatentRatio = OpenStudio::Measure::OSArgument.makeDoubleArgument('evapLatentRatio', true)
  evapLatentRatio.setDisplayName('Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity.')
  # evapLatentRatio.setDefaultValue(10.76)
  args << evapLatentRatio

  # make an argument
  latentCapTimeConstant = OpenStudio::Measure::OSArgument.makeDoubleArgument('latentCapTimeConstant', true)
  latentCapTimeConstant.setDisplayName('Latent Capacity Time Constant (s).')
  # latentCapTimeConstant.setDefaultValue(10.76)
  args << latentCapTimeConstant

  return args
end

#name ⇒ Object

define the name that a user will see, this method may be deprecated as the display name in PAT comes from the name field in measure.xml



22
23
24
 
# File 'lib/measures/ModifyEnergyPlusCoilCoolingDXSingleSpeedObjects/measure.rb', line 22

def name
  return 'ModifyEnergyPlusCoilCoolingDXSingleSpeedObjects'
end

#run(workspace, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
109
110
111
112
113
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/measures/ModifyEnergyPlusCoilCoolingDXSingleSpeedObjects/measure.rb', line 70

def run(workspace, runner, user_arguments)
  super(workspace, runner, user_arguments)

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

  # assign the user inputs to variables
  ratedTotalCoolingCapacity = runner.getDoubleArgumentValue('ratedTotalCoolingCapacity', user_arguments)
  ratedCOP = runner.getDoubleArgumentValue('ratedCOP', user_arguments)
  ratedAirFlowRate = runner.getDoubleArgumentValue('ratedAirFlowRate', user_arguments)
  condensateRemovalStart = runner.getDoubleArgumentValue('condensateRemovalStart', user_arguments)
  evapLatentRatio = runner.getDoubleArgumentValue('evapLatentRatio', user_arguments)
  latentCapTimeConstant = runner.getDoubleArgumentValue('latentCapTimeConstant', user_arguments)

  # check the ratedTotalCoolingCapacity for reasonableness
  if ratedTotalCoolingCapacity < 0
    runner.registerError('Please enter a non-negative value for Rated Total Cooling Capacity.')
    return false
  end

  # check the ratedCOP for reasonableness
  if ratedCOP < 0
    runner.registerError('Please enter a non-negative value for Rated COP.')
    return false
  end

  # check the ratedAirFlowRate for reasonableness
  if ratedAirFlowRate < 0
    runner.registerError('Please enter a non-negative value for Rated Air Flow Rate.')
    return false
  end

  # check the condensateRemovalStart for reasonableness
  if condensateRemovalStart < 0
    runner.registerError('Please enter a non-negative value for Nominal Time for Condensate Removal to Begin.')
    return false
  end

  # check the evapLatentRatio for reasonableness
  if evapLatentRatio < 0
    runner.registerError('Please enter a non-negative value Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity.')
    return false
  end

  # check the latentCapTimeConstant for reasonableness
  if latentCapTimeConstant < 0
    runner.registerError('Please enter a non-negative value for Latent Capacity Time Constant.')
    return false
  end

  # get all coilCoolingSingleSpeedDxObjects in model
  coilCoolingSingleSpeedDxObjects = workspace.getObjectsByType('Coil:Cooling:DX:SingleSpeed'.to_IddObjectType)

  if coilCoolingSingleSpeedDxObjects.empty?
    runner.registerAsNotApplicable('The model does not contain any coilCoolingSingleSpeedDxObjects. The model will not be altered.')
    return true
  end

  coilCoolingSingleSpeedDxObjects.each do |coilCoolingSingleSpeedDxObject|
    coilCoolingSingleSpeedDxObject_name =  coilCoolingSingleSpeedDxObject.getString(0) # Name
    coilCoolingSingleSpeedDxObject_starting_ratedTotalCoolingCapacity = coilCoolingSingleSpeedDxObject.getString(2) # Rated Total Cooling Capacity
    coilCoolingSingleSpeedDxObject_starting_ratedCOP = coilCoolingSingleSpeedDxObject.getString(4) # Rated COP
    coilCoolingSingleSpeedDxObject_starting_ratedAirFlowRate = coilCoolingSingleSpeedDxObject.getString(5) # Rated Air Flow Rate
    coilCoolingSingleSpeedDxObject_starting_condensateRemovalStart = coilCoolingSingleSpeedDxObject.getString(14) # Nominal Time for Condensate Removal to Begin
    coilCoolingSingleSpeedDxObject_starting_evapLatentRatio = coilCoolingSingleSpeedDxObject.getString(15) # Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
    coilCoolingSingleSpeedDxObject_starting_latentCapTimeConstant = coilCoolingSingleSpeedDxObject.getString(17) # Latent Capacity Time Constant
    coilCoolingSingleSpeedDxObject.setString(2, ratedTotalCoolingCapacity.to_s) # Rated Total Cooling Capacity
    coilCoolingSingleSpeedDxObject.setString(4, ratedCOP.to_s) # Rated COP
    coilCoolingSingleSpeedDxObject.setString(5, ratedAirFlowRate.to_s) # Rated Air Flow Rate
    coilCoolingSingleSpeedDxObject.setString(14, condensateRemovalStart.to_s) # Nominal Time for Condensate Removal to Begin
    coilCoolingSingleSpeedDxObject.setString(15, evapLatentRatio.to_s) # Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
    coilCoolingSingleSpeedDxObject.setString(17, latentCapTimeConstant.to_s) # Latent Capacity Time Constant

    # info message on change
    runner.registerInfo("Changing Rated Total Cooling Capacity of #{coilCoolingSingleSpeedDxObject_name} from #{coilCoolingSingleSpeedDxObject_starting_ratedTotalCoolingCapacity}(Pa) to #{coilCoolingSingleSpeedDxObject.getString(2)}(Pa).")
    runner.registerInfo("Changing Rated COP of #{coilCoolingSingleSpeedDxObject_name} from #{coilCoolingSingleSpeedDxObject_starting_ratedCOP}(Pa) to #{coilCoolingSingleSpeedDxObject.getString(4)}(Pa).")
    runner.registerInfo("Changing Rated Air Flow Rate of #{coilCoolingSingleSpeedDxObject_name} from #{coilCoolingSingleSpeedDxObject_starting_ratedAirFlowRate}(Pa) to #{coilCoolingSingleSpeedDxObject.getString(5)}(Pa).")
    runner.registerInfo("Changing Nominal Time for Condensate Removal to Begin of #{coilCoolingSingleSpeedDxObject_name} from #{coilCoolingSingleSpeedDxObject_starting_condensateRemovalStart}(Pa) to #{coilCoolingSingleSpeedDxObject.getString(14)}(Pa).")
    runner.registerInfo("Changing Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity of #{coilCoolingSingleSpeedDxObject_name} from #{coilCoolingSingleSpeedDxObject_starting_evapLatentRatio}(Pa) to #{coilCoolingSingleSpeedDxObject.getString(15)}(Pa).")
    runner.registerInfo("Changing Latent Capacity Time Constant of #{coilCoolingSingleSpeedDxObject_name} from #{coilCoolingSingleSpeedDxObject_starting_latentCapTimeConstant}(Pa) to #{coilCoolingSingleSpeedDxObject.getString(17)}(Pa).")
  end

  # TODO: - add warning if a thermal zone has more than one coilCoolingSingleSpeedDxObjects object, as that may not result in the desired impact.

  # TODO: - may also want to warn or have info message for zones that dont have any coilCoolingSingleSpeedDxObjects

  # unique initial conditions based on
  # removed listing ranges for variable values since we are editing multiple fields vs. a single field.
  runner.registerInitialCondition("The building has #{coilCoolingSingleSpeedDxObjects.size} coilCoolingSingleSpeedDxObject objects.")

  # reporting final condition of model
  runner.registerFinalCondition("The building finished with #{coilCoolingSingleSpeedDxObjects.size} coilCoolingSingleSpeedDxObject objects.")

  return true
end