src/model/FanComponentModel_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_FANCOMPONENTMODEL_IMPL_HPP | ||
| 7 | #define MODEL_FANCOMPONENTMODEL_IMPL_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "StraightComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Curve; | ||
| 16 | class Schedule; | ||
| 17 | class AirflowNetworkFan; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | /** FanComponentModel_Impl is a StraightComponent_Impl that is the implementation class for FanComponentModel.*/ | ||
| 22 | class MODEL_API FanComponentModel_Impl : public StraightComponent_Impl | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | FanComponentModel_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | FanComponentModel_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | FanComponentModel_Impl(const FanComponentModel_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | 17 | virtual ~FanComponentModel_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 unsigned inletPort() const override; | ||
| 47 | |||
| 48 | virtual unsigned outletPort() const override; | ||
| 49 | |||
| 50 | virtual bool addToNode(Node& node) override; | ||
| 51 | |||
| 52 | virtual ComponentType componentType() const override; | ||
| 53 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 54 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 55 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 56 | |||
| 57 | //@} | ||
| 58 | /** @name Getters */ | ||
| 59 | //@{ | ||
| 60 | |||
| 61 | Schedule availabilitySchedule() const; | ||
| 62 | |||
| 63 | boost::optional<double> maximumFlowRate() const; | ||
| 64 | |||
| 65 | bool isMaximumFlowRateAutosized() const; | ||
| 66 | |||
| 67 | boost::optional<double> minimumFlowRate() const; | ||
| 68 | |||
| 69 | bool isMinimumFlowRateAutosized() const; | ||
| 70 | |||
| 71 | double fanSizingFactor() const; | ||
| 72 | |||
| 73 | double fanWheelDiameter() const; | ||
| 74 | |||
| 75 | double fanOutletArea() const; | ||
| 76 | |||
| 77 | double maximumFanStaticEfficiency() const; | ||
| 78 | |||
| 79 | double eulerNumberatMaximumFanStaticEfficiency() const; | ||
| 80 | |||
| 81 | double maximumDimensionlessFanAirflow() const; | ||
| 82 | |||
| 83 | boost::optional<double> motorFanPulleyRatio() const; | ||
| 84 | |||
| 85 | bool isMotorFanPulleyRatioAutosized() const; | ||
| 86 | |||
| 87 | boost::optional<double> beltMaximumTorque() const; | ||
| 88 | |||
| 89 | bool isBeltMaximumTorqueAutosized() const; | ||
| 90 | |||
| 91 | double beltSizingFactor() const; | ||
| 92 | |||
| 93 | double beltFractionalTorqueTransition() const; | ||
| 94 | |||
| 95 | double motorMaximumSpeed() const; | ||
| 96 | |||
| 97 | boost::optional<double> maximumMotorOutputPower() const; | ||
| 98 | |||
| 99 | bool isMaximumMotorOutputPowerAutosized() const; | ||
| 100 | |||
| 101 | double motorSizingFactor() const; | ||
| 102 | |||
| 103 | double motorInAirstreamFraction() const; | ||
| 104 | |||
| 105 | std::string vFDEfficiencyType() const; | ||
| 106 | |||
| 107 | boost::optional<double> maximumVFDOutputPower() const; | ||
| 108 | |||
| 109 | bool isMaximumVFDOutputPowerAutosized() const; | ||
| 110 | |||
| 111 | double vFDSizingFactor() const; | ||
| 112 | |||
| 113 | Curve fanPressureRiseCurve() const; | ||
| 114 | |||
| 115 | Curve ductStaticPressureResetCurve() const; | ||
| 116 | |||
| 117 | Curve normalizedFanStaticEfficiencyCurveNonStallRegion() const; | ||
| 118 | |||
| 119 | Curve normalizedFanStaticEfficiencyCurveStallRegion() const; | ||
| 120 | |||
| 121 | Curve normalizedDimensionlessAirflowCurveNonStallRegion() const; | ||
| 122 | |||
| 123 | Curve normalizedDimensionlessAirflowCurveStallRegion() const; | ||
| 124 | |||
| 125 | boost::optional<Curve> maximumBeltEfficiencyCurve() const; | ||
| 126 | |||
| 127 | boost::optional<Curve> normalizedBeltEfficiencyCurveRegion1() const; | ||
| 128 | |||
| 129 | boost::optional<Curve> normalizedBeltEfficiencyCurveRegion2() const; | ||
| 130 | |||
| 131 | boost::optional<Curve> normalizedBeltEfficiencyCurveRegion3() const; | ||
| 132 | |||
| 133 | boost::optional<Curve> maximumMotorEfficiencyCurve() const; | ||
| 134 | |||
| 135 | boost::optional<Curve> normalizedMotorEfficiencyCurve() const; | ||
| 136 | |||
| 137 | boost::optional<Curve> vFDEfficiencyCurve() const; | ||
| 138 | |||
| 139 | std::string endUseSubcategory() const; | ||
| 140 | |||
| 141 | //@} | ||
| 142 | /** @name Setters */ | ||
| 143 | //@{ | ||
| 144 | |||
| 145 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 146 | |||
| 147 | bool setMaximumFlowRate(double maximumFlowRate); | ||
| 148 | |||
| 149 | void autosizeMaximumFlowRate(); | ||
| 150 | |||
| 151 | bool setMinimumFlowRate(double minimumFlowRate); | ||
| 152 | |||
| 153 | void autosizeMinimumFlowRate(); | ||
| 154 | |||
| 155 | bool setFanSizingFactor(double fanSizingFactor); | ||
| 156 | |||
| 157 | bool setFanWheelDiameter(double fanWheelDiameter); | ||
| 158 | |||
| 159 | bool setFanOutletArea(double fanOutletArea); | ||
| 160 | |||
| 161 | bool setMaximumFanStaticEfficiency(double maximumFanStaticEfficiency); | ||
| 162 | |||
| 163 | bool setEulerNumberatMaximumFanStaticEfficiency(double eulerNumberatMaximumFanStaticEfficiency); | ||
| 164 | |||
| 165 | bool setMaximumDimensionlessFanAirflow(double maximumDimensionlessFanAirflow); | ||
| 166 | |||
| 167 | bool setMotorFanPulleyRatio(double motorFanPulleyRatio); | ||
| 168 | |||
| 169 | void autosizeMotorFanPulleyRatio(); | ||
| 170 | |||
| 171 | bool setBeltMaximumTorque(double beltMaximumTorque); | ||
| 172 | |||
| 173 | void autosizeBeltMaximumTorque(); | ||
| 174 | |||
| 175 | bool setBeltSizingFactor(double beltSizingFactor); | ||
| 176 | |||
| 177 | bool setBeltFractionalTorqueTransition(double beltFractionalTorqueTransition); | ||
| 178 | |||
| 179 | bool setMotorMaximumSpeed(double motorMaximumSpeed); | ||
| 180 | |||
| 181 | bool setMaximumMotorOutputPower(double maximumMotorOutputPower); | ||
| 182 | |||
| 183 | void autosizeMaximumMotorOutputPower(); | ||
| 184 | |||
| 185 | bool setMotorSizingFactor(double motorSizingFactor); | ||
| 186 | |||
| 187 | bool setMotorInAirstreamFraction(double motorInAirstreamFraction); | ||
| 188 | |||
| 189 | bool setVFDEfficiencyType(const std::string& vFDEfficiencyType); | ||
| 190 | |||
| 191 | bool setMaximumVFDOutputPower(double maximumVFDOutputPower); | ||
| 192 | |||
| 193 | void autosizeMaximumVFDOutputPower(); | ||
| 194 | |||
| 195 | bool setVFDSizingFactor(double vFDSizingFactor); | ||
| 196 | |||
| 197 | bool setFanPressureRiseCurve(const Curve& bivariateFunctions); | ||
| 198 | |||
| 199 | bool setDuctStaticPressureResetCurve(const Curve& univariateFunctions); | ||
| 200 | |||
| 201 | bool setNormalizedFanStaticEfficiencyCurveNonStallRegion(const Curve& univariateFunctions); | ||
| 202 | |||
| 203 | bool setNormalizedFanStaticEfficiencyCurveStallRegion(const Curve& univariateFunctions); | ||
| 204 | |||
| 205 | bool setNormalizedDimensionlessAirflowCurveNonStallRegion(const Curve& univariateFunctions); | ||
| 206 | |||
| 207 | bool setNormalizedDimensionlessAirflowCurveStallRegion(const Curve& univariateFunctions); | ||
| 208 | |||
| 209 | bool setMaximumBeltEfficiencyCurve(const Curve& univariateFunctions); | ||
| 210 | |||
| 211 | void resetMaximumBeltEfficiencyCurve(); | ||
| 212 | |||
| 213 | bool setNormalizedBeltEfficiencyCurveRegion1(const Curve& univariateFunctions); | ||
| 214 | |||
| 215 | void resetNormalizedBeltEfficiencyCurveRegion1(); | ||
| 216 | |||
| 217 | bool setNormalizedBeltEfficiencyCurveRegion2(const Curve& univariateFunctions); | ||
| 218 | |||
| 219 | void resetNormalizedBeltEfficiencyCurveRegion2(); | ||
| 220 | |||
| 221 | bool setNormalizedBeltEfficiencyCurveRegion3(const Curve& univariateFunctions); | ||
| 222 | |||
| 223 | void resetNormalizedBeltEfficiencyCurveRegion3(); | ||
| 224 | |||
| 225 | bool setMaximumMotorEfficiencyCurve(const Curve& univariateFunctions); | ||
| 226 | |||
| 227 | void resetMaximumMotorEfficiencyCurve(); | ||
| 228 | |||
| 229 | bool setNormalizedMotorEfficiencyCurve(const Curve& univariateFunctions); | ||
| 230 | |||
| 231 | void resetNormalizedMotorEfficiencyCurve(); | ||
| 232 | |||
| 233 | bool setVFDEfficiencyCurve(const Curve& univariateFunctions); | ||
| 234 | |||
| 235 | void resetVFDEfficiencyCurve(); | ||
| 236 | |||
| 237 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 238 | |||
| 239 | //@} | ||
| 240 | /** @name Other */ | ||
| 241 | //@{ | ||
| 242 | |||
| 243 | boost::optional<double> autosizedMaximumFlowRate(); | ||
| 244 | boost::optional<double> autosizedMinimumFlowRate(); | ||
| 245 | boost::optional<double> autosizedMotorFanPulleyRatio(); | ||
| 246 | boost::optional<double> autosizedBeltMaximumTorque(); | ||
| 247 | boost::optional<double> autosizedMaximumMotorOutputPower(); | ||
| 248 | boost::optional<double> autosizedMaximumVFDOutputPower(); | ||
| 249 | |||
| 250 | virtual void autosize() override; | ||
| 251 | |||
| 252 | virtual void applySizingValues() override; | ||
| 253 | |||
| 254 | //@} | ||
| 255 | protected: | ||
| 256 | private: | ||
| 257 | − | REGISTER_LOGGER("openstudio.model.FanComponentModel"); | |
| 258 | |||
| 259 | boost::optional<Curve> optionalFanPressureRiseCurve() const; | ||
| 260 | boost::optional<Curve> optionalDuctStaticPressureResetCurve() const; | ||
| 261 | boost::optional<Curve> optionalNormalizedFanStaticEfficiencyCurveNonStallRegion() const; | ||
| 262 | boost::optional<Curve> optionalNormalizedFanStaticEfficiencyCurveStallRegion() const; | ||
| 263 | boost::optional<Curve> optionalNormalizedDimensionlessAirflowCurveNonStallRegion() const; | ||
| 264 | boost::optional<Curve> optionalNormalizedDimensionlessAirflowCurveStallRegion() const; | ||
| 265 | |||
| 266 | virtual boost::optional<ZoneHVACComponent> containingZoneHVACComponent() const override; | ||
| 267 | |||
| 268 | virtual boost::optional<HVACComponent> containingHVACComponent() const override; | ||
| 269 | }; | ||
| 270 | |||
| 271 | } // namespace detail | ||
| 272 | |||
| 273 | } // namespace model | ||
| 274 | } // namespace openstudio | ||
| 275 | |||
| 276 | #endif // MODEL_FANCOMPONENTMODEL_IMPL_HPP | ||
| 277 |