src/model/AirLoopHVACUnitarySystem_Impl.hpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /*********************************************************************************************************************** | ||
| 2 | * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC. | ||
| 3 | * See also https://openstudio.net/license | ||
| 4 | ***********************************************************************************************************************/ | ||
| 5 | |||
| 6 | #ifndef MODEL_AIRLOOPHVACUNITARYSYSTEM_IMPL_HPP | ||
| 7 | #define MODEL_AIRLOOPHVACUNITARYSYSTEM_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class ThermalZone; | ||
| 16 | class Schedule; | ||
| 17 | class HVACComponent; | ||
| 18 | class Node; | ||
| 19 | class UnitarySystemPerformanceMultispeed; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** AirLoopHVACUnitarySystem_Impl is a ZoneHVACComponent_Impl that is the implementation class for AirLoopHVACUnitarySystem.*/ | ||
| 24 | class MODEL_API AirLoopHVACUnitarySystem_Impl : public ZoneHVACComponent_Impl | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | AirLoopHVACUnitarySystem_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | AirLoopHVACUnitarySystem_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | AirLoopHVACUnitarySystem_Impl(const AirLoopHVACUnitarySystem_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | 219 | virtual ~AirLoopHVACUnitarySystem_Impl() override = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | /** @name Virtual Methods */ | ||
| 40 | //@{ | ||
| 41 | |||
| 42 | virtual ModelObject clone(Model model) const override; | ||
| 43 | |||
| 44 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 45 | |||
| 46 | virtual IddObjectType iddObjectType() const override; | ||
| 47 | |||
| 48 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 49 | |||
| 50 | virtual std::vector<ModelObject> children() const override; | ||
| 51 | |||
| 52 | virtual std::vector<IdfObject> remove() override; | ||
| 53 | |||
| 54 | virtual unsigned inletPort() const override; | ||
| 55 | |||
| 56 | virtual unsigned outletPort() const override; | ||
| 57 | |||
| 58 | virtual bool addToNode(Node& node) override; | ||
| 59 | |||
| 60 | virtual ComponentType componentType() const override; | ||
| 61 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 62 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 63 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 64 | |||
| 65 | //@} | ||
| 66 | /** @name Getters */ | ||
| 67 | //@{ | ||
| 68 | |||
| 69 | std::string controlType() const; | ||
| 70 | |||
| 71 | bool isControlTypeDefaulted() const; | ||
| 72 | |||
| 73 | boost::optional<ThermalZone> controllingZoneorThermostatLocation() const; | ||
| 74 | |||
| 75 | std::string dehumidificationControlType() const; | ||
| 76 | |||
| 77 | bool isDehumidificationControlTypeDefaulted() const; | ||
| 78 | |||
| 79 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 80 | |||
| 81 | boost::optional<HVACComponent> supplyFan() const; | ||
| 82 | |||
| 83 | boost::optional<std::string> fanPlacement() const; | ||
| 84 | |||
| 85 | boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const; | ||
| 86 | |||
| 87 | bool hasHeatingCoil() const; // For speed | ||
| 88 | boost::optional<HVACComponent> heatingCoil() const; | ||
| 89 | |||
| 90 | double dXHeatingCoilSizingRatio() const; | ||
| 91 | |||
| 92 | bool isDXHeatingCoilSizingRatioDefaulted() const; | ||
| 93 | |||
| 94 | bool hasCoolingCoil() const; // For speed | ||
| 95 | boost::optional<HVACComponent> coolingCoil() const; | ||
| 96 | |||
| 97 | bool useDOASDXCoolingCoil() const; | ||
| 98 | |||
| 99 | bool isUseDOASDXCoolingCoilDefaulted() const; | ||
| 100 | |||
| 101 | double dOASDXCoolingCoilLeavingMinimumAirTemperature() const; | ||
| 102 | |||
| 103 | bool isDOASDXCoolingCoilLeavingMinimumAirTemperatureDefaulted() const; | ||
| 104 | |||
| 105 | bool isDOASDXCoolingCoilLeavingMinimumAirTemperatureAutosized() const; | ||
| 106 | |||
| 107 | std::string latentLoadControl() const; | ||
| 108 | |||
| 109 | bool isLatentLoadControlDefaulted() const; | ||
| 110 | |||
| 111 | boost::optional<HVACComponent> supplementalHeatingCoil() const; | ||
| 112 | |||
| 113 | std::string supplyAirFlowRateMethodDuringCoolingOperation() const; | ||
| 114 | |||
| 115 | boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const; | ||
| 116 | |||
| 117 | bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 118 | |||
| 119 | boost::optional<double> supplyAirFlowRatePerFloorAreaDuringCoolingOperation() const; | ||
| 120 | |||
| 121 | boost::optional<double> fractionofAutosizedDesignCoolingSupplyAirFlowRate() const; | ||
| 122 | |||
| 123 | boost::optional<double> designSupplyAirFlowRatePerUnitofCapacityDuringCoolingOperation() const; | ||
| 124 | |||
| 125 | std::string supplyAirFlowRateMethodDuringHeatingOperation() const; | ||
| 126 | |||
| 127 | boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const; | ||
| 128 | |||
| 129 | bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 130 | |||
| 131 | boost::optional<double> supplyAirFlowRatePerFloorAreaduringHeatingOperation() const; | ||
| 132 | |||
| 133 | boost::optional<double> fractionofAutosizedDesignHeatingSupplyAirFlowRate() const; | ||
| 134 | |||
| 135 | boost::optional<double> designSupplyAirFlowRatePerUnitofCapacityDuringHeatingOperation() const; | ||
| 136 | |||
| 137 | std::string supplyAirFlowRateMethodWhenNoCoolingorHeatingisRequired() const; | ||
| 138 | |||
| 139 | boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisRequired() const; | ||
| 140 | |||
| 141 | bool isSupplyAirFlowRateWhenNoCoolingorHeatingisRequiredAutosized() const; | ||
| 142 | |||
| 143 | boost::optional<double> supplyAirFlowRatePerFloorAreaWhenNoCoolingorHeatingisRequired() const; | ||
| 144 | |||
| 145 | boost::optional<double> fractionofAutosizedDesignCoolingSupplyAirFlowRateWhenNoCoolingorHeatingisRequired() const; | ||
| 146 | |||
| 147 | boost::optional<double> fractionofAutosizedDesignHeatingSupplyAirFlowRateWhenNoCoolingorHeatingisRequired() const; | ||
| 148 | |||
| 149 | boost::optional<double> designSupplyAirFlowRatePerUnitofCapacityDuringCoolingOperationWhenNoCoolingorHeatingisRequired() const; | ||
| 150 | |||
| 151 | boost::optional<double> designSupplyAirFlowRatePerUnitofCapacityDuringHeatingOperationWhenNoCoolingorHeatingisRequired() const; | ||
| 152 | |||
| 153 | bool noLoadSupplyAirFlowRateControlSetToLowSpeed() const; | ||
| 154 | |||
| 155 | boost::optional<double> maximumSupplyAirTemperature() const; | ||
| 156 | |||
| 157 | bool isMaximumSupplyAirTemperatureDefaulted() const; | ||
| 158 | |||
| 159 | bool isMaximumSupplyAirTemperatureAutosized() const; | ||
| 160 | |||
| 161 | double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const; | ||
| 162 | |||
| 163 | bool isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted() const; | ||
| 164 | |||
| 165 | boost::optional<std::string> outdoorDryBulbTemperatureSensorNodeName() const; | ||
| 166 | |||
| 167 | double ancilliaryOnCycleElectricPower() const; | ||
| 168 | |||
| 169 | bool isAncilliaryOnCycleElectricPowerDefaulted() const; | ||
| 170 | |||
| 171 | double ancilliaryOffCycleElectricPower() const; | ||
| 172 | |||
| 173 | bool isAncilliaryOffCycleElectricPowerDefaulted() const; | ||
| 174 | |||
| 175 | // double designHeatRecoveryWaterFlowRate() const; | ||
| 176 | |||
| 177 | // bool isDesignHeatRecoveryWaterFlowRateDefaulted() const; | ||
| 178 | |||
| 179 | // double maximumTemperatureforHeatRecovery() const; | ||
| 180 | |||
| 181 | // bool isMaximumTemperatureforHeatRecoveryDefaulted() const; | ||
| 182 | |||
| 183 | boost::optional<UnitarySystemPerformanceMultispeed> designSpecificationMultispeedObject() const; | ||
| 184 | |||
| 185 | boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const; | ||
| 186 | |||
| 187 | boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const; | ||
| 188 | |||
| 189 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisRequired() const; | ||
| 190 | |||
| 191 | boost::optional<double> autosizedMaximumSupplyAirTemperature() const; | ||
| 192 | |||
| 193 | boost::optional<double> autosizedDOASDXCoolingCoilLeavingMinimumAirTemperature() const; | ||
| 194 | |||
| 195 | virtual void autosize() override; | ||
| 196 | |||
| 197 | virtual void applySizingValues() override; | ||
| 198 | |||
| 199 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 200 | |||
| 201 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 202 | |||
| 203 | //@} | ||
| 204 | /** @name Setters */ | ||
| 205 | //@{ | ||
| 206 | |||
| 207 | bool setControlType(const std::string& controlType); | ||
| 208 | |||
| 209 | void resetControlType(); | ||
| 210 | |||
| 211 | bool setControllingZoneorThermostatLocation(const ThermalZone& thermalZone); | ||
| 212 | |||
| 213 | void resetControllingZoneorThermostatLocation(); | ||
| 214 | |||
| 215 | bool setDehumidificationControlType(const std::string& dehumidificationControlType); | ||
| 216 | |||
| 217 | void resetDehumidificationControlType(); | ||
| 218 | |||
| 219 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 220 | |||
| 221 | void resetAvailabilitySchedule(); | ||
| 222 | |||
| 223 | bool setSupplyFan(const HVACComponent& supplyFan); | ||
| 224 | |||
| 225 | void resetSupplyFan(); | ||
| 226 | |||
| 227 | bool setFanPlacement(const std::string& fanPlacement); | ||
| 228 | |||
| 229 | void resetFanPlacement(); | ||
| 230 | |||
| 231 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 232 | |||
| 233 | void resetSupplyAirFanOperatingModeSchedule(); | ||
| 234 | |||
| 235 | bool setHeatingCoil(const HVACComponent& heatingCoil); | ||
| 236 | |||
| 237 | void resetHeatingCoil(); | ||
| 238 | |||
| 239 | bool setDXHeatingCoilSizingRatio(double dXHeatingCoilSizingRatio); | ||
| 240 | |||
| 241 | void resetDXHeatingCoilSizingRatio(); | ||
| 242 | |||
| 243 | bool setCoolingCoil(const HVACComponent& coolingCoil); | ||
| 244 | |||
| 245 | void resetCoolingCoil(); | ||
| 246 | |||
| 247 | bool setUseDOASDXCoolingCoil(bool useDOASDXCoolingCoil); | ||
| 248 | |||
| 249 | void resetUseDOASDXCoolingCoil(); | ||
| 250 | |||
| 251 | bool setDOASDXCoolingCoilLeavingMinimumAirTemperature(double dOASDXCoolingCoilLeavingMinimumAirTemperature); | ||
| 252 | |||
| 253 | void resetDOASDXCoolingCoilLeavingMinimumAirTemperature(); | ||
| 254 | |||
| 255 | void autosizeDOASDXCoolingCoilLeavingMinimumAirTemperature(); | ||
| 256 | |||
| 257 | bool setLatentLoadControl(const std::string& latentLoadControl); | ||
| 258 | |||
| 259 | void resetLatentLoadControl(); | ||
| 260 | |||
| 261 | bool setSupplementalHeatingCoil(const HVACComponent& supplementalHeatingCoil); | ||
| 262 | |||
| 263 | void resetSupplementalHeatingCoil(); | ||
| 264 | |||
| 265 | bool setSupplyAirFlowRateMethodDuringCoolingOperation(const std::string& supplyAirFlowRateMethodDuringCoolingOperation); | ||
| 266 | |||
| 267 | bool setSupplyAirFlowRateDuringCoolingOperation(double supplyAirFlowRateDuringCoolingOperation); | ||
| 268 | |||
| 269 | void resetSupplyAirFlowRateDuringCoolingOperation(); | ||
| 270 | |||
| 271 | void autosizeSupplyAirFlowRateDuringCoolingOperation(); | ||
| 272 | |||
| 273 | bool setSupplyAirFlowRatePerFloorAreaDuringCoolingOperation(double supplyAirFlowRatePerFloorAreaDuringCoolingOperation); | ||
| 274 | |||
| 275 | void resetSupplyAirFlowRatePerFloorAreaDuringCoolingOperation(); | ||
| 276 | |||
| 277 | bool setFractionofAutosizedDesignCoolingSupplyAirFlowRate(double fractionofAutosizedDesignCoolingSupplyAirFlowRate); | ||
| 278 | |||
| 279 | void resetFractionofAutosizedDesignCoolingSupplyAirFlowRate(); | ||
| 280 | |||
| 281 | bool setDesignSupplyAirFlowRatePerUnitofCapacityDuringCoolingOperation(double designSupplyAirFlowRatePerUnitofCapacityDuringCoolingOperation); | ||
| 282 | |||
| 283 | void resetDesignSupplyAirFlowRatePerUnitofCapacityDuringCoolingOperation(); | ||
| 284 | |||
| 285 | bool setSupplyAirFlowRateMethodDuringHeatingOperation(const std::string& supplyAirFlowRateMethodDuringHeatingOperation); | ||
| 286 | |||
| 287 | void resetSupplyAirFlowRateMethodDuringHeatingOperation(); | ||
| 288 | |||
| 289 | bool setSupplyAirFlowRateDuringHeatingOperation(double supplyAirFlowRateDuringHeatingOperation); | ||
| 290 | |||
| 291 | void resetSupplyAirFlowRateDuringHeatingOperation(); | ||
| 292 | |||
| 293 | void autosizeSupplyAirFlowRateDuringHeatingOperation(); | ||
| 294 | |||
| 295 | bool setSupplyAirFlowRatePerFloorAreaduringHeatingOperation(double supplyAirFlowRatePerFloorAreaduringHeatingOperation); | ||
| 296 | |||
| 297 | void resetSupplyAirFlowRatePerFloorAreaduringHeatingOperation(); | ||
| 298 | |||
| 299 | bool setFractionofAutosizedDesignHeatingSupplyAirFlowRate(double fractionofAutosizedDesignHeatingSupplyAirFlowRate); | ||
| 300 | |||
| 301 | void resetFractionofAutosizedDesignHeatingSupplyAirFlowRate(); | ||
| 302 | |||
| 303 | bool setDesignSupplyAirFlowRatePerUnitofCapacityDuringHeatingOperation(double designSupplyAirFlowRatePerUnitofCapacityDuringHeatingOperation); | ||
| 304 | |||
| 305 | void resetDesignSupplyAirFlowRatePerUnitofCapacityDuringHeatingOperation(); | ||
| 306 | |||
| 307 | bool setSupplyAirFlowRateMethodWhenNoCoolingorHeatingisRequired(const std::string& supplyAirFlowRateMethodWhenNoCoolingorHeatingisRequired); | ||
| 308 | |||
| 309 | void resetSupplyAirFlowRateMethodWhenNoCoolingorHeatingisRequired(); | ||
| 310 | |||
| 311 | bool setSupplyAirFlowRateWhenNoCoolingorHeatingisRequired(double supplyAirFlowRateWhenNoCoolingorHeatingisRequired); | ||
| 312 | |||
| 313 | void resetSupplyAirFlowRateWhenNoCoolingorHeatingisRequired(); | ||
| 314 | |||
| 315 | void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisRequired(); | ||
| 316 | |||
| 317 | bool setSupplyAirFlowRatePerFloorAreaWhenNoCoolingorHeatingisRequired(double supplyAirFlowRatePerFloorAreaWhenNoCoolingorHeatingisRequired); | ||
| 318 | |||
| 319 | void resetSupplyAirFlowRatePerFloorAreaWhenNoCoolingorHeatingisRequired(); | ||
| 320 | |||
| 321 | bool setFractionofAutosizedDesignCoolingSupplyAirFlowRateWhenNoCoolingorHeatingisRequired( | ||
| 322 | double fractionofAutosizedDesignCoolingSupplyAirFlowRateWhenNoCoolingorHeatingisRequired); | ||
| 323 | |||
| 324 | void resetFractionofAutosizedDesignCoolingSupplyAirFlowRateWhenNoCoolingorHeatingisRequired(); | ||
| 325 | |||
| 326 | bool setFractionofAutosizedDesignHeatingSupplyAirFlowRateWhenNoCoolingorHeatingisRequired( | ||
| 327 | double fractionofAutosizedDesignHeatingSupplyAirFlowRateWhenNoCoolingorHeatingisRequired); | ||
| 328 | |||
| 329 | void resetFractionofAutosizedDesignHeatingSupplyAirFlowRateWhenNoCoolingorHeatingisRequired(); | ||
| 330 | |||
| 331 | bool setDesignSupplyAirFlowRatePerUnitofCapacityDuringCoolingOperationWhenNoCoolingorHeatingisRequired( | ||
| 332 | double designSupplyAirFlowRatePerUnitofCapacityDuringCoolingOperationWhenNoCoolingorHeatingisRequired); | ||
| 333 | |||
| 334 | void resetDesignSupplyAirFlowRatePerUnitofCapacityDuringCoolingOperationWhenNoCoolingorHeatingisRequired(); | ||
| 335 | |||
| 336 | bool setDesignSupplyAirFlowRatePerUnitofCapacityDuringHeatingOperationWhenNoCoolingorHeatingisRequired( | ||
| 337 | double designSupplyAirFlowRatePerUnitofCapacityDuringHeatingOperationWhenNoCoolingorHeatingisRequired); | ||
| 338 | |||
| 339 | void resetDesignSupplyAirFlowRatePerUnitofCapacityDuringHeatingOperationWhenNoCoolingorHeatingisRequired(); | ||
| 340 | |||
| 341 | bool setNoLoadSupplyAirFlowRateControlSetToLowSpeed(bool noLoadSupplyAirFlowRateControlSetToLowSpeed); | ||
| 342 | |||
| 343 | bool setMaximumSupplyAirTemperature(double maximumSupplyAirTemperature); | ||
| 344 | |||
| 345 | void resetMaximumSupplyAirTemperature(); | ||
| 346 | |||
| 347 | void autosizeMaximumSupplyAirTemperature(); | ||
| 348 | |||
| 349 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 350 | |||
| 351 | void resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(); | ||
| 352 | |||
| 353 | bool setOutdoorDryBulbTemperatureSensorNodeName(const std::string& outdoorDryBulbTemperatureSensorNodeName); | ||
| 354 | |||
| 355 | void resetOutdoorDryBulbTemperatureSensorNodeName(); | ||
| 356 | |||
| 357 | bool setAncilliaryOnCycleElectricPower(double ancilliaryOnCycleElectricPower); | ||
| 358 | |||
| 359 | void resetAncilliaryOnCycleElectricPower(); | ||
| 360 | |||
| 361 | bool setAncilliaryOffCycleElectricPower(double ancilliaryOffCycleElectricPower); | ||
| 362 | |||
| 363 | void resetAncilliaryOffCycleElectricPower(); | ||
| 364 | |||
| 365 | // bool setDesignHeatRecoveryWaterFlowRate(double designHeatRecoveryWaterFlowRate); | ||
| 366 | |||
| 367 | // void resetDesignHeatRecoveryWaterFlowRate(); | ||
| 368 | |||
| 369 | // bool setMaximumTemperatureforHeatRecovery(double maximumTemperatureforHeatRecovery); | ||
| 370 | |||
| 371 | // void resetMaximumTemperatureforHeatRecovery(); | ||
| 372 | |||
| 373 | bool setDesignSpecificationMultispeedObject(const UnitarySystemPerformanceMultispeed& unitarySystemPerformace); | ||
| 374 | |||
| 375 | void resetDesignSpecificationMultispeedObject(); | ||
| 376 | |||
| 377 | //@} | ||
| 378 | /** @name Other */ | ||
| 379 | //@{ | ||
| 380 | |||
| 381 | //@} | ||
| 382 | protected: | ||
| 383 | private: | ||
| 384 | REGISTER_LOGGER("openstudio.model.AirLoopHVACUnitarySystem"); | ||
| 385 | }; | ||
| 386 | |||
| 387 | } // namespace detail | ||
| 388 | |||
| 389 | } // namespace model | ||
| 390 | } // namespace openstudio | ||
| 391 | |||
| 392 | #endif // MODEL_AIRLOOPHVACUNITARYSYSTEM_IMPL_HPP | ||
| 393 |