src/model/AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass.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_AIRLOOPHVACUNITARYHEATCOOLVAVCHANGEOVERBYPASS_HPP | ||
| 7 | #define MODEL_AIRLOOPHVACUNITARYHEATCOOLVAVCHANGEOVERBYPASS_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class Mixer; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass is a StraightComponent that wraps the OpenStudio IDD object 'OS:AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass'. */ | ||
| 26 | class MODEL_API AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass : public StraightComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass(const Model& model, const HVACComponent& fan, const HVACComponent& coolingCoil, | ||
| 33 | const HVACComponent& heatingCoil); | ||
| 34 | |||
| 35 | 53 | virtual ~AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass(const AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass& other) = default; | |
| 38 | 10 | AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass(AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass&& other) = default; | |
| 39 | ✗ | AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass& operator=(const AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass&) = default; | |
| 40 | ✗ | AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass& operator=(AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | static std::vector<std::string> supplyAirFanPlacementValues(); | ||
| 47 | |||
| 48 | static std::vector<std::string> priorityControlModeValues(); | ||
| 49 | |||
| 50 | static std::vector<std::string> dehumidificationControlTypeValues(); | ||
| 51 | |||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 56 | |||
| 57 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Supply Air Flow Rate" **/ | ||
| 58 | boost::optional<double> systemAirFlowRateDuringCoolingOperation() const; | ||
| 59 | |||
| 60 | bool isSystemAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 61 | |||
| 62 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Supply Air Flow Rate" **/ | ||
| 63 | boost::optional<double> systemAirFlowRateDuringHeatingOperation() const; | ||
| 64 | |||
| 65 | bool isSystemAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 66 | |||
| 67 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate" **/ | ||
| 68 | boost::optional<double> systemAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 69 | |||
| 70 | bool isSystemAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 71 | |||
| 72 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Outdoor Air Flow Rate" **/ | ||
| 73 | boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const; | ||
| 74 | |||
| 75 | bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 76 | |||
| 77 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Outdoor Air Flow Rate" **/ | ||
| 78 | boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const; | ||
| 79 | |||
| 80 | bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 81 | |||
| 82 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Outdoor Air Flow Rate" **/ | ||
| 83 | boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 84 | |||
| 85 | bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 86 | |||
| 87 | boost::optional<Schedule> outdoorAirFlowRateMultiplierSchedule() const; | ||
| 88 | |||
| 89 | HVACComponent supplyAirFan() const; | ||
| 90 | |||
| 91 | std::string supplyAirFanPlacement() const; | ||
| 92 | |||
| 93 | boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const; | ||
| 94 | |||
| 95 | HVACComponent coolingCoil() const; | ||
| 96 | |||
| 97 | HVACComponent heatingCoil() const; | ||
| 98 | |||
| 99 | std::string priorityControlMode() const; | ||
| 100 | |||
| 101 | double minimumOutletAirTemperatureDuringCoolingOperation() const; | ||
| 102 | |||
| 103 | double maximumOutletAirTemperatureDuringHeatingOperation() const; | ||
| 104 | |||
| 105 | std::string dehumidificationControlType() const; | ||
| 106 | |||
| 107 | double minimumRuntimeBeforeOperatingModeChange() const; | ||
| 108 | |||
| 109 | unsigned plenumorMixerAirPort() const; | ||
| 110 | |||
| 111 | /** This Node always exists for connecting "Plenum or Mixer Inlet Node", it will be translated only if actually connected to an | ||
| 112 | * AirLoopHVAC:ReturnPlenum or an AirLoopHVAC:ZoneMixer */ | ||
| 113 | Node plenumorMixerNode() const; | ||
| 114 | |||
| 115 | /** Convenience method to get the optional linked Mixer object (AirLoopHVAC:ReturnPlenum or AirLoopHVAC:ZoneMixer) */ | ||
| 116 | boost::optional<Mixer> plenumorMixer() const; | ||
| 117 | |||
| 118 | //@} | ||
| 119 | /** @name Setters */ | ||
| 120 | //@{ | ||
| 121 | |||
| 122 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 123 | |||
| 124 | void resetAvailabilitySchedule(); | ||
| 125 | |||
| 126 | bool setSystemAirFlowRateDuringCoolingOperation(double systemAirFlowRateDuringCoolingOperation); | ||
| 127 | |||
| 128 | void autosizeSystemAirFlowRateDuringCoolingOperation(); | ||
| 129 | |||
| 130 | bool setSystemAirFlowRateDuringHeatingOperation(double systemAirFlowRateDuringHeatingOperation); | ||
| 131 | |||
| 132 | void autosizeSystemAirFlowRateDuringHeatingOperation(); | ||
| 133 | |||
| 134 | bool setSystemAirFlowRateWhenNoCoolingorHeatingisNeeded(double systemAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 135 | |||
| 136 | void autosizeSystemAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 137 | |||
| 138 | bool setOutdoorAirFlowRateDuringCoolingOperation(double outdoorAirFlowRateDuringCoolingOperation); | ||
| 139 | |||
| 140 | void autosizeOutdoorAirFlowRateDuringCoolingOperation(); | ||
| 141 | |||
| 142 | bool setOutdoorAirFlowRateDuringHeatingOperation(double outdoorAirFlowRateDuringHeatingOperation); | ||
| 143 | |||
| 144 | void autosizeOutdoorAirFlowRateDuringHeatingOperation(); | ||
| 145 | |||
| 146 | bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(double outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 147 | |||
| 148 | void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 149 | |||
| 150 | bool setOutdoorAirFlowRateMultiplierSchedule(Schedule& outdoorAirFlowRateMultiplierSchedule); | ||
| 151 | |||
| 152 | void resetOutdoorAirFlowRateMultiplierSchedule(); | ||
| 153 | |||
| 154 | bool setSupplyAirFan(const HVACComponent& fansCVandOnOff); | ||
| 155 | |||
| 156 | bool setSupplyAirFanPlacement(const std::string& supplyAirFanPlacement); | ||
| 157 | |||
| 158 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 159 | |||
| 160 | void resetSupplyAirFanOperatingModeSchedule(); | ||
| 161 | |||
| 162 | bool setCoolingCoil(const HVACComponent& coolingCoilName); | ||
| 163 | |||
| 164 | bool setHeatingCoil(const HVACComponent& heatingCoilName); | ||
| 165 | |||
| 166 | bool setPriorityControlMode(const std::string& priorityControlMode); | ||
| 167 | |||
| 168 | bool setMinimumOutletAirTemperatureDuringCoolingOperation(double minimumOutletAirTemperatureDuringCoolingOperation); | ||
| 169 | |||
| 170 | bool setMaximumOutletAirTemperatureDuringHeatingOperation(double maximumOutletAirTemperatureDuringHeatingOperation); | ||
| 171 | |||
| 172 | bool setDehumidificationControlType(const std::string& dehumidificationControlType); | ||
| 173 | |||
| 174 | bool setMinimumRuntimeBeforeOperatingModeChange(double runtime); | ||
| 175 | |||
| 176 | /** Connect the bypass air duct to an AirLoopHVAC:ReturnPlenum or an AirLoopHVAC:ZoneMixer that must | ||
| 177 | * be on the same AirLoopHVAC as this Unitary System */ | ||
| 178 | bool setPlenumorMixer(const Mixer& returnPathComponent); | ||
| 179 | |||
| 180 | void resetPlenumorMixer(); | ||
| 181 | |||
| 182 | boost::optional<double> autosizedSystemAirFlowRateDuringCoolingOperation() const; | ||
| 183 | |||
| 184 | boost::optional<double> autosizedSystemAirFlowRateDuringHeatingOperation() const; | ||
| 185 | |||
| 186 | boost::optional<double> autosizedSystemAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 187 | |||
| 188 | boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const; | ||
| 189 | |||
| 190 | boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const; | ||
| 191 | |||
| 192 | boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 193 | |||
| 194 | //@} | ||
| 195 | /** @name Other */ | ||
| 196 | //@{ | ||
| 197 | //@} | ||
| 198 | protected: | ||
| 199 | /// @cond | ||
| 200 | using ImplType = detail::AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass_Impl; | ||
| 201 | |||
| 202 | explicit AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass(std::shared_ptr<detail::AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass_Impl> impl); | ||
| 203 | |||
| 204 | friend class detail::AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass_Impl; | ||
| 205 | friend class Model; | ||
| 206 | friend class IdfObject; | ||
| 207 | friend class openstudio::detail::IdfObject_Impl; | ||
| 208 | /// @endcond | ||
| 209 | private: | ||
| 210 | − | REGISTER_LOGGER("openstudio.model.AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass"); | |
| 211 | }; | ||
| 212 | |||
| 213 | /** \relates AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass*/ | ||
| 214 | using OptionalAirLoopHVACUnitaryHeatCoolVAVChangeoverBypass = boost::optional<AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass>; | ||
| 215 | |||
| 216 | /** \relates AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass*/ | ||
| 217 | using AirLoopHVACUnitaryHeatCoolVAVChangeoverBypassVector = std::vector<AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass>; | ||
| 218 | |||
| 219 | } // namespace model | ||
| 220 | } // namespace openstudio | ||
| 221 | |||
| 222 | #endif // MODEL_AIRLOOPHVACUNITARYHEATCOOLVAVCHANGEOVERBYPASS_HPP | ||
| 223 |