src/model/ZoneHVACPackagedTerminalHeatPump_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_ZONEHVACPACKAGEDTERMINALHEATPUMP_IMPL_HPP | ||
| 7 | #define MODEL_ZONEHVACPACKAGEDTERMINALHEATPUMP_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | class HVACComponent; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | /** ZoneHVACPackagedTerminalHeatPump_Impl is a ZoneHVACComponent_Impl that is the implementation class for ZoneHVACPackagedTerminalHeatPump.*/ | ||
| 23 | class MODEL_API ZoneHVACPackagedTerminalHeatPump_Impl : public ZoneHVACComponent_Impl | ||
| 24 | { | ||
| 25 | |||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | ZoneHVACPackagedTerminalHeatPump_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | ZoneHVACPackagedTerminalHeatPump_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | ZoneHVACPackagedTerminalHeatPump_Impl(const ZoneHVACPackagedTerminalHeatPump_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | 29 | virtual ~ZoneHVACPackagedTerminalHeatPump_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 unsigned inletPort() const override; | ||
| 53 | |||
| 54 | virtual unsigned outletPort() const override; | ||
| 55 | |||
| 56 | virtual ComponentType componentType() const override; | ||
| 57 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 58 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 59 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 60 | |||
| 61 | //@} | ||
| 62 | /** @name Getters */ | ||
| 63 | //@{ | ||
| 64 | |||
| 65 | Schedule availabilitySchedule() const; | ||
| 66 | |||
| 67 | std::string outdoorAirMixerObjectType() const; | ||
| 68 | |||
| 69 | std::string outdoorAirMixerName() const; | ||
| 70 | |||
| 71 | boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const; | ||
| 72 | |||
| 73 | bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 74 | |||
| 75 | boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const; | ||
| 76 | |||
| 77 | bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 78 | |||
| 79 | boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 80 | |||
| 81 | bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 82 | |||
| 83 | bool noLoadSupplyAirFlowRateControlSetToLowSpeed() const; | ||
| 84 | |||
| 85 | boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const; | ||
| 86 | |||
| 87 | bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 88 | |||
| 89 | boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const; | ||
| 90 | |||
| 91 | bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 92 | |||
| 93 | boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 94 | |||
| 95 | bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 96 | |||
| 97 | HVACComponent supplyAirFan() const; | ||
| 98 | |||
| 99 | HVACComponent heatingCoil() const; | ||
| 100 | |||
| 101 | double heatingConvergenceTolerance() const; | ||
| 102 | |||
| 103 | bool isHeatingConvergenceToleranceDefaulted() const; | ||
| 104 | |||
| 105 | double minimumOutdoorDryBulbTemperatureforCompressorOperation() const; | ||
| 106 | |||
| 107 | bool isMinimumOutdoorDryBulbTemperatureforCompressorOperationDefaulted() const; | ||
| 108 | |||
| 109 | HVACComponent coolingCoil() const; | ||
| 110 | |||
| 111 | double coolingConvergenceTolerance() const; | ||
| 112 | |||
| 113 | bool isCoolingConvergenceToleranceDefaulted() const; | ||
| 114 | |||
| 115 | HVACComponent supplementalHeatingCoil() const; | ||
| 116 | |||
| 117 | boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 118 | |||
| 119 | bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const; | ||
| 120 | |||
| 121 | double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const; | ||
| 122 | |||
| 123 | bool isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted() const; | ||
| 124 | |||
| 125 | std::string fanPlacement() const; | ||
| 126 | |||
| 127 | bool isFanPlacementDefaulted() const; | ||
| 128 | |||
| 129 | Schedule supplyAirFanOperatingModeSchedule() const; | ||
| 130 | |||
| 131 | double dXHeatingCoilSizingRatio() const; | ||
| 132 | |||
| 133 | boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const; | ||
| 134 | |||
| 135 | boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const; | ||
| 136 | |||
| 137 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 138 | |||
| 139 | boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const; | ||
| 140 | |||
| 141 | boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const; | ||
| 142 | |||
| 143 | boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 144 | |||
| 145 | boost::optional<double> autosizedMaximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 146 | |||
| 147 | virtual void autosize() override; | ||
| 148 | |||
| 149 | virtual void applySizingValues() override; | ||
| 150 | |||
| 151 | //@} | ||
| 152 | /** @name Setters */ | ||
| 153 | //@{ | ||
| 154 | |||
| 155 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 156 | |||
| 157 | bool setOutdoorAirMixerObjectType(const std::string& outdoorAirMixerObjectType); | ||
| 158 | |||
| 159 | bool setOutdoorAirMixerName(const std::string& outdoorAirMixerName); | ||
| 160 | |||
| 161 | bool setSupplyAirFlowRateDuringCoolingOperation(boost::optional<double> supplyAirFlowRateDuringCoolingOperation); | ||
| 162 | |||
| 163 | void autosizeSupplyAirFlowRateDuringCoolingOperation(); | ||
| 164 | |||
| 165 | bool setSupplyAirFlowRateDuringHeatingOperation(boost::optional<double> supplyAirFlowRateDuringHeatingOperation); | ||
| 166 | |||
| 167 | void autosizeSupplyAirFlowRateDuringHeatingOperation(); | ||
| 168 | |||
| 169 | bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 170 | |||
| 171 | void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 172 | |||
| 173 | void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 174 | |||
| 175 | bool setNoLoadSupplyAirFlowRateControlSetToLowSpeed(bool noLoadSupplyAirFlowRateControlSetToLowSpeed); | ||
| 176 | |||
| 177 | bool setOutdoorAirFlowRateDuringCoolingOperation(boost::optional<double> outdoorAirFlowRateDuringCoolingOperation); | ||
| 178 | |||
| 179 | void autosizeOutdoorAirFlowRateDuringCoolingOperation(); | ||
| 180 | |||
| 181 | bool setOutdoorAirFlowRateDuringHeatingOperation(boost::optional<double> outdoorAirFlowRateDuringHeatingOperation); | ||
| 182 | |||
| 183 | void autosizeOutdoorAirFlowRateDuringHeatingOperation(); | ||
| 184 | |||
| 185 | bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 186 | |||
| 187 | void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 188 | |||
| 189 | void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 190 | |||
| 191 | bool setSupplyAirFan(HVACComponent& hvacComponent); | ||
| 192 | |||
| 193 | bool setHeatingCoil(HVACComponent& hvacComponent); | ||
| 194 | |||
| 195 | bool setHeatingConvergenceTolerance(double heatingConvergenceTolerance); | ||
| 196 | |||
| 197 | void resetHeatingConvergenceTolerance(); | ||
| 198 | |||
| 199 | bool setMinimumOutdoorDryBulbTemperatureforCompressorOperation(double minimumOutdoorDryBulbTemperatureforCompressorOperation); | ||
| 200 | |||
| 201 | void resetMinimumOutdoorDryBulbTemperatureforCompressorOperation(); | ||
| 202 | |||
| 203 | bool setCoolingCoil(HVACComponent& hvacComponent); | ||
| 204 | |||
| 205 | bool setCoolingConvergenceTolerance(double coolingConvergenceTolerance); | ||
| 206 | |||
| 207 | void resetCoolingConvergenceTolerance(); | ||
| 208 | |||
| 209 | bool setSupplementalHeatingCoil(HVACComponent& hvacComponent); | ||
| 210 | |||
| 211 | bool setMaximumSupplyAirTemperaturefromSupplementalHeater(boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater); | ||
| 212 | |||
| 213 | void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater(); | ||
| 214 | |||
| 215 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 216 | |||
| 217 | void resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(); | ||
| 218 | |||
| 219 | bool setFanPlacement(const std::string& fanPlacement); | ||
| 220 | |||
| 221 | void resetFanPlacement(); | ||
| 222 | |||
| 223 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 224 | |||
| 225 | bool setDXHeatingCoilSizingRatio(double dXHeatingCoilSizingRatio); | ||
| 226 | |||
| 227 | //@} | ||
| 228 | /** @name Other */ | ||
| 229 | //@{ | ||
| 230 | |||
| 231 | //@} | ||
| 232 | protected: | ||
| 233 | private: | ||
| 234 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACPackagedTerminalHeatPump"); | |
| 235 | |||
| 236 | // optional getters for children() in case need to remove() because constructor fails | ||
| 237 | boost::optional<Schedule> optionalAvailabilitySchedule() const; | ||
| 238 | boost::optional<HVACComponent> optionalSupplyAirFan() const; | ||
| 239 | boost::optional<HVACComponent> optionalHeatingCoil() const; | ||
| 240 | boost::optional<HVACComponent> optionalCoolingCoil() const; | ||
| 241 | boost::optional<HVACComponent> optionalSupplementalHeatingCoil() const; | ||
| 242 | boost::optional<Schedule> optionalSupplyAirFanOperatingModeSchedule() const; | ||
| 243 | |||
| 244 | boost::optional<ModelObject> availabilityScheduleAsModelObject() const; | ||
| 245 | boost::optional<ModelObject> supplyAirFanAsModelObject() const; | ||
| 246 | boost::optional<ModelObject> heatingCoilAsModelObject() const; | ||
| 247 | boost::optional<ModelObject> coolingCoilAsModelObject() const; | ||
| 248 | boost::optional<ModelObject> supplementalHeatingCoilAsModelObject() const; | ||
| 249 | boost::optional<ModelObject> supplyAirFanOperatingModeScheduleAsModelObject() const; | ||
| 250 | |||
| 251 | bool setAvailabilityScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 252 | bool setSupplyAirFanAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 253 | bool setHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 254 | bool setCoolingCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 255 | bool setSupplementalHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 256 | bool setSupplyAirFanOperatingModeScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 257 | }; | ||
| 258 | |||
| 259 | } // namespace detail | ||
| 260 | |||
| 261 | } // namespace model | ||
| 262 | } // namespace openstudio | ||
| 263 | |||
| 264 | #endif // MODEL_ZONEHVACPACKAGEDTERMINALHEATPUMP_IMPL_HPP | ||
| 265 |