src/model/HeatPumpAirToWater_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_HEATPUMPAIRTOWATER_IMPL_HPP | ||
| 7 | #define MODEL_HEATPUMPAIRTOWATER_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | class Curve; | ||
| 17 | class HeatPumpAirToWaterHeating; | ||
| 18 | class HeatPumpAirToWaterCooling; | ||
| 19 | class PlantLoop; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** HeatPumpAirToWater_Impl is a StraightComponent_Impl that is the implementation class for HeatPumpAirToWater.*/ | ||
| 24 | class MODEL_API HeatPumpAirToWater_Impl : public StraightComponent_Impl | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | HeatPumpAirToWater_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | HeatPumpAirToWater_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | HeatPumpAirToWater_Impl(const HeatPumpAirToWater_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | 19 | virtual ~HeatPumpAirToWater_Impl() = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | /** @name Virtual Methods */ | ||
| 40 | //@{ | ||
| 41 | |||
| 42 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 43 | |||
| 44 | virtual IddObjectType iddObjectType() const override; | ||
| 45 | |||
| 46 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 47 | |||
| 48 | // base is StraightComponent | ||
| 49 | virtual ModelObject clone(Model model) const override; | ||
| 50 | |||
| 51 | virtual std::vector<ModelObject> children() const override; | ||
| 52 | // virtual std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 53 | |||
| 54 | virtual std::vector<IdfObject> remove() override; | ||
| 55 | |||
| 56 | // Overrides from StraightComponent | ||
| 57 | virtual unsigned inletPort() const override; | ||
| 58 | virtual unsigned outletPort() const override; | ||
| 59 | |||
| 60 | virtual bool addToNode(Node& node) override; | ||
| 61 | |||
| 62 | virtual void autosize() override; | ||
| 63 | |||
| 64 | virtual void applySizingValues() override; | ||
| 65 | |||
| 66 | virtual ComponentType componentType() const override; | ||
| 67 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 68 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 69 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 70 | |||
| 71 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 72 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 73 | |||
| 74 | //@} | ||
| 75 | /** @name Getters */ | ||
| 76 | //@{ | ||
| 77 | |||
| 78 | std::string operatingModeControlMethod() const; | ||
| 79 | |||
| 80 | std::string operatingModeControlOptionforMultipleUnit() const; | ||
| 81 | |||
| 82 | boost::optional<Schedule> operatingModeControlSchedule() const; | ||
| 83 | |||
| 84 | double minimumPartLoadRatio() const; | ||
| 85 | |||
| 86 | boost::optional<std::string> airInletNodeName() const; | ||
| 87 | |||
| 88 | boost::optional<std::string> airOutletNodeName() const; | ||
| 89 | |||
| 90 | double maximumOutdoorDryBulbTemperatureForDefrostOperation() const; | ||
| 91 | |||
| 92 | std::string heatPumpDefrostControl() const; | ||
| 93 | |||
| 94 | double heatPumpDefrostTimePeriodFraction() const; | ||
| 95 | |||
| 96 | double resistiveDefrostHeaterCapacity() const; | ||
| 97 | |||
| 98 | boost::optional<Curve> defrostEnergyInputRatioFunctionofTemperatureCurve() const; | ||
| 99 | |||
| 100 | int heatPumpMultiplier() const; | ||
| 101 | |||
| 102 | std::string controlType() const; | ||
| 103 | |||
| 104 | double crankcaseHeaterCapacity() const; | ||
| 105 | |||
| 106 | boost::optional<Curve> crankcaseHeaterCapacityFunctionofTemperatureCurve() const; | ||
| 107 | |||
| 108 | double maximumAmbientTemperatureforCrankcaseHeaterOperation() const; | ||
| 109 | |||
| 110 | boost::optional<HeatPumpAirToWaterHeating> heatingOperationMode() const; | ||
| 111 | |||
| 112 | boost::optional<HeatPumpAirToWaterCooling> coolingOperationMode() const; | ||
| 113 | |||
| 114 | //@} | ||
| 115 | /** @name Setters */ | ||
| 116 | //@{ | ||
| 117 | |||
| 118 | bool setOperatingModeControlMethod(const std::string& operatingModeControlMethod); | ||
| 119 | |||
| 120 | bool setOperatingModeControlOptionforMultipleUnit(const std::string& operatingModeControlOptionforMultipleUnit); | ||
| 121 | |||
| 122 | bool setOperatingModeControlSchedule(Schedule& operatingModeControlSchedule); | ||
| 123 | |||
| 124 | void resetOperatingModeControlSchedule(); | ||
| 125 | |||
| 126 | bool setMinimumPartLoadRatio(double minimumPartLoadRatio); | ||
| 127 | |||
| 128 | bool setAirInletNodeName(const std::string& airInletNodeName); | ||
| 129 | |||
| 130 | void resetAirInletNodeName(); | ||
| 131 | |||
| 132 | bool setAirOutletNodeName(const std::string& airOutletNodeName); | ||
| 133 | |||
| 134 | void resetAirOutletNodeName(); | ||
| 135 | |||
| 136 | bool setMaximumOutdoorDryBulbTemperatureForDefrostOperation(double maximumOutdoorDryBulbTemperatureForDefrostOperation); | ||
| 137 | |||
| 138 | bool setHeatPumpDefrostControl(const std::string& heatPumpDefrostControl); | ||
| 139 | |||
| 140 | bool setHeatPumpDefrostTimePeriodFraction(double heatPumpDefrostTimePeriodFraction); | ||
| 141 | |||
| 142 | bool setResistiveDefrostHeaterCapacity(double resistiveDefrostHeaterCapacity); | ||
| 143 | |||
| 144 | bool setDefrostEnergyInputRatioFunctionofTemperatureCurve(const Curve& defrostEnergyInputRatioFunctionofTemperatureCurve); | ||
| 145 | |||
| 146 | void resetDefrostEnergyInputRatioFunctionofTemperatureCurve(); | ||
| 147 | |||
| 148 | bool setHeatPumpMultiplier(int heatPumpMultiplier); | ||
| 149 | |||
| 150 | bool setControlType(const std::string& controlType); | ||
| 151 | |||
| 152 | bool setCrankcaseHeaterCapacity(double crankcaseHeaterCapacity); | ||
| 153 | |||
| 154 | bool setCrankcaseHeaterCapacityFunctionofTemperatureCurve(const Curve& crankcaseHeaterCapacityFunctionofTemperatureCurve); | ||
| 155 | |||
| 156 | void resetCrankcaseHeaterCapacityFunctionofTemperatureCurve(); | ||
| 157 | |||
| 158 | bool setMaximumAmbientTemperatureforCrankcaseHeaterOperation(double maximumAmbientTemperatureforCrankcaseHeaterOperation); | ||
| 159 | |||
| 160 | bool setHeatingOperationMode(const HeatPumpAirToWaterHeating& heatingOperationMode); | ||
| 161 | |||
| 162 | void resetHeatingOperationMode(); | ||
| 163 | |||
| 164 | bool setCoolingOperationMode(const HeatPumpAirToWaterCooling& coolingOperationMode); | ||
| 165 | |||
| 166 | void resetCoolingOperationMode(); | ||
| 167 | |||
| 168 | //@} | ||
| 169 | /** @name Other */ | ||
| 170 | //@{ | ||
| 171 | |||
| 172 | boost::optional<PlantLoop> coolingLoop() const; | ||
| 173 | boost::optional<PlantLoop> heatingLoop() const; | ||
| 174 | |||
| 175 | // Autosize methods | ||
| 176 | boost::optional<double> autosizedRatedAirFlowRateinHeatingMode() const; | ||
| 177 | boost::optional<double> autosizedRatedWaterFlowRateinHeatingMode() const; | ||
| 178 | boost::optional<double> autosizedRatedAirFlowRateinCoolingMode() const; | ||
| 179 | boost::optional<double> autosizedRatedWaterFlowRateinCoolingMode() const; | ||
| 180 | boost::optional<double> autosizedRatedHeatingCapacity() const; | ||
| 181 | boost::optional<double> autosizedRatedCoolingCapacity() const; | ||
| 182 | |||
| 183 | //@} | ||
| 184 | protected: | ||
| 185 | private: | ||
| 186 | − | REGISTER_LOGGER("openstudio.model.HeatPumpAirToWater"); | |
| 187 | }; | ||
| 188 | |||
| 189 | } // namespace detail | ||
| 190 | |||
| 191 | } // namespace model | ||
| 192 | } // namespace openstudio | ||
| 193 | |||
| 194 | #endif // MODEL_HEATPUMPAIRTOWATER_IMPL_HPP | ||
| 195 |