src/model/ZoneHVACFourPipeFanCoil.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_ZONEHVACFOURPIPEFANCOIL_HPP | ||
| 7 | #define MODEL_ZONEHVACFOURPIPEFANCOIL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class HVACComponent; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class ZoneHVACFourPipeFanCoil_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACFourPipeFanCoil is a ZoneHVACComponent that wraps the | ||
| 26 | * OpenStudio IDD object 'OS:ZoneHVAC:FourPipeFanCoil'. | ||
| 27 | * If fan type is OS:Fan:ConstantVolume, all availability schedule values must be greater than zero | ||
| 28 | */ | ||
| 29 | class MODEL_API ZoneHVACFourPipeFanCoil : public ZoneHVACComponent | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | /** Construct new ZoneHVACFourPipeFanCoil. capacityControlMethod is set based on the IddObjectType of supplyAirFan: | ||
| 36 | * \li OS:Fan:ConstantVolume results in capacityControlMethod == "ConstantFanVariableFlow" | ||
| 37 | * \li OS:Fan:OnOff results in capacityControlMethod == "CyclingFan" | ||
| 38 | * \li OS:Fan:VariableVolume results in capacityControlMethod == "VariableFanVariableFlow" | ||
| 39 | */ | ||
| 40 | ZoneHVACFourPipeFanCoil(const Model& model, Schedule& availabilitySchedule, HVACComponent& supplyAirFan, HVACComponent& coolingCoil, | ||
| 41 | HVACComponent& heatingCoil); | ||
| 42 | |||
| 43 | 22 | virtual ~ZoneHVACFourPipeFanCoil() override = default; | |
| 44 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 45 | ✗ | ZoneHVACFourPipeFanCoil(const ZoneHVACFourPipeFanCoil& other) = default; | |
| 46 | 6 | ZoneHVACFourPipeFanCoil(ZoneHVACFourPipeFanCoil&& other) = default; | |
| 47 | ✗ | ZoneHVACFourPipeFanCoil& operator=(const ZoneHVACFourPipeFanCoil&) = default; | |
| 48 | ✗ | ZoneHVACFourPipeFanCoil& operator=(ZoneHVACFourPipeFanCoil&&) = default; | |
| 49 | |||
| 50 | //@} | ||
| 51 | |||
| 52 | static IddObjectType iddObjectType(); | ||
| 53 | |||
| 54 | static std::vector<std::string> capacityControlMethodValues(); | ||
| 55 | |||
| 56 | static std::vector<std::string> outdoorAirMixerObjectTypeValues(); | ||
| 57 | |||
| 58 | /** @name Getters */ | ||
| 59 | //@{ | ||
| 60 | |||
| 61 | Schedule availabilitySchedule() const; | ||
| 62 | |||
| 63 | std::string capacityControlMethod() const; | ||
| 64 | |||
| 65 | boost::optional<double> maximumSupplyAirFlowRate() const; | ||
| 66 | |||
| 67 | bool isMaximumSupplyAirFlowRateAutosized() const; | ||
| 68 | |||
| 69 | double lowSpeedSupplyAirFlowRatio() const; | ||
| 70 | |||
| 71 | bool isLowSpeedSupplyAirFlowRatioDefaulted() const; | ||
| 72 | |||
| 73 | double mediumSpeedSupplyAirFlowRatio() const; | ||
| 74 | |||
| 75 | bool isMediumSpeedSupplyAirFlowRatioDefaulted() const; | ||
| 76 | |||
| 77 | boost::optional<double> maximumOutdoorAirFlowRate() const; | ||
| 78 | |||
| 79 | bool isMaximumOutdoorAirFlowRateAutosized() const; | ||
| 80 | |||
| 81 | boost::optional<Schedule> outdoorAirSchedule() const; | ||
| 82 | |||
| 83 | std::string outdoorAirMixerObjectType() const; | ||
| 84 | |||
| 85 | std::string outdoorAirMixerName() const; | ||
| 86 | |||
| 87 | HVACComponent supplyAirFan() const; | ||
| 88 | |||
| 89 | HVACComponent coolingCoil() const; | ||
| 90 | |||
| 91 | boost::optional<double> maximumColdWaterFlowRate() const; | ||
| 92 | |||
| 93 | bool isMaximumColdWaterFlowRateAutosized() const; | ||
| 94 | |||
| 95 | double minimumColdWaterFlowRate() const; | ||
| 96 | |||
| 97 | bool isMinimumColdWaterFlowRateDefaulted() const; | ||
| 98 | |||
| 99 | double coolingConvergenceTolerance() const; | ||
| 100 | |||
| 101 | bool isCoolingConvergenceToleranceDefaulted() const; | ||
| 102 | |||
| 103 | HVACComponent heatingCoil() const; | ||
| 104 | |||
| 105 | boost::optional<double> maximumHotWaterFlowRate() const; | ||
| 106 | |||
| 107 | bool isMaximumHotWaterFlowRateAutosized() const; | ||
| 108 | |||
| 109 | double minimumHotWaterFlowRate() const; | ||
| 110 | |||
| 111 | bool isMinimumHotWaterFlowRateDefaulted() const; | ||
| 112 | |||
| 113 | double heatingConvergenceTolerance() const; | ||
| 114 | |||
| 115 | bool isHeatingConvergenceToleranceDefaulted() const; | ||
| 116 | |||
| 117 | boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const; | ||
| 118 | |||
| 119 | bool isMinimumSupplyAirTemperatureInCoolingModeAutosized() const; | ||
| 120 | |||
| 121 | boost::optional<double> minimumSupplyAirTemperatureInCoolingMode() const; | ||
| 122 | |||
| 123 | bool isMaximumSupplyAirTemperatureInHeatingModeAutosized() const; | ||
| 124 | |||
| 125 | boost::optional<double> maximumSupplyAirTemperatureInHeatingMode() const; | ||
| 126 | |||
| 127 | //@} | ||
| 128 | /** @name Setters */ | ||
| 129 | //@{ | ||
| 130 | |||
| 131 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 132 | |||
| 133 | bool setCapacityControlMethod(const std::string& capacityControlMethod); | ||
| 134 | |||
| 135 | bool setMaximumSupplyAirFlowRate(double maximumSupplyAirFlowRate); | ||
| 136 | |||
| 137 | void autosizeMaximumSupplyAirFlowRate(); | ||
| 138 | |||
| 139 | bool setLowSpeedSupplyAirFlowRatio(double lowSpeedSupplyAirFlowRatio); | ||
| 140 | |||
| 141 | void resetLowSpeedSupplyAirFlowRatio(); | ||
| 142 | |||
| 143 | bool setMediumSpeedSupplyAirFlowRatio(double mediumSpeedSupplyAirFlowRatio); | ||
| 144 | |||
| 145 | void resetMediumSpeedSupplyAirFlowRatio(); | ||
| 146 | |||
| 147 | bool setMaximumOutdoorAirFlowRate(double maximumOutdoorAirFlowRate); | ||
| 148 | |||
| 149 | void autosizeMaximumOutdoorAirFlowRate(); | ||
| 150 | |||
| 151 | bool setOutdoorAirSchedule(Schedule& schedule); | ||
| 152 | |||
| 153 | void resetOutdoorAirSchedule(); | ||
| 154 | |||
| 155 | bool setOutdoorAirMixerObjectType(const std::string& outdoorAirMixerObjectType); | ||
| 156 | |||
| 157 | bool setOutdoorAirMixerName(const std::string& outdoorAirMixerName); | ||
| 158 | |||
| 159 | bool setSupplyAirFan(HVACComponent& fan); | ||
| 160 | |||
| 161 | bool setCoolingCoil(HVACComponent& coolingCoil); | ||
| 162 | |||
| 163 | bool setMaximumColdWaterFlowRate(double maximumColdWaterFlowRate); | ||
| 164 | |||
| 165 | void autosizeMaximumColdWaterFlowRate(); | ||
| 166 | |||
| 167 | bool setMinimumColdWaterFlowRate(double minimumColdWaterFlowRate); | ||
| 168 | |||
| 169 | void resetMinimumColdWaterFlowRate(); | ||
| 170 | |||
| 171 | bool setCoolingConvergenceTolerance(double coolingConvergenceTolerance); | ||
| 172 | |||
| 173 | void resetCoolingConvergenceTolerance(); | ||
| 174 | |||
| 175 | bool setHeatingCoil(HVACComponent& heatingCoil); | ||
| 176 | |||
| 177 | bool setMaximumHotWaterFlowRate(double maximumHotWaterFlowRate); | ||
| 178 | |||
| 179 | void autosizeMaximumHotWaterFlowRate(); | ||
| 180 | |||
| 181 | bool setMinimumHotWaterFlowRate(double minimumHotWaterFlowRate); | ||
| 182 | |||
| 183 | void resetMinimumHotWaterFlowRate(); | ||
| 184 | |||
| 185 | bool setHeatingConvergenceTolerance(double heatingConvergenceTolerance); | ||
| 186 | |||
| 187 | void resetHeatingConvergenceTolerance(); | ||
| 188 | |||
| 189 | /** Sets the supply air fan operating mode schedule. Values of zero indicate that the fan | ||
| 190 | * cycles on and off with the active (heating or cooling) coil. Other values operate the | ||
| 191 | * fan continuously. */ | ||
| 192 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 193 | |||
| 194 | void resetSupplyAirFanOperatingModeSchedule(); | ||
| 195 | |||
| 196 | void autosizeMinimumSupplyAirTemperatureInCoolingMode(); | ||
| 197 | |||
| 198 | bool setMinimumSupplyAirTemperatureInCoolingMode(double minimumSupplyAirTemperatureInCoolingMode); | ||
| 199 | |||
| 200 | void autosizeMaximumSupplyAirTemperatureInHeatingMode(); | ||
| 201 | |||
| 202 | bool setMaximumSupplyAirTemperatureInHeatingMode(double maximumSupplyAirTemperatureInHeatingMode); | ||
| 203 | |||
| 204 | //@} | ||
| 205 | /** @name Other */ | ||
| 206 | //@{ | ||
| 207 | |||
| 208 | boost::optional<double> autosizedMaximumSupplyAirFlowRate() const; | ||
| 209 | |||
| 210 | boost::optional<double> autosizedMaximumOutdoorAirFlowRate() const; | ||
| 211 | |||
| 212 | boost::optional<double> autosizedMaximumColdWaterFlowRate() const; | ||
| 213 | |||
| 214 | boost::optional<double> autosizedMaximumHotWaterFlowRate() const; | ||
| 215 | |||
| 216 | boost::optional<double> autosizedMinimumSupplyAirTemperatureinCoolingMode() const; | ||
| 217 | |||
| 218 | boost::optional<double> autosizedMaximumSupplyAirTemperatureinHeatingMode() const; | ||
| 219 | |||
| 220 | //@} | ||
| 221 | protected: | ||
| 222 | /// @cond | ||
| 223 | using ImplType = detail::ZoneHVACFourPipeFanCoil_Impl; | ||
| 224 | |||
| 225 | explicit ZoneHVACFourPipeFanCoil(std::shared_ptr<detail::ZoneHVACFourPipeFanCoil_Impl> impl); | ||
| 226 | |||
| 227 | friend class detail::ZoneHVACFourPipeFanCoil_Impl; | ||
| 228 | friend class Model; | ||
| 229 | friend class IdfObject; | ||
| 230 | friend class openstudio::detail::IdfObject_Impl; | ||
| 231 | |||
| 232 | /// @endcond | ||
| 233 | private: | ||
| 234 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACFourPipeFanCoil"); | |
| 235 | }; | ||
| 236 | |||
| 237 | /** \relates ZoneHVACFourPipeFanCoil*/ | ||
| 238 | using OptionalZoneHVACFourPipeFanCoil = boost::optional<ZoneHVACFourPipeFanCoil>; | ||
| 239 | |||
| 240 | /** \relates ZoneHVACFourPipeFanCoil*/ | ||
| 241 | using ZoneHVACFourPipeFanCoilVector = std::vector<ZoneHVACFourPipeFanCoil>; | ||
| 242 | |||
| 243 | } // namespace model | ||
| 244 | } // namespace openstudio | ||
| 245 | |||
| 246 | #endif // MODEL_ZONEHVACFOURPIPEFANCOIL_HPP | ||
| 247 |