src/model/ZoneHVACTerminalUnitVariableRefrigerantFlow_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_ZONEHVACTERMINALUNITVARIABLEREFRIGERANTFLOW_IMPL_HPP | ||
| 7 | #define MODEL_ZONEHVACTERMINALUNITVARIABLEREFRIGERANTFLOW_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class HVACComponent; | ||
| 17 | class Schedule; | ||
| 18 | class ThermalZone; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | /** ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl is a ZoneHVACComponent_Impl that is the implementation class for ZoneHVACTerminalUnitVariableRefrigerantFlow.*/ | ||
| 23 | class MODEL_API ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl : public ZoneHVACComponent_Impl | ||
| 24 | { | ||
| 25 | |||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl(const ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl& other, Model_Impl* model, | ||
| 35 | bool keepHandle); | ||
| 36 | |||
| 37 | 108 | virtual ~ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl() override = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | /** @name Virtual Methods */ | ||
| 41 | //@{ | ||
| 42 | |||
| 43 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 44 | |||
| 45 | virtual IddObjectType iddObjectType() const override; | ||
| 46 | |||
| 47 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 48 | |||
| 49 | virtual void autosize() override; | ||
| 50 | |||
| 51 | virtual void applySizingValues() override; | ||
| 52 | |||
| 53 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 54 | |||
| 55 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 56 | |||
| 57 | virtual unsigned inletPort() const override; | ||
| 58 | |||
| 59 | virtual unsigned outletPort() const override; | ||
| 60 | |||
| 61 | virtual bool addToNode(Node& node) override; | ||
| 62 | |||
| 63 | virtual ModelObject clone(Model model) const override; | ||
| 64 | |||
| 65 | virtual std::vector<ModelObject> children() const override; | ||
| 66 | |||
| 67 | virtual ComponentType componentType() const override; | ||
| 68 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 69 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 70 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 71 | |||
| 72 | //@} | ||
| 73 | /** @name Getters */ | ||
| 74 | //@{ | ||
| 75 | |||
| 76 | Schedule terminalUnitAvailabilityschedule() const; | ||
| 77 | |||
| 78 | boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const; | ||
| 79 | |||
| 80 | bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 81 | |||
| 82 | boost::optional<double> supplyAirFlowRateWhenNoCoolingisNeeded() const; | ||
| 83 | |||
| 84 | bool isSupplyAirFlowRateWhenNoCoolingisNeededAutosized() const; | ||
| 85 | |||
| 86 | boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const; | ||
| 87 | |||
| 88 | bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 89 | |||
| 90 | boost::optional<double> supplyAirFlowRateWhenNoHeatingisNeeded() const; | ||
| 91 | |||
| 92 | bool isSupplyAirFlowRateWhenNoHeatingisNeededAutosized() const; | ||
| 93 | |||
| 94 | boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const; | ||
| 95 | |||
| 96 | bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 97 | |||
| 98 | boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const; | ||
| 99 | |||
| 100 | bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 101 | |||
| 102 | boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 103 | |||
| 104 | bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 105 | |||
| 106 | Schedule supplyAirFanOperatingModeSchedule() const; | ||
| 107 | |||
| 108 | boost::optional<HVACComponent> supplyAirFan() const; | ||
| 109 | |||
| 110 | boost::optional<HVACComponent> coolingCoil() const; | ||
| 111 | |||
| 112 | boost::optional<HVACComponent> heatingCoil() const; | ||
| 113 | |||
| 114 | double zoneTerminalUnitOnParasiticElectricEnergyUse() const; | ||
| 115 | |||
| 116 | double zoneTerminalUnitOffParasiticElectricEnergyUse() const; | ||
| 117 | |||
| 118 | double ratedTotalHeatingCapacitySizingRatio() const; | ||
| 119 | |||
| 120 | // Supplemental Heating Coil Name | ||
| 121 | boost::optional<HVACComponent> supplementalHeatingCoil() const; | ||
| 122 | bool setSupplementalHeatingCoil(const HVACComponent& coil); | ||
| 123 | void resetSupplementalHeatingCoil(); | ||
| 124 | |||
| 125 | // Maximum Supply Air Temperature from Supplemental Heater (autosized) | ||
| 126 | boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 127 | bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const; | ||
| 128 | bool setMaximumSupplyAirTemperaturefromSupplementalHeater(double maximumSupplyAirTemperaturefromSupplementalHeater); | ||
| 129 | void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater(); | ||
| 130 | |||
| 131 | // Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation (default 21C) | ||
| 132 | double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const; | ||
| 133 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 134 | |||
| 135 | // Controlling Zone or Thermostat Location | ||
| 136 | boost::optional<ThermalZone> controllingZoneorThermostatLocation() const; | ||
| 137 | bool setControllingZoneorThermostatLocation(const ThermalZone& thermalZone); | ||
| 138 | void resetControllingZoneorThermostatLocation(); | ||
| 139 | |||
| 140 | // Supply Air Fan Placement | ||
| 141 | std::string supplyAirFanPlacement() const; | ||
| 142 | bool setSupplyAirFanPlacement(const std::string& supplyAirFanPlacement); | ||
| 143 | |||
| 144 | boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const; | ||
| 145 | |||
| 146 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingisNeeded() const; | ||
| 147 | |||
| 148 | boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const; | ||
| 149 | |||
| 150 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoHeatingisNeeded() const; | ||
| 151 | |||
| 152 | boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const; | ||
| 153 | |||
| 154 | boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const; | ||
| 155 | |||
| 156 | boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 157 | |||
| 158 | boost::optional<double> autosizedMaximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 159 | |||
| 160 | //@} | ||
| 161 | /** @name Setters */ | ||
| 162 | //@{ | ||
| 163 | |||
| 164 | bool setTerminalUnitAvailabilityschedule(Schedule& schedule); | ||
| 165 | |||
| 166 | bool setSupplyAirFlowRateDuringCoolingOperation(boost::optional<double> supplyAirFlowRateDuringCoolingOperation); | ||
| 167 | |||
| 168 | void autosizeSupplyAirFlowRateDuringCoolingOperation(); | ||
| 169 | |||
| 170 | bool setSupplyAirFlowRateWhenNoCoolingisNeeded(boost::optional<double> supplyAirFlowRateWhenNoCoolingisNeeded); | ||
| 171 | |||
| 172 | void autosizeSupplyAirFlowRateWhenNoCoolingisNeeded(); | ||
| 173 | |||
| 174 | bool setSupplyAirFlowRateDuringHeatingOperation(boost::optional<double> supplyAirFlowRateDuringHeatingOperation); | ||
| 175 | |||
| 176 | void autosizeSupplyAirFlowRateDuringHeatingOperation(); | ||
| 177 | |||
| 178 | bool setSupplyAirFlowRateWhenNoHeatingisNeeded(boost::optional<double> supplyAirFlowRateWhenNoHeatingisNeeded); | ||
| 179 | |||
| 180 | void autosizeSupplyAirFlowRateWhenNoHeatingisNeeded(); | ||
| 181 | |||
| 182 | bool setOutdoorAirFlowRateDuringCoolingOperation(boost::optional<double> outdoorAirFlowRateDuringCoolingOperation); | ||
| 183 | |||
| 184 | void autosizeOutdoorAirFlowRateDuringCoolingOperation(); | ||
| 185 | |||
| 186 | bool setOutdoorAirFlowRateDuringHeatingOperation(boost::optional<double> outdoorAirFlowRateDuringHeatingOperation); | ||
| 187 | |||
| 188 | void autosizeOutdoorAirFlowRateDuringHeatingOperation(); | ||
| 189 | |||
| 190 | bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 191 | |||
| 192 | void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 193 | |||
| 194 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 195 | |||
| 196 | bool setZoneTerminalUnitOnParasiticElectricEnergyUse(double zoneTerminalUnitOnParasiticElectricEnergyUse); | ||
| 197 | |||
| 198 | bool setZoneTerminalUnitOffParasiticElectricEnergyUse(double zoneTerminalUnitOffParasiticElectricEnergyUse); | ||
| 199 | |||
| 200 | bool setRatedTotalHeatingCapacitySizingRatio(double ratedTotalHeatingCapacitySizingRatio); | ||
| 201 | |||
| 202 | bool setSupplyAirFan(const HVACComponent& component); | ||
| 203 | void resetSupplyAirFan(); | ||
| 204 | |||
| 205 | bool setCoolingCoil(const HVACComponent& component); | ||
| 206 | |||
| 207 | bool setHeatingCoil(const HVACComponent& component); | ||
| 208 | |||
| 209 | //@} | ||
| 210 | /** @name Other */ | ||
| 211 | //@{ | ||
| 212 | |||
| 213 | // Returns true if the Cooling and Heating Coils are of the FluidTemperatureControl type | ||
| 214 | bool isFluidTemperatureControl() const; | ||
| 215 | |||
| 216 | boost::optional<HVACComponent> vrfSystem() const; | ||
| 217 | |||
| 218 | //@} | ||
| 219 | protected: | ||
| 220 | private: | ||
| 221 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACTerminalUnitVariableRefrigerantFlow"); | |
| 222 | |||
| 223 | boost::optional<Schedule> optionalTerminalUnitAvailabilityschedule() const; | ||
| 224 | boost::optional<Schedule> optionalSupplyAirFanOperatingModeSchedule() const; | ||
| 225 | |||
| 226 | boost::optional<ModelObject> supplementalHeatingCoilAsModelObject() const; | ||
| 227 | bool setSupplementalHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 228 | }; | ||
| 229 | |||
| 230 | } // namespace detail | ||
| 231 | |||
| 232 | } // namespace model | ||
| 233 | } // namespace openstudio | ||
| 234 | |||
| 235 | #endif // MODEL_ZONEHVACTERMINALUNITVARIABLEREFRIGERANTFLOW_IMPL_HPP | ||
| 236 |