src/model/PumpVariableSpeed_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_PUMPVARIABLESPEED_IMPL_HPP | ||
| 7 | #define MODEL_PUMPVARIABLESPEED_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 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | /** PumpVariableSpeed_Impl is a StraightComponent_Impl that is the implementation class for | ||
| 21 | * PumpVariableSpeed.*/ | ||
| 22 | class MODEL_API PumpVariableSpeed_Impl : public StraightComponent_Impl | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | PumpVariableSpeed_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | PumpVariableSpeed_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | PumpVariableSpeed_Impl(const PumpVariableSpeed_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | 22 | virtual ~PumpVariableSpeed_Impl() override = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | /** @name Virtual Methods */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 41 | |||
| 42 | virtual IddObjectType iddObjectType() const override; | ||
| 43 | |||
| 44 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 45 | |||
| 46 | virtual std::vector<ModelObject> children() const override; | ||
| 47 | |||
| 48 | virtual unsigned inletPort() const override; | ||
| 49 | |||
| 50 | virtual unsigned outletPort() const override; | ||
| 51 | |||
| 52 | virtual bool addToNode(Node& node) override; | ||
| 53 | |||
| 54 | virtual void autosize() override; | ||
| 55 | |||
| 56 | virtual void applySizingValues() override; | ||
| 57 | |||
| 58 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 59 | |||
| 60 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 61 | |||
| 62 | virtual ComponentType componentType() const override; | ||
| 63 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 64 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 65 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 66 | |||
| 67 | //@} | ||
| 68 | /** @name Getters */ | ||
| 69 | //@{ | ||
| 70 | |||
| 71 | boost::optional<double> ratedFlowRate() const; | ||
| 72 | |||
| 73 | bool isRatedFlowRateDefaulted() const; | ||
| 74 | |||
| 75 | bool isRatedFlowRateAutosized() const; | ||
| 76 | |||
| 77 | double ratedPumpHead() const; | ||
| 78 | |||
| 79 | bool isRatedPumpHeadDefaulted() const; | ||
| 80 | |||
| 81 | boost::optional<double> ratedPowerConsumption() const; | ||
| 82 | |||
| 83 | bool isRatedPowerConsumptionDefaulted() const; | ||
| 84 | |||
| 85 | bool isRatedPowerConsumptionAutosized() const; | ||
| 86 | |||
| 87 | double motorEfficiency() const; | ||
| 88 | |||
| 89 | bool isMotorEfficiencyDefaulted() const; | ||
| 90 | |||
| 91 | double fractionofMotorInefficienciestoFluidStream() const; | ||
| 92 | |||
| 93 | bool isFractionofMotorInefficienciestoFluidStreamDefaulted() const; | ||
| 94 | |||
| 95 | double coefficient1ofthePartLoadPerformanceCurve() const; | ||
| 96 | |||
| 97 | bool isCoefficient1ofthePartLoadPerformanceCurveDefaulted() const; | ||
| 98 | |||
| 99 | double coefficient2ofthePartLoadPerformanceCurve() const; | ||
| 100 | |||
| 101 | bool isCoefficient2ofthePartLoadPerformanceCurveDefaulted() const; | ||
| 102 | |||
| 103 | double coefficient3ofthePartLoadPerformanceCurve() const; | ||
| 104 | |||
| 105 | bool isCoefficient3ofthePartLoadPerformanceCurveDefaulted() const; | ||
| 106 | |||
| 107 | double coefficient4ofthePartLoadPerformanceCurve() const; | ||
| 108 | |||
| 109 | bool isCoefficient4ofthePartLoadPerformanceCurveDefaulted() const; | ||
| 110 | |||
| 111 | double minimumFlowRate() const; | ||
| 112 | |||
| 113 | bool isMinimumFlowRateDefaulted() const; | ||
| 114 | |||
| 115 | std::string pumpControlType() const; | ||
| 116 | |||
| 117 | bool isPumpControlTypeDefaulted() const; | ||
| 118 | |||
| 119 | boost::optional<Schedule> pumpFlowRateSchedule() const; | ||
| 120 | |||
| 121 | boost::optional<Curve> pumpCurve() const; | ||
| 122 | |||
| 123 | boost::optional<double> impellerDiameter() const; | ||
| 124 | |||
| 125 | boost::optional<std::string> vFDControlType() const; | ||
| 126 | |||
| 127 | boost::optional<Schedule> pumpRPMSchedule() const; | ||
| 128 | |||
| 129 | boost::optional<Schedule> minimumPressureSchedule() const; | ||
| 130 | |||
| 131 | boost::optional<Schedule> maximumPressureSchedule() const; | ||
| 132 | |||
| 133 | boost::optional<Schedule> minimumRPMSchedule() const; | ||
| 134 | |||
| 135 | boost::optional<Schedule> maximumRPMSchedule() const; | ||
| 136 | |||
| 137 | boost::optional<double> autosizedRatedFlowRate() const; | ||
| 138 | |||
| 139 | boost::optional<double> autosizedRatedPowerConsumption() const; | ||
| 140 | |||
| 141 | std::string endUseSubcategory() const; | ||
| 142 | |||
| 143 | //@} | ||
| 144 | /** @name Setters */ | ||
| 145 | //@{ | ||
| 146 | |||
| 147 | bool setRatedFlowRate(boost::optional<double> ratedFlowRate); | ||
| 148 | |||
| 149 | void resetRatedFlowRate(); | ||
| 150 | |||
| 151 | void autosizeRatedFlowRate(); | ||
| 152 | |||
| 153 | bool setRatedPumpHead(double ratedPumpHead); | ||
| 154 | |||
| 155 | void resetRatedPumpHead(); | ||
| 156 | |||
| 157 | bool setRatedPowerConsumption(boost::optional<double> ratedPowerConsumption); | ||
| 158 | |||
| 159 | void resetRatedPowerConsumption(); | ||
| 160 | |||
| 161 | void autosizeRatedPowerConsumption(); | ||
| 162 | |||
| 163 | bool setMotorEfficiency(double motorEfficiency); | ||
| 164 | |||
| 165 | void resetMotorEfficiency(); | ||
| 166 | |||
| 167 | bool setFractionofMotorInefficienciestoFluidStream(double fractionofMotorInefficienciestoFluidStream); | ||
| 168 | |||
| 169 | void resetFractionofMotorInefficienciestoFluidStream(); | ||
| 170 | |||
| 171 | bool setCoefficient1ofthePartLoadPerformanceCurve(double coefficient1ofthePartLoadPerformanceCurve); | ||
| 172 | |||
| 173 | void resetCoefficient1ofthePartLoadPerformanceCurve(); | ||
| 174 | |||
| 175 | bool setCoefficient2ofthePartLoadPerformanceCurve(double coefficient2ofthePartLoadPerformanceCurve); | ||
| 176 | |||
| 177 | void resetCoefficient2ofthePartLoadPerformanceCurve(); | ||
| 178 | |||
| 179 | bool setCoefficient3ofthePartLoadPerformanceCurve(double coefficient3ofthePartLoadPerformanceCurve); | ||
| 180 | |||
| 181 | void resetCoefficient3ofthePartLoadPerformanceCurve(); | ||
| 182 | |||
| 183 | bool setCoefficient4ofthePartLoadPerformanceCurve(double coefficient4ofthePartLoadPerformanceCurve); | ||
| 184 | |||
| 185 | void resetCoefficient4ofthePartLoadPerformanceCurve(); | ||
| 186 | |||
| 187 | bool setMinimumFlowRate(double minimumFlowRate); | ||
| 188 | |||
| 189 | void resetMinimumFlowRate(); | ||
| 190 | |||
| 191 | bool setPumpControlType(const std::string& pumpControlType); | ||
| 192 | |||
| 193 | void resetPumpControlType(); | ||
| 194 | |||
| 195 | bool setPumpFlowRateSchedule(Schedule& schedule); | ||
| 196 | |||
| 197 | void resetPumpFlowRateSchedule(); | ||
| 198 | |||
| 199 | bool setPumpCurve(const Curve& curve); | ||
| 200 | |||
| 201 | void resetPumpCurve(); | ||
| 202 | |||
| 203 | bool setImpellerDiameter(boost::optional<double> impellerDiameter); | ||
| 204 | |||
| 205 | void resetImpellerDiameter(); | ||
| 206 | |||
| 207 | bool setVFDControlType(boost::optional<std::string> vFDControlType); | ||
| 208 | |||
| 209 | void resetVFDControlType(); | ||
| 210 | |||
| 211 | bool setPumpRPMSchedule(Schedule& schedule); | ||
| 212 | |||
| 213 | void resetPumpRPMSchedule(); | ||
| 214 | |||
| 215 | bool setMinimumPressureSchedule(Schedule& schedule); | ||
| 216 | |||
| 217 | void resetMinimumPressureSchedule(); | ||
| 218 | |||
| 219 | bool setMaximumPressureSchedule(Schedule& schedule); | ||
| 220 | |||
| 221 | void resetMaximumPressureSchedule(); | ||
| 222 | |||
| 223 | bool setMinimumRPMSchedule(Schedule& schedule); | ||
| 224 | |||
| 225 | void resetMinimumRPMSchedule(); | ||
| 226 | |||
| 227 | bool setMaximumRPMSchedule(Schedule& schedule); | ||
| 228 | |||
| 229 | void resetMaximumRPMSchedule(); | ||
| 230 | |||
| 231 | std::string designPowerSizingMethod() const; | ||
| 232 | |||
| 233 | bool setDesignPowerSizingMethod(const std::string& designPowerSizingMethod); | ||
| 234 | |||
| 235 | double designElectricPowerPerUnitFlowRate() const; | ||
| 236 | |||
| 237 | bool setDesignElectricPowerPerUnitFlowRate(double designElectricPowerPerUnitFlowRate); | ||
| 238 | |||
| 239 | double designShaftPowerPerUnitFlowRatePerUnitHead() const; | ||
| 240 | |||
| 241 | bool setDesignShaftPowerPerUnitFlowRatePerUnitHead(double designShaftPowerPerUnitFlowRatePerUnitHead); | ||
| 242 | |||
| 243 | boost::optional<ThermalZone> zone() const; | ||
| 244 | |||
| 245 | bool setZone(const ThermalZone& thermalZone); | ||
| 246 | |||
| 247 | void resetZone(); | ||
| 248 | |||
| 249 | double skinLossRadiativeFraction() const; | ||
| 250 | |||
| 251 | bool setSkinLossRadiativeFraction(double skinLossRadiativeFraction); | ||
| 252 | |||
| 253 | double designMinimumFlowRateFraction() const; | ||
| 254 | |||
| 255 | bool setDesignMinimumFlowRateFraction(double designMinimumFlowRateFraction); | ||
| 256 | |||
| 257 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 258 | |||
| 259 | //@} | ||
| 260 | private: | ||
| 261 | REGISTER_LOGGER("openstudio.model.PumpVariableSpeed"); | ||
| 262 | |||
| 263 | std::vector<std::string> pumpControlTypeValues() const; | ||
| 264 | std::vector<std::string> vfdControlTypeValues() const; | ||
| 265 | |||
| 266 | boost::optional<ModelObject> pumpFlowRateScheduleAsModelObject() const; | ||
| 267 | boost::optional<ModelObject> pumpCurveAsModelObject() const; | ||
| 268 | boost::optional<ModelObject> pumpRPMScheduleAsModelObject() const; | ||
| 269 | boost::optional<ModelObject> minimumPressureScheduleAsModelObject() const; | ||
| 270 | boost::optional<ModelObject> maximumPressureScheduleAsModelObject() const; | ||
| 271 | boost::optional<ModelObject> minimumRPMScheduleAsModelObject() const; | ||
| 272 | boost::optional<ModelObject> maximumRPMScheduleAsModelObject() const; | ||
| 273 | |||
| 274 | bool setPumpFlowRateScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 275 | bool setPumpCurveAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 276 | bool setPumpRPMScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 277 | bool setMinimumPressureScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 278 | bool setMaximumPressureScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 279 | bool setMinimumRPMScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 280 | bool setMaximumRPMScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 281 | }; | ||
| 282 | |||
| 283 | } // namespace detail | ||
| 284 | |||
| 285 | } // namespace model | ||
| 286 | } // namespace openstudio | ||
| 287 | |||
| 288 | #endif // MODEL_PUMPVARIABLESPEED_IMPL_HPP | ||
| 289 |