src/model/RefrigerationAirChiller_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_REFRIGERATIONAIRCHILLER_IMPL_HPP | ||
| 7 | #define MODEL_REFRIGERATIONAIRCHILLER_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class RefrigerationSystem; | ||
| 16 | class RefrigerationSecondarySystem; | ||
| 17 | class RefrigerationCompressorRack; | ||
| 18 | class Schedule; | ||
| 19 | // class CurveLinear; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** RefrigerationAirChiller_Impl is a ZoneHVACComponent_Impl that is the implementation class for RefrigerationAirChiller.*/ | ||
| 24 | class MODEL_API RefrigerationAirChiller_Impl : public ZoneHVACComponent_Impl | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | RefrigerationAirChiller_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | RefrigerationAirChiller_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | RefrigerationAirChiller_Impl(const RefrigerationAirChiller_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | 32 | virtual ~RefrigerationAirChiller_Impl() override = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | /** @name Virtual Methods */ | ||
| 40 | //@{ | ||
| 41 | |||
| 42 | virtual ModelObject clone(Model model) const override; | ||
| 43 | |||
| 44 | virtual std::vector<IdfObject> remove() override; | ||
| 45 | |||
| 46 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 47 | |||
| 48 | virtual IddObjectType iddObjectType() const override; | ||
| 49 | |||
| 50 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 51 | |||
| 52 | // virtual std::vector<ModelObject> children() const; | ||
| 53 | |||
| 54 | virtual unsigned inletPort() const override; | ||
| 55 | |||
| 56 | virtual unsigned outletPort() const override; | ||
| 57 | |||
| 58 | virtual bool addToThermalZone(ThermalZone& thermalZone) override; | ||
| 59 | |||
| 60 | virtual void removeFromThermalZone() override; | ||
| 61 | |||
| 62 | virtual boost::optional<ThermalZone> thermalZone() const override; | ||
| 63 | |||
| 64 | virtual ComponentType componentType() const override; | ||
| 65 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 66 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 67 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 68 | |||
| 69 | //@} | ||
| 70 | /** @name Getters */ | ||
| 71 | //@{ | ||
| 72 | |||
| 73 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 74 | |||
| 75 | std::string capacityRatingType() const; | ||
| 76 | |||
| 77 | boost::optional<double> ratedUnitLoadFactor() const; | ||
| 78 | |||
| 79 | boost::optional<double> ratedCapacity() const; | ||
| 80 | |||
| 81 | double ratedRelativeHumidity() const; | ||
| 82 | |||
| 83 | bool isRatedRelativeHumidityDefaulted() const; | ||
| 84 | |||
| 85 | double ratedCoolingSourceTemperature() const; | ||
| 86 | |||
| 87 | double ratedTemperatureDifferenceDT1() const; | ||
| 88 | |||
| 89 | boost::optional<double> maximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature() const; | ||
| 90 | |||
| 91 | double coilMaterialCorrectionFactor() const; | ||
| 92 | |||
| 93 | bool isCoilMaterialCorrectionFactorDefaulted() const; | ||
| 94 | |||
| 95 | double refrigerantCorrectionFactor() const; | ||
| 96 | |||
| 97 | bool isRefrigerantCorrectionFactorDefaulted() const; | ||
| 98 | |||
| 99 | // std::string capacityCorrectionCurveType() const; | ||
| 100 | |||
| 101 | // bool isCapacityCorrectionCurveTypeDefaulted() const; | ||
| 102 | |||
| 103 | // boost::optional<CurveLinear> capacityCorrectionCurve() const; | ||
| 104 | |||
| 105 | double sHR60CorrectionFactor() const; | ||
| 106 | |||
| 107 | bool isSHR60CorrectionFactorDefaulted() const; | ||
| 108 | |||
| 109 | double ratedTotalHeatingPower() const; | ||
| 110 | |||
| 111 | boost::optional<Schedule> heatingPowerSchedule() const; | ||
| 112 | |||
| 113 | std::string fanSpeedControlType() const; | ||
| 114 | |||
| 115 | bool isFanSpeedControlTypeDefaulted() const; | ||
| 116 | |||
| 117 | double ratedFanPower() const; | ||
| 118 | |||
| 119 | bool isRatedFanPowerDefaulted() const; | ||
| 120 | |||
| 121 | double ratedAirFlow() const; | ||
| 122 | |||
| 123 | double minimumFanAirFlowRatio() const; | ||
| 124 | |||
| 125 | bool isMinimumFanAirFlowRatioDefaulted() const; | ||
| 126 | |||
| 127 | std::string defrostType() const; | ||
| 128 | |||
| 129 | bool isDefrostTypeDefaulted() const; | ||
| 130 | |||
| 131 | std::string defrostControlType() const; | ||
| 132 | |||
| 133 | bool isDefrostControlTypeDefaulted() const; | ||
| 134 | |||
| 135 | Schedule defrostSchedule() const; | ||
| 136 | |||
| 137 | boost::optional<Schedule> defrostDripDownSchedule() const; | ||
| 138 | |||
| 139 | boost::optional<double> defrostPower() const; | ||
| 140 | |||
| 141 | boost::optional<double> temperatureTerminationDefrostFractiontoIce() const; | ||
| 142 | |||
| 143 | std::string verticalLocation() const; | ||
| 144 | |||
| 145 | bool isVerticalLocationDefaulted() const; | ||
| 146 | |||
| 147 | double averageRefrigerantChargeInventory() const; | ||
| 148 | |||
| 149 | bool isAverageRefrigerantChargeInventoryDefaulted() const; | ||
| 150 | |||
| 151 | boost::optional<RefrigerationSystem> system() const; | ||
| 152 | |||
| 153 | boost::optional<RefrigerationSecondarySystem> secondarySystem() const; | ||
| 154 | |||
| 155 | boost::optional<RefrigerationCompressorRack> compressorRack() const; | ||
| 156 | |||
| 157 | //@} | ||
| 158 | /** @name Setters */ | ||
| 159 | //@{ | ||
| 160 | |||
| 161 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 162 | |||
| 163 | void resetAvailabilitySchedule(); | ||
| 164 | |||
| 165 | bool setCapacityRatingType(const std::string& capacityRatingType); | ||
| 166 | |||
| 167 | bool setRatedUnitLoadFactor(boost::optional<double> ratedUnitLoadFactor); | ||
| 168 | |||
| 169 | void resetRatedUnitLoadFactor(); | ||
| 170 | |||
| 171 | bool setRatedCapacity(boost::optional<double> ratedCapacity); | ||
| 172 | |||
| 173 | void resetRatedCapacity(); | ||
| 174 | |||
| 175 | bool setRatedRelativeHumidity(double ratedRelativeHumidity); | ||
| 176 | |||
| 177 | void resetRatedRelativeHumidity(); | ||
| 178 | |||
| 179 | bool setRatedCoolingSourceTemperature(double ratedCoolingSourceTemperature); | ||
| 180 | |||
| 181 | bool setRatedTemperatureDifferenceDT1(double ratedTemperatureDifferenceDT1); | ||
| 182 | |||
| 183 | bool setMaximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature( | ||
| 184 | boost::optional<double> maximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature); | ||
| 185 | |||
| 186 | void resetMaximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature(); | ||
| 187 | |||
| 188 | bool setCoilMaterialCorrectionFactor(double coilMaterialCorrectionFactor); | ||
| 189 | |||
| 190 | void resetCoilMaterialCorrectionFactor(); | ||
| 191 | |||
| 192 | bool setRefrigerantCorrectionFactor(double refrigerantCorrectionFactor); | ||
| 193 | |||
| 194 | void resetRefrigerantCorrectionFactor(); | ||
| 195 | |||
| 196 | // bool setCapacityCorrectionCurveType(const std::string& capacityCorrectionCurveType); | ||
| 197 | |||
| 198 | // void resetCapacityCorrectionCurveType(); | ||
| 199 | |||
| 200 | // bool setCapacityCorrectionCurve(const boost::optional<CurveLinear>& curveLinear); | ||
| 201 | |||
| 202 | // void resetCapacityCorrectionCurve(); | ||
| 203 | |||
| 204 | bool setSHR60CorrectionFactor(double sHR60CorrectionFactor); | ||
| 205 | |||
| 206 | void resetSHR60CorrectionFactor(); | ||
| 207 | |||
| 208 | bool setRatedTotalHeatingPower(double ratedTotalHeatingPower); | ||
| 209 | |||
| 210 | bool setHeatingPowerSchedule(Schedule& schedule); | ||
| 211 | |||
| 212 | void resetHeatingPowerSchedule(); | ||
| 213 | |||
| 214 | bool setFanSpeedControlType(const std::string& fanSpeedControlType); | ||
| 215 | |||
| 216 | void resetFanSpeedControlType(); | ||
| 217 | |||
| 218 | bool setRatedFanPower(double ratedFanPower); | ||
| 219 | |||
| 220 | void resetRatedFanPower(); | ||
| 221 | |||
| 222 | bool setRatedAirFlow(double ratedAirFlow); | ||
| 223 | |||
| 224 | bool setMinimumFanAirFlowRatio(double minimumFanAirFlowRatio); | ||
| 225 | |||
| 226 | void resetMinimumFanAirFlowRatio(); | ||
| 227 | |||
| 228 | bool setDefrostType(const std::string& defrostType); | ||
| 229 | |||
| 230 | void resetDefrostType(); | ||
| 231 | |||
| 232 | bool setDefrostControlType(const std::string& defrostControlType); | ||
| 233 | |||
| 234 | void resetDefrostControlType(); | ||
| 235 | |||
| 236 | bool setDefrostSchedule(Schedule& schedule); | ||
| 237 | |||
| 238 | bool setDefrostDripDownSchedule(Schedule& schedule); | ||
| 239 | |||
| 240 | void resetDefrostDripDownSchedule(); | ||
| 241 | |||
| 242 | bool setDefrostPower(boost::optional<double> defrostPower); | ||
| 243 | |||
| 244 | void resetDefrostPower(); | ||
| 245 | |||
| 246 | bool setTemperatureTerminationDefrostFractiontoIce(boost::optional<double> temperatureTerminationDefrostFractiontoIce); | ||
| 247 | |||
| 248 | void resetTemperatureTerminationDefrostFractiontoIce(); | ||
| 249 | |||
| 250 | bool setVerticalLocation(const std::string& verticalLocation); | ||
| 251 | |||
| 252 | void resetVerticalLocation(); | ||
| 253 | |||
| 254 | bool setAverageRefrigerantChargeInventory(double averageRefrigerantChargeInventory); | ||
| 255 | |||
| 256 | void resetAverageRefrigerantChargeInventory(); | ||
| 257 | |||
| 258 | bool addToSystem(RefrigerationSystem& system); | ||
| 259 | |||
| 260 | void removeFromSystem(); | ||
| 261 | |||
| 262 | bool addToSecondarySystem(RefrigerationSecondarySystem& secondarySystem); | ||
| 263 | |||
| 264 | void removeFromSecondarySystem(); | ||
| 265 | |||
| 266 | bool addToCompressorRack(RefrigerationCompressorRack& compressorRack); | ||
| 267 | |||
| 268 | void removeFromCompressorRack(); | ||
| 269 | |||
| 270 | //@} | ||
| 271 | /** @name Other */ | ||
| 272 | //@{ | ||
| 273 | |||
| 274 | //@} | ||
| 275 | protected: | ||
| 276 | private: | ||
| 277 | − | REGISTER_LOGGER("openstudio.model.RefrigerationAirChiller"); | |
| 278 | |||
| 279 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 280 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 281 | // objects should be returned as boost::optionals | ||
| 282 | boost::optional<Schedule> optionalDefrostSchedule() const; | ||
| 283 | }; | ||
| 284 | |||
| 285 | } // namespace detail | ||
| 286 | |||
| 287 | } // namespace model | ||
| 288 | } // namespace openstudio | ||
| 289 | |||
| 290 | #endif // MODEL_REFRIGERATIONAIRCHILLER_IMPL_HPP | ||
| 291 |