src/model/WaterHeaterHeatPumpWrappedCondenser.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_WATERHEATERHEATPUMPWRAPPEDCONDENSER_HPP | ||
| 7 | #define MODEL_WATERHEATERHEATPUMPWRAPPEDCONDENSER_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 WaterHeaterHeatPumpWrappedCondenser_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** WaterHeaterHeatPumpWrappedCondenser is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:WaterHeater:HeatPump:WrappedCondenser'. */ | ||
| 26 | class MODEL_API WaterHeaterHeatPumpWrappedCondenser : public ZoneHVACComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit WaterHeaterHeatPumpWrappedCondenser(const Model& model); | ||
| 33 | |||
| 34 | explicit WaterHeaterHeatPumpWrappedCondenser(const Model& model, const ModelObject& dxCoil, const HVACComponent& tank, const HVACComponent& fan, | ||
| 35 | Schedule& compressorSetpointTemperatureSchedule, Schedule& inletAirMixerSchedule); | ||
| 36 | |||
| 37 | 41 | virtual ~WaterHeaterHeatPumpWrappedCondenser() override = default; | |
| 38 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 39 | ✗ | WaterHeaterHeatPumpWrappedCondenser(const WaterHeaterHeatPumpWrappedCondenser& other) = default; | |
| 40 | 14 | WaterHeaterHeatPumpWrappedCondenser(WaterHeaterHeatPumpWrappedCondenser&& other) = default; | |
| 41 | ✗ | WaterHeaterHeatPumpWrappedCondenser& operator=(const WaterHeaterHeatPumpWrappedCondenser&) = default; | |
| 42 | ✗ | WaterHeaterHeatPumpWrappedCondenser& operator=(WaterHeaterHeatPumpWrappedCondenser&&) = default; | |
| 43 | |||
| 44 | //@} | ||
| 45 | |||
| 46 | static IddObjectType iddObjectType(); | ||
| 47 | |||
| 48 | static std::vector<std::string> inletAirConfigurationValues(); | ||
| 49 | |||
| 50 | static std::vector<std::string> compressorLocationValues(); | ||
| 51 | |||
| 52 | static std::vector<std::string> fanPlacementValues(); | ||
| 53 | |||
| 54 | static std::vector<std::string> parasiticHeatRejectionLocationValues(); | ||
| 55 | |||
| 56 | static std::vector<std::string> tankElementControlLogicValues(); | ||
| 57 | |||
| 58 | /** @name Getters */ | ||
| 59 | //@{ | ||
| 60 | |||
| 61 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 62 | |||
| 63 | Schedule compressorSetpointTemperatureSchedule() const; | ||
| 64 | |||
| 65 | double deadBandTemperatureDifference() const; | ||
| 66 | |||
| 67 | double condenserBottomLocation() const; | ||
| 68 | |||
| 69 | double condenserTopLocation() const; | ||
| 70 | |||
| 71 | boost::optional<double> evaporatorAirFlowRate() const; | ||
| 72 | |||
| 73 | bool isEvaporatorAirFlowRateAutocalculated() const; | ||
| 74 | |||
| 75 | std::string inletAirConfiguration() const; | ||
| 76 | |||
| 77 | boost::optional<Schedule> inletAirTemperatureSchedule() const; | ||
| 78 | |||
| 79 | boost::optional<Schedule> inletAirHumiditySchedule() const; | ||
| 80 | |||
| 81 | HVACComponent tank() const; | ||
| 82 | |||
| 83 | ModelObject dXCoil() const; | ||
| 84 | |||
| 85 | double minimumInletAirTemperatureforCompressorOperation() const; | ||
| 86 | |||
| 87 | double maximumInletAirTemperatureforCompressorOperation() const; | ||
| 88 | |||
| 89 | std::string compressorLocation() const; | ||
| 90 | |||
| 91 | boost::optional<Schedule> compressorAmbientTemperatureSchedule() const; | ||
| 92 | |||
| 93 | HVACComponent fan() const; | ||
| 94 | |||
| 95 | std::string fanPlacement() const; | ||
| 96 | |||
| 97 | double onCycleParasiticElectricLoad() const; | ||
| 98 | |||
| 99 | double offCycleParasiticElectricLoad() const; | ||
| 100 | |||
| 101 | std::string parasiticHeatRejectionLocation() const; | ||
| 102 | |||
| 103 | boost::optional<Schedule> inletAirMixerSchedule() const; | ||
| 104 | |||
| 105 | std::string tankElementControlLogic() const; | ||
| 106 | |||
| 107 | boost::optional<double> controlSensor1HeightInStratifiedTank() const; | ||
| 108 | |||
| 109 | double controlSensor1Weight() const; | ||
| 110 | |||
| 111 | boost::optional<double> controlSensor2HeightInStratifiedTank() const; | ||
| 112 | |||
| 113 | //@} | ||
| 114 | /** @name Setters */ | ||
| 115 | //@{ | ||
| 116 | |||
| 117 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 118 | |||
| 119 | void resetAvailabilitySchedule(); | ||
| 120 | |||
| 121 | bool setCompressorSetpointTemperatureSchedule(Schedule& schedule); | ||
| 122 | |||
| 123 | bool setDeadBandTemperatureDifference(double deadBandTemperatureDifference); | ||
| 124 | |||
| 125 | bool setCondenserBottomLocation(double condenserBottomLocation); | ||
| 126 | |||
| 127 | bool setCondenserTopLocation(double condenserTopLocation); | ||
| 128 | |||
| 129 | bool setEvaporatorAirFlowRate(double evaporatorAirFlowRate); | ||
| 130 | |||
| 131 | void autocalculateEvaporatorAirFlowRate(); | ||
| 132 | |||
| 133 | bool setInletAirConfiguration(const std::string& inletAirConfiguration); | ||
| 134 | |||
| 135 | bool setInletAirTemperatureSchedule(Schedule& schedule); | ||
| 136 | |||
| 137 | void resetInletAirTemperatureSchedule(); | ||
| 138 | |||
| 139 | bool setInletAirHumiditySchedule(Schedule& schedule); | ||
| 140 | |||
| 141 | void resetInletAirHumiditySchedule(); | ||
| 142 | |||
| 143 | bool setTank(const HVACComponent& waterHeaterStratified); | ||
| 144 | |||
| 145 | bool setDXCoil(const ModelObject& heatPumpWaterHeaterDXCoilsWrapped); | ||
| 146 | |||
| 147 | bool setMinimumInletAirTemperatureforCompressorOperation(double minimumInletAirTemperatureforCompressorOperation); | ||
| 148 | |||
| 149 | bool setMaximumInletAirTemperatureforCompressorOperation(double maximumInletAirTemperatureforCompressorOperation); | ||
| 150 | |||
| 151 | bool setCompressorLocation(const std::string& compressorLocation); | ||
| 152 | |||
| 153 | bool setCompressorAmbientTemperatureSchedule(Schedule& schedule); | ||
| 154 | |||
| 155 | void resetCompressorAmbientTemperatureSchedule(); | ||
| 156 | |||
| 157 | bool setFan(const HVACComponent& fansOnOff); | ||
| 158 | |||
| 159 | bool setFanPlacement(const std::string& fanPlacement); | ||
| 160 | |||
| 161 | bool setOnCycleParasiticElectricLoad(double onCycleParasiticElectricLoad); | ||
| 162 | |||
| 163 | bool setOffCycleParasiticElectricLoad(double offCycleParasiticElectricLoad); | ||
| 164 | |||
| 165 | bool setParasiticHeatRejectionLocation(const std::string& parasiticHeatRejectionLocation); | ||
| 166 | |||
| 167 | bool setInletAirMixerSchedule(Schedule& schedule); | ||
| 168 | |||
| 169 | void resetInletAirMixerSchedule(); | ||
| 170 | |||
| 171 | bool setTankElementControlLogic(const std::string& tankElementControlLogic); | ||
| 172 | |||
| 173 | bool setControlSensor1HeightInStratifiedTank(double controlSensor1HeightInStratifiedTank); | ||
| 174 | |||
| 175 | void resetControlSensor1HeightInStratifiedTank(); | ||
| 176 | |||
| 177 | bool setControlSensor1Weight(double controlSensor1Weight); | ||
| 178 | |||
| 179 | bool setControlSensor2HeightInStratifiedTank(double controlSensor2HeightInStratifiedTank); | ||
| 180 | |||
| 181 | void resetControlSensor2HeightInStratifiedTank(); | ||
| 182 | |||
| 183 | //@} | ||
| 184 | /** @name Other */ | ||
| 185 | //@{ | ||
| 186 | |||
| 187 | /** Convenience methods to return the name of the inlet/outlet nodes | ||
| 188 | * Depending on inletAirConfiguration, what this returns will be different | ||
| 189 | * - "ZoneAirOnly" and "ZoneAndOutdoorAir" need to get nodes from the thermal zone | ||
| 190 | * - "OutdoorAirOnly" and "Schedule", it just constructs a node name. | ||
| 191 | * This is helpful if you need to control this via EMS */ | ||
| 192 | std::string airInletNodeName() const; | ||
| 193 | std::string airOutletNodeName() const; | ||
| 194 | |||
| 195 | //@} | ||
| 196 | protected: | ||
| 197 | /// @cond | ||
| 198 | using ImplType = detail::WaterHeaterHeatPumpWrappedCondenser_Impl; | ||
| 199 | |||
| 200 | explicit WaterHeaterHeatPumpWrappedCondenser(std::shared_ptr<detail::WaterHeaterHeatPumpWrappedCondenser_Impl> impl); | ||
| 201 | |||
| 202 | friend class detail::WaterHeaterHeatPumpWrappedCondenser_Impl; | ||
| 203 | friend class Model; | ||
| 204 | friend class IdfObject; | ||
| 205 | friend class openstudio::detail::IdfObject_Impl; | ||
| 206 | /// @endcond | ||
| 207 | private: | ||
| 208 | REGISTER_LOGGER("openstudio.model.WaterHeaterHeatPumpWrappedCondenser"); | ||
| 209 | }; | ||
| 210 | |||
| 211 | /** \relates WaterHeaterHeatPumpWrappedCondenser*/ | ||
| 212 | using OptionalWaterHeaterHeatPumpWrappedCondenser = boost::optional<WaterHeaterHeatPumpWrappedCondenser>; | ||
| 213 | |||
| 214 | /** \relates WaterHeaterHeatPumpWrappedCondenser*/ | ||
| 215 | using WaterHeaterHeatPumpWrappedCondenserVector = std::vector<WaterHeaterHeatPumpWrappedCondenser>; | ||
| 216 | |||
| 217 | } // namespace model | ||
| 218 | } // namespace openstudio | ||
| 219 | |||
| 220 | #endif // MODEL_WATERHEATERHEATPUMPWRAPPEDCONDENSER_HPP | ||
| 221 |