src/model/HeatPumpAirToWaterFuelFiredHeating.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_HEATPUMPAIRTOWATERFUELFIREDHEATING_HPP | ||
| 7 | #define MODEL_HEATPUMPAIRTOWATERFUELFIREDHEATING_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class HeatPumpAirToWaterFuelFiredCooling; | ||
| 17 | class Curve; | ||
| 18 | // class OutdoorAirNode; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class HeatPumpAirToWaterFuelFiredHeating_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** HeatPumpAirToWaterFuelFiredHeating is a StraightComponent that wraps the OpenStudio IDD object 'OS:HeatPump:AirToWater:FuelFired:Heating'. */ | ||
| 27 | class MODEL_API HeatPumpAirToWaterFuelFiredHeating : public StraightComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit HeatPumpAirToWaterFuelFiredHeating(const Model& model); | ||
| 34 | |||
| 35 | explicit HeatPumpAirToWaterFuelFiredHeating(const Model& model, const Curve& normalizedCapacityFunctionofTemperatureCurve, | ||
| 36 | const Curve& fuelEnergyInputRatioFunctionofTemperatureCurve, | ||
| 37 | const Curve& fuelEnergyInputRatioFunctionofPLRCurve); | ||
| 38 | |||
| 39 | 25 | virtual ~HeatPumpAirToWaterFuelFiredHeating() override = default; | |
| 40 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 41 | ✗ | HeatPumpAirToWaterFuelFiredHeating(const HeatPumpAirToWaterFuelFiredHeating& other) = default; | |
| 42 | 7 | HeatPumpAirToWaterFuelFiredHeating(HeatPumpAirToWaterFuelFiredHeating&& other) = default; | |
| 43 | ✗ | HeatPumpAirToWaterFuelFiredHeating& operator=(const HeatPumpAirToWaterFuelFiredHeating&) = default; | |
| 44 | ✗ | HeatPumpAirToWaterFuelFiredHeating& operator=(HeatPumpAirToWaterFuelFiredHeating&&) = default; | |
| 45 | |||
| 46 | //@} | ||
| 47 | |||
| 48 | static IddObjectType iddObjectType(); | ||
| 49 | |||
| 50 | static std::vector<std::string> fuelTypeValues(); | ||
| 51 | |||
| 52 | static std::vector<std::string> flowModeValues(); | ||
| 53 | |||
| 54 | static std::vector<std::string> outdoorAirTemperatureCurveInputVariableValues(); | ||
| 55 | |||
| 56 | static std::vector<std::string> waterTemperatureCurveInputVariableValues(); | ||
| 57 | |||
| 58 | static std::vector<std::string> defrostControlTypeValues(); | ||
| 59 | |||
| 60 | /** @name Getters */ | ||
| 61 | //@{ | ||
| 62 | |||
| 63 | // boost::optional<OutdoorAirNode> airSourceNode() const; | ||
| 64 | |||
| 65 | boost::optional<HeatPumpAirToWaterFuelFiredCooling> companionCoolingHeatPump() const; | ||
| 66 | |||
| 67 | std::string fuelType() const; | ||
| 68 | |||
| 69 | std::string endUseSubcategory() const; | ||
| 70 | |||
| 71 | bool isEndUseSubcategoryDefaulted() const; | ||
| 72 | |||
| 73 | boost::optional<double> nominalHeatingCapacity() const; | ||
| 74 | |||
| 75 | bool isNominalHeatingCapacityAutosized() const; | ||
| 76 | |||
| 77 | boost::optional<double> autosizedNominalHeatingCapacity(); | ||
| 78 | |||
| 79 | double nominalCOP() const; | ||
| 80 | |||
| 81 | boost::optional<double> designFlowRate() const; | ||
| 82 | |||
| 83 | bool isDesignFlowRateAutosized() const; | ||
| 84 | |||
| 85 | boost::optional<double> autosizedDesignFlowRate(); | ||
| 86 | |||
| 87 | double designSupplyTemperature() const; | ||
| 88 | |||
| 89 | boost::optional<double> designTemperatureLift() const; | ||
| 90 | |||
| 91 | bool isDesignTemperatureLiftAutosized() const; | ||
| 92 | |||
| 93 | boost::optional<double> autosizedDesignTemperatureLift(); | ||
| 94 | |||
| 95 | double sizingFactor() const; | ||
| 96 | |||
| 97 | std::string flowMode() const; | ||
| 98 | |||
| 99 | std::string outdoorAirTemperatureCurveInputVariable() const; | ||
| 100 | |||
| 101 | std::string waterTemperatureCurveInputVariable() const; | ||
| 102 | |||
| 103 | Curve normalizedCapacityFunctionofTemperatureCurve() const; | ||
| 104 | |||
| 105 | Curve fuelEnergyInputRatioFunctionofTemperatureCurve() const; | ||
| 106 | |||
| 107 | Curve fuelEnergyInputRatioFunctionofPLRCurve() const; | ||
| 108 | |||
| 109 | double minimumPartLoadRatio() const; | ||
| 110 | |||
| 111 | double maximumPartLoadRatio() const; | ||
| 112 | |||
| 113 | std::string defrostControlType() const; | ||
| 114 | |||
| 115 | double defrostOperationTimeFraction() const; | ||
| 116 | |||
| 117 | boost::optional<Curve> fuelEnergyInputRatioDefrostAdjustmentCurve() const; | ||
| 118 | |||
| 119 | double resistiveDefrostHeaterCapacity() const; | ||
| 120 | |||
| 121 | double maximumOutdoorDrybulbTemperatureforDefrostOperation() const; | ||
| 122 | |||
| 123 | boost::optional<Curve> cyclingRatioFactorCurve() const; | ||
| 124 | |||
| 125 | double nominalAuxiliaryElectricPower() const; | ||
| 126 | |||
| 127 | boost::optional<Curve> auxiliaryElectricEnergyInputRatioFunctionofTemperatureCurve() const; | ||
| 128 | |||
| 129 | boost::optional<Curve> auxiliaryElectricEnergyInputRatioFunctionofPLRCurve() const; | ||
| 130 | |||
| 131 | double standbyElectricPower() const; | ||
| 132 | |||
| 133 | double minimumUnloadingRatio() const; | ||
| 134 | |||
| 135 | //@} | ||
| 136 | /** @name Setters */ | ||
| 137 | //@{ | ||
| 138 | |||
| 139 | // bool setAirSourceNode(const OutdoorAirNode& outdoorAirNode); | ||
| 140 | |||
| 141 | // void resetAirSourceNode(); | ||
| 142 | |||
| 143 | bool setCompanionCoolingHeatPump(const HeatPumpAirToWaterFuelFiredCooling& heatPumpAirToWaterFuelFiredCooling); | ||
| 144 | |||
| 145 | void resetCompanionCoolingHeatPump(); | ||
| 146 | |||
| 147 | bool setFuelType(const std::string& fuelType); | ||
| 148 | |||
| 149 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 150 | |||
| 151 | void resetEndUseSubcategory(); | ||
| 152 | |||
| 153 | bool setNominalHeatingCapacity(double nominalHeatingCapacity); | ||
| 154 | |||
| 155 | void resetNominalHeatingCapacity(); | ||
| 156 | |||
| 157 | void autosizeNominalHeatingCapacity(); | ||
| 158 | |||
| 159 | bool setNominalCOP(double nominalCOP); | ||
| 160 | |||
| 161 | bool setDesignFlowRate(double designFlowRate); | ||
| 162 | |||
| 163 | void resetDesignFlowRate(); | ||
| 164 | |||
| 165 | void autosizeDesignFlowRate(); | ||
| 166 | |||
| 167 | bool setDesignSupplyTemperature(double designSupplyTemperature); | ||
| 168 | |||
| 169 | bool setDesignTemperatureLift(double designTemperatureLift); | ||
| 170 | |||
| 171 | void autosizeDesignTemperatureLift(); | ||
| 172 | |||
| 173 | bool setSizingFactor(double sizingFactor); | ||
| 174 | |||
| 175 | bool setFlowMode(const std::string& flowMode); | ||
| 176 | |||
| 177 | bool setOutdoorAirTemperatureCurveInputVariable(const std::string& outdoorAirTemperatureCurveInputVariable); | ||
| 178 | |||
| 179 | bool setWaterTemperatureCurveInputVariable(const std::string& waterTemperatureCurveInputVariable); | ||
| 180 | |||
| 181 | bool setNormalizedCapacityFunctionofTemperatureCurve(const Curve& normalizedCapacityFunctionofTemperatureCurve); | ||
| 182 | |||
| 183 | bool setFuelEnergyInputRatioFunctionofTemperatureCurve(const Curve& fuelEnergyInputRatioFunctionofTemperatureCurve); | ||
| 184 | |||
| 185 | bool setFuelEnergyInputRatioFunctionofPLRCurve(const Curve& fuelEnergyInputRatioFunctionofPLRCurve); | ||
| 186 | |||
| 187 | bool setMinimumPartLoadRatio(double minimumPartLoadRatio); | ||
| 188 | |||
| 189 | bool setMaximumPartLoadRatio(double maximumPartLoadRatio); | ||
| 190 | |||
| 191 | bool setDefrostControlType(const std::string& defrostControlType); | ||
| 192 | |||
| 193 | bool setDefrostOperationTimeFraction(double defrostOperationTimeFraction); | ||
| 194 | |||
| 195 | bool setFuelEnergyInputRatioDefrostAdjustmentCurve(const Curve& fuelEnergyInputRatioDefrostAdjustmentCurve); | ||
| 196 | |||
| 197 | void resetFuelEnergyInputRatioDefrostAdjustmentCurve(); | ||
| 198 | |||
| 199 | bool setResistiveDefrostHeaterCapacity(double resistiveDefrostHeaterCapacity); | ||
| 200 | |||
| 201 | bool setMaximumOutdoorDrybulbTemperatureforDefrostOperation(double maximumOutdoorDrybulbTemperatureforDefrostOperation); | ||
| 202 | |||
| 203 | bool setCyclingRatioFactorCurve(const Curve& cyclingRatioFactorCurve); | ||
| 204 | |||
| 205 | void resetCyclingRatioFactorCurve(); | ||
| 206 | |||
| 207 | bool setNominalAuxiliaryElectricPower(double nominalAuxiliaryElectricPower); | ||
| 208 | |||
| 209 | bool setAuxiliaryElectricEnergyInputRatioFunctionofTemperatureCurve(const Curve& auxiliaryElectricEnergyInputRatioFunctionofTemperatureCurve); | ||
| 210 | |||
| 211 | void resetAuxiliaryElectricEnergyInputRatioFunctionofTemperatureCurve(); | ||
| 212 | |||
| 213 | bool setAuxiliaryElectricEnergyInputRatioFunctionofPLRCurve(const Curve& auxiliaryElectricEnergyInputRatioFunctionofPLRCurve); | ||
| 214 | |||
| 215 | void resetAuxiliaryElectricEnergyInputRatioFunctionofPLRCurve(); | ||
| 216 | |||
| 217 | bool setStandbyElectricPower(double standbyElectricPower); | ||
| 218 | |||
| 219 | bool setMinimumUnloadingRatio(double minimumUnloadingRatio); | ||
| 220 | |||
| 221 | //@} | ||
| 222 | /** @name Other */ | ||
| 223 | //@{ | ||
| 224 | |||
| 225 | //@} | ||
| 226 | protected: | ||
| 227 | /// @cond | ||
| 228 | using ImplType = detail::HeatPumpAirToWaterFuelFiredHeating_Impl; | ||
| 229 | |||
| 230 | explicit HeatPumpAirToWaterFuelFiredHeating(std::shared_ptr<detail::HeatPumpAirToWaterFuelFiredHeating_Impl> impl); | ||
| 231 | |||
| 232 | friend class detail::HeatPumpAirToWaterFuelFiredHeating_Impl; | ||
| 233 | friend class Model; | ||
| 234 | friend class IdfObject; | ||
| 235 | friend class openstudio::detail::IdfObject_Impl; | ||
| 236 | /// @endcond | ||
| 237 | private: | ||
| 238 | − | REGISTER_LOGGER("openstudio.model.HeatPumpAirToWaterFuelFiredHeating"); | |
| 239 | }; | ||
| 240 | |||
| 241 | /** \relates HeatPumpAirToWaterFuelFiredHeating*/ | ||
| 242 | using OptionalHeatPumpAirToWaterFuelFiredHeating = boost::optional<HeatPumpAirToWaterFuelFiredHeating>; | ||
| 243 | |||
| 244 | /** \relates HeatPumpAirToWaterFuelFiredHeating*/ | ||
| 245 | using HeatPumpAirToWaterFuelFiredHeatingVector = std::vector<HeatPumpAirToWaterFuelFiredHeating>; | ||
| 246 | |||
| 247 | } // namespace model | ||
| 248 | } // namespace openstudio | ||
| 249 | |||
| 250 | #endif // MODEL_HEATPUMPAIRTOWATERFUELFIREDHEATING_HPP | ||
| 251 |