src/model/CoilCoolingDXVariableSpeed.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_COILCOOLINGDXVARIABLESPEED_HPP | ||
| 7 | #define MODEL_COILCOOLINGDXVARIABLESPEED_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Curve; | ||
| 17 | // class WaterStorageTank; | ||
| 18 | class Schedule; | ||
| 19 | class CoilCoolingDXVariableSpeedSpeedData; | ||
| 20 | class AirflowNetworkEquivalentDuct; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class CoilCoolingDXVariableSpeed_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** CoilCoolingDXVariableSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Cooling:DX:VariableSpeed'. */ | ||
| 29 | class MODEL_API CoilCoolingDXVariableSpeed : public StraightComponent | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | explicit CoilCoolingDXVariableSpeed(const Model& model); | ||
| 36 | |||
| 37 | explicit CoilCoolingDXVariableSpeed(const Model& model, const Curve& partLoadFraction); | ||
| 38 | |||
| 39 | 97 | virtual ~CoilCoolingDXVariableSpeed() override = default; | |
| 40 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 41 | ✗ | CoilCoolingDXVariableSpeed(const CoilCoolingDXVariableSpeed& other) = default; | |
| 42 | 18 | CoilCoolingDXVariableSpeed(CoilCoolingDXVariableSpeed&& other) = default; | |
| 43 | ✗ | CoilCoolingDXVariableSpeed& operator=(const CoilCoolingDXVariableSpeed&) = default; | |
| 44 | ✗ | CoilCoolingDXVariableSpeed& operator=(CoilCoolingDXVariableSpeed&&) = default; | |
| 45 | |||
| 46 | //@} | ||
| 47 | |||
| 48 | static IddObjectType iddObjectType(); | ||
| 49 | |||
| 50 | static std::vector<std::string> condenserTypeValues(); | ||
| 51 | |||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | Schedule availabilitySchedule() const; | ||
| 56 | |||
| 57 | int nominalSpeedLevel() const; | ||
| 58 | |||
| 59 | boost::optional<double> grossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel() const; | ||
| 60 | |||
| 61 | bool isGrossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevelAutosized() const; | ||
| 62 | |||
| 63 | boost::optional<double> ratedAirFlowRateAtSelectedNominalSpeedLevel() const; | ||
| 64 | |||
| 65 | bool isRatedAirFlowRateAtSelectedNominalSpeedLevelAutosized() const; | ||
| 66 | |||
| 67 | double nominalTimeforCondensatetoBeginLeavingtheCoil() const; | ||
| 68 | |||
| 69 | double initialMoistureEvaporationRateDividedbySteadyStateACLatentCapacity() const; | ||
| 70 | |||
| 71 | double maximumCyclingRate() const; | ||
| 72 | |||
| 73 | double latentCapacityTimeConstant() const; | ||
| 74 | |||
| 75 | double fanDelayTime() const; | ||
| 76 | |||
| 77 | Curve energyPartLoadFractionCurve() const; | ||
| 78 | |||
| 79 | // boost::optional<std::string> condenserAirInletNodeName() const; | ||
| 80 | |||
| 81 | std::string condenserType() const; | ||
| 82 | |||
| 83 | boost::optional<double> evaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 84 | |||
| 85 | bool isEvaporativeCondenserPumpRatedPowerConsumptionAutosized() const; | ||
| 86 | |||
| 87 | double crankcaseHeaterCapacity() const; | ||
| 88 | |||
| 89 | boost::optional<Curve> crankcaseHeaterCapacityFunctionofTemperatureCurve() const; | ||
| 90 | |||
| 91 | double maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation() const; | ||
| 92 | |||
| 93 | // boost::optional<WaterStorageTank> supplyWaterStorageTank() const; | ||
| 94 | |||
| 95 | // boost::optional<WaterStorageTank> condensateCollectionWaterStorageTank() const; | ||
| 96 | |||
| 97 | double basinHeaterCapacity() const; | ||
| 98 | |||
| 99 | double basinHeaterSetpointTemperature() const; | ||
| 100 | |||
| 101 | boost::optional<Schedule> basinHeaterOperatingSchedule() const; | ||
| 102 | |||
| 103 | double minimumOutdoorDryBulbTemperatureforCompressorOperation() const; | ||
| 104 | |||
| 105 | //@} | ||
| 106 | /** @name Setters */ | ||
| 107 | //@{ | ||
| 108 | |||
| 109 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 110 | |||
| 111 | bool setNominalSpeedLevel(int nominalSpeedLevel); | ||
| 112 | |||
| 113 | bool setGrossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel(double grossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel); | ||
| 114 | |||
| 115 | void autosizeGrossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel(); | ||
| 116 | |||
| 117 | bool setRatedAirFlowRateAtSelectedNominalSpeedLevel(double ratedAirFlowRateAtSelectedNominalSpeedLevel); | ||
| 118 | |||
| 119 | void autosizeRatedAirFlowRateAtSelectedNominalSpeedLevel(); | ||
| 120 | |||
| 121 | bool setNominalTimeforCondensatetoBeginLeavingtheCoil(double nominalTimeforCondensatetoBeginLeavingtheCoil); | ||
| 122 | |||
| 123 | bool setInitialMoistureEvaporationRateDividedbySteadyStateACLatentCapacity( | ||
| 124 | double initialMoistureEvaporationRateDividedbySteadyStateACLatentCapacity); | ||
| 125 | |||
| 126 | bool setMaximumCyclingRate(double maximumCyclingRate); | ||
| 127 | |||
| 128 | bool setLatentCapacityTimeConstant(double latentCapacityTimeConstant); | ||
| 129 | |||
| 130 | bool setFanDelayTime(double fanDelayTime); | ||
| 131 | |||
| 132 | bool setEnergyPartLoadFractionCurve(const Curve& curve); | ||
| 133 | |||
| 134 | // bool setCondenserAirInletNodeName(const std::string& condenserAirInletNodeName); | ||
| 135 | |||
| 136 | // void resetCondenserAirInletNodeName(); | ||
| 137 | |||
| 138 | bool setCondenserType(const std::string& condenserType); | ||
| 139 | |||
| 140 | bool setEvaporativeCondenserPumpRatedPowerConsumption(double evaporativeCondenserPumpRatedPowerConsumption); | ||
| 141 | |||
| 142 | void autosizeEvaporativeCondenserPumpRatedPowerConsumption(); | ||
| 143 | |||
| 144 | bool setCrankcaseHeaterCapacity(double crankcaseHeaterCapacity); | ||
| 145 | |||
| 146 | bool setCrankcaseHeaterCapacityFunctionofTemperatureCurve(const Curve& curve); | ||
| 147 | |||
| 148 | void resetCrankcaseHeaterCapacityFunctionofTemperatureCurve(); | ||
| 149 | |||
| 150 | bool setMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation(double maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation); | ||
| 151 | |||
| 152 | // bool setSupplyWaterStorageTank(const WaterStorageTank& waterStorageTank); | ||
| 153 | |||
| 154 | // void resetSupplyWaterStorageTank(); | ||
| 155 | |||
| 156 | // bool setCondensateCollectionWaterStorageTank(const WaterStorageTank& waterStorageTank); | ||
| 157 | |||
| 158 | // void resetCondensateCollectionWaterStorageTank(); | ||
| 159 | |||
| 160 | bool setBasinHeaterCapacity(double basinHeaterCapacity); | ||
| 161 | |||
| 162 | bool setBasinHeaterSetpointTemperature(double basinHeaterSetpointTemperature); | ||
| 163 | |||
| 164 | bool setBasinHeaterOperatingSchedule(Schedule& schedule); | ||
| 165 | |||
| 166 | void resetBasinHeaterOperatingSchedule(); | ||
| 167 | |||
| 168 | bool setMinimumOutdoorDryBulbTemperatureforCompressorOperation(double minimumOutdoorDryBulbTemperatureforCompressorOperation); | ||
| 169 | |||
| 170 | //@} | ||
| 171 | /** @name Other */ | ||
| 172 | //@{ | ||
| 173 | |||
| 174 | std::vector<CoilCoolingDXVariableSpeedSpeedData> speeds() const; | ||
| 175 | |||
| 176 | bool addSpeed(const CoilCoolingDXVariableSpeedSpeedData& speed); | ||
| 177 | |||
| 178 | void removeSpeed(const CoilCoolingDXVariableSpeedSpeedData& speed); | ||
| 179 | |||
| 180 | void removeAllSpeeds(); | ||
| 181 | |||
| 182 | /** Returns an equivalent duct object, creating a new one if an object is not already attached. */ | ||
| 183 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 184 | |||
| 185 | /** Returns the attached equivalent duct object if there is one. */ | ||
| 186 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 187 | |||
| 188 | boost::optional<double> autosizedGrossRatedTotalCoolingCapacityAtSelectedNominalSpeedLevel() const; | ||
| 189 | |||
| 190 | boost::optional<double> autosizedRatedAirFlowRateAtSelectedNominalSpeedLevel() const; | ||
| 191 | |||
| 192 | boost::optional<double> autosizedEvaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 193 | |||
| 194 | //@} | ||
| 195 | protected: | ||
| 196 | /// @cond | ||
| 197 | using ImplType = detail::CoilCoolingDXVariableSpeed_Impl; | ||
| 198 | |||
| 199 | explicit CoilCoolingDXVariableSpeed(std::shared_ptr<detail::CoilCoolingDXVariableSpeed_Impl> impl); | ||
| 200 | |||
| 201 | friend class detail::CoilCoolingDXVariableSpeed_Impl; | ||
| 202 | friend class Model; | ||
| 203 | friend class IdfObject; | ||
| 204 | friend class openstudio::detail::IdfObject_Impl; | ||
| 205 | /// @endcond | ||
| 206 | private: | ||
| 207 | REGISTER_LOGGER("openstudio.model.CoilCoolingDXVariableSpeed"); | ||
| 208 | }; | ||
| 209 | |||
| 210 | /** \relates CoilCoolingDXVariableSpeed*/ | ||
| 211 | using OptionalCoilCoolingDXVariableSpeed = boost::optional<CoilCoolingDXVariableSpeed>; | ||
| 212 | |||
| 213 | /** \relates CoilCoolingDXVariableSpeed*/ | ||
| 214 | using CoilCoolingDXVariableSpeedVector = std::vector<CoilCoolingDXVariableSpeed>; | ||
| 215 | |||
| 216 | } // namespace model | ||
| 217 | } // namespace openstudio | ||
| 218 | |||
| 219 | #endif // MODEL_COILCOOLINGDXVARIABLESPEED_HPP | ||
| 220 |