src/model/ThermalStorageChilledWaterStratified.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_THERMALSTORAGECHILLEDWATERSTRATIFIED_HPP | ||
| 7 | #define MODEL_THERMALSTORAGECHILLEDWATERSTRATIFIED_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "WaterToWaterComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class ThermalZone; | ||
| 18 | class WaterHeaterSizing; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class ThermalStorageChilledWaterStratified_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** ThermalStorageChilledWaterStratified is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:ThermalStorage:ChilledWater:Stratified'. */ | ||
| 27 | class MODEL_API ThermalStorageChilledWaterStratified : public WaterToWaterComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit ThermalStorageChilledWaterStratified(const Model& model); | ||
| 34 | |||
| 35 | 15 | virtual ~ThermalStorageChilledWaterStratified() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | ThermalStorageChilledWaterStratified(const ThermalStorageChilledWaterStratified& other) = default; | |
| 38 | 1 | ThermalStorageChilledWaterStratified(ThermalStorageChilledWaterStratified&& other) = default; | |
| 39 | ✗ | ThermalStorageChilledWaterStratified& operator=(const ThermalStorageChilledWaterStratified&) = default; | |
| 40 | ✗ | ThermalStorageChilledWaterStratified& operator=(ThermalStorageChilledWaterStratified&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | static std::vector<std::string> tankShapeValues(); | ||
| 47 | |||
| 48 | static std::vector<std::string> ambientTemperatureIndicatorValues(); | ||
| 49 | |||
| 50 | static std::vector<std::string> inletModeValues(); | ||
| 51 | |||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | double tankVolume() const; | ||
| 56 | |||
| 57 | double tankHeight() const; | ||
| 58 | |||
| 59 | std::string tankShape() const; | ||
| 60 | |||
| 61 | boost::optional<double> tankPerimeter() const; | ||
| 62 | |||
| 63 | boost::optional<Schedule> setpointTemperatureSchedule() const; | ||
| 64 | |||
| 65 | double deadbandTemperatureDifference() const; | ||
| 66 | |||
| 67 | boost::optional<double> temperatureSensorHeight() const; | ||
| 68 | |||
| 69 | boost::optional<double> minimumTemperatureLimit() const; | ||
| 70 | |||
| 71 | boost::optional<double> nominalCoolingCapacity() const; | ||
| 72 | |||
| 73 | bool isNominalCoolingCapacityAutosized() const; | ||
| 74 | |||
| 75 | std::string ambientTemperatureIndicator() const; | ||
| 76 | |||
| 77 | boost::optional<Schedule> ambientTemperatureSchedule() const; | ||
| 78 | |||
| 79 | boost::optional<ThermalZone> ambientTemperatureThermalZone() const; | ||
| 80 | |||
| 81 | boost::optional<std::string> ambientTemperatureOutdoorAirNodeName() const; | ||
| 82 | |||
| 83 | boost::optional<double> uniformSkinLossCoefficientperUnitAreatoAmbientTemperature() const; | ||
| 84 | |||
| 85 | double useSideHeatTransferEffectiveness() const; | ||
| 86 | |||
| 87 | boost::optional<Schedule> useSideAvailabilitySchedule() const; | ||
| 88 | |||
| 89 | boost::optional<double> useSideInletHeight() const; | ||
| 90 | |||
| 91 | bool isUseSideInletHeightAutocalculated() const; | ||
| 92 | |||
| 93 | double useSideOutletHeight() const; | ||
| 94 | |||
| 95 | boost::optional<double> useSideDesignFlowRate() const; | ||
| 96 | |||
| 97 | bool isUseSideDesignFlowRateAutosized() const; | ||
| 98 | |||
| 99 | double sourceSideHeatTransferEffectiveness() const; | ||
| 100 | |||
| 101 | boost::optional<Schedule> sourceSideAvailabilitySchedule() const; | ||
| 102 | |||
| 103 | double sourceSideInletHeight() const; | ||
| 104 | |||
| 105 | boost::optional<double> sourceSideOutletHeight() const; | ||
| 106 | |||
| 107 | bool isSourceSideOutletHeightAutocalculated() const; | ||
| 108 | |||
| 109 | boost::optional<double> sourceSideDesignFlowRate() const; | ||
| 110 | |||
| 111 | bool isSourceSideDesignFlowRateAutosized() const; | ||
| 112 | |||
| 113 | double tankRecoveryTime() const; | ||
| 114 | |||
| 115 | std::string inletMode() const; | ||
| 116 | |||
| 117 | int numberofNodes() const; | ||
| 118 | |||
| 119 | double additionalDestratificationConductivity() const; | ||
| 120 | |||
| 121 | double node1AdditionalLossCoefficient() const; | ||
| 122 | |||
| 123 | double node2AdditionalLossCoefficient() const; | ||
| 124 | |||
| 125 | double node3AdditionalLossCoefficient() const; | ||
| 126 | |||
| 127 | double node4AdditionalLossCoefficient() const; | ||
| 128 | |||
| 129 | double node5AdditionalLossCoefficient() const; | ||
| 130 | |||
| 131 | double node6AdditionalLossCoefficient() const; | ||
| 132 | |||
| 133 | double node7AdditionalLossCoefficient() const; | ||
| 134 | |||
| 135 | double node8AdditionalLossCoefficient() const; | ||
| 136 | |||
| 137 | double node9AdditionalLossCoefficient() const; | ||
| 138 | |||
| 139 | double node10AdditionalLossCoefficient() const; | ||
| 140 | |||
| 141 | //@} | ||
| 142 | /** @name Setters */ | ||
| 143 | //@{ | ||
| 144 | |||
| 145 | bool setTankVolume(double tankVolume); | ||
| 146 | |||
| 147 | bool setTankHeight(double tankHeight); | ||
| 148 | |||
| 149 | bool setTankShape(const std::string& tankShape); | ||
| 150 | |||
| 151 | bool setTankPerimeter(double tankPerimeter); | ||
| 152 | |||
| 153 | void resetTankPerimeter(); | ||
| 154 | |||
| 155 | bool setSetpointTemperatureSchedule(Schedule& schedule); | ||
| 156 | |||
| 157 | void resetSetpointTemperatureSchedule(); | ||
| 158 | |||
| 159 | bool setDeadbandTemperatureDifference(double deadbandTemperatureDifference); | ||
| 160 | |||
| 161 | bool setTemperatureSensorHeight(double temperatureSensorHeight); | ||
| 162 | |||
| 163 | void resetTemperatureSensorHeight(); | ||
| 164 | |||
| 165 | bool setMinimumTemperatureLimit(double minimumTemperatureLimit); | ||
| 166 | |||
| 167 | void resetMinimumTemperatureLimit(); | ||
| 168 | |||
| 169 | bool setNominalCoolingCapacity(double nominalCoolingCapacity); | ||
| 170 | |||
| 171 | void autosizeNominalCoolingCapacity(); | ||
| 172 | |||
| 173 | bool setAmbientTemperatureIndicator(const std::string& ambientTemperatureIndicator); | ||
| 174 | |||
| 175 | bool setAmbientTemperatureSchedule(Schedule& schedule); | ||
| 176 | |||
| 177 | void resetAmbientTemperatureSchedule(); | ||
| 178 | |||
| 179 | bool setAmbientTemperatureThermalZone(const ThermalZone& thermalZone); | ||
| 180 | |||
| 181 | void resetAmbientTemperatureThermalZone(); | ||
| 182 | |||
| 183 | bool setAmbientTemperatureOutdoorAirNodeName(const std::string& ambientTemperatureOutdoorAirNodeName); | ||
| 184 | |||
| 185 | void resetAmbientTemperatureOutdoorAirNodeName(); | ||
| 186 | |||
| 187 | bool setUniformSkinLossCoefficientperUnitAreatoAmbientTemperature(double uniformSkinLossCoefficientperUnitAreatoAmbientTemperature); | ||
| 188 | |||
| 189 | void resetUniformSkinLossCoefficientperUnitAreatoAmbientTemperature(); | ||
| 190 | |||
| 191 | bool setUseSideHeatTransferEffectiveness(double useSideHeatTransferEffectiveness); | ||
| 192 | |||
| 193 | bool setUseSideAvailabilitySchedule(Schedule& schedule); | ||
| 194 | |||
| 195 | void resetUseSideAvailabilitySchedule(); | ||
| 196 | |||
| 197 | bool setUseSideInletHeight(double useSideInletHeight); | ||
| 198 | |||
| 199 | void autocalculateUseSideInletHeight(); | ||
| 200 | |||
| 201 | bool setUseSideOutletHeight(double useSideOutletHeight); | ||
| 202 | |||
| 203 | bool setUseSideDesignFlowRate(double useSideDesignFlowRate); | ||
| 204 | |||
| 205 | void autosizeUseSideDesignFlowRate(); | ||
| 206 | |||
| 207 | bool setSourceSideHeatTransferEffectiveness(double sourceSideHeatTransferEffectiveness); | ||
| 208 | |||
| 209 | bool setSourceSideAvailabilitySchedule(Schedule& schedule); | ||
| 210 | |||
| 211 | void resetSourceSideAvailabilitySchedule(); | ||
| 212 | |||
| 213 | bool setSourceSideInletHeight(double sourceSideInletHeight); | ||
| 214 | |||
| 215 | bool setSourceSideOutletHeight(double sourceSideOutletHeight); | ||
| 216 | |||
| 217 | void autocalculateSourceSideOutletHeight(); | ||
| 218 | |||
| 219 | bool setSourceSideDesignFlowRate(double sourceSideDesignFlowRate); | ||
| 220 | |||
| 221 | void autosizeSourceSideDesignFlowRate(); | ||
| 222 | |||
| 223 | bool setTankRecoveryTime(double tankRecoveryTime); | ||
| 224 | |||
| 225 | bool setInletMode(const std::string& inletMode); | ||
| 226 | |||
| 227 | bool setNumberofNodes(int numberofNodes); | ||
| 228 | |||
| 229 | bool setAdditionalDestratificationConductivity(double additionalDestratificationConductivity); | ||
| 230 | |||
| 231 | bool setNode1AdditionalLossCoefficient(double node1AdditionalLossCoefficient); | ||
| 232 | |||
| 233 | bool setNode2AdditionalLossCoefficient(double node2AdditionalLossCoefficient); | ||
| 234 | |||
| 235 | bool setNode3AdditionalLossCoefficient(double node3AdditionalLossCoefficient); | ||
| 236 | |||
| 237 | bool setNode4AdditionalLossCoefficient(double node4AdditionalLossCoefficient); | ||
| 238 | |||
| 239 | bool setNode5AdditionalLossCoefficient(double node5AdditionalLossCoefficient); | ||
| 240 | |||
| 241 | bool setNode6AdditionalLossCoefficient(double node6AdditionalLossCoefficient); | ||
| 242 | |||
| 243 | bool setNode7AdditionalLossCoefficient(double node7AdditionalLossCoefficient); | ||
| 244 | |||
| 245 | bool setNode8AdditionalLossCoefficient(double node8AdditionalLossCoefficient); | ||
| 246 | |||
| 247 | bool setNode9AdditionalLossCoefficient(double node9AdditionalLossCoefficient); | ||
| 248 | |||
| 249 | bool setNode10AdditionalLossCoefficient(double node10AdditionalLossCoefficient); | ||
| 250 | |||
| 251 | //@} | ||
| 252 | /** @name Other */ | ||
| 253 | //@{ | ||
| 254 | |||
| 255 | WaterHeaterSizing waterHeaterSizing() const; | ||
| 256 | |||
| 257 | boost::optional<double> autosizedNominalCoolingCapacity() const; | ||
| 258 | |||
| 259 | boost::optional<double> autosizedUseSideDesignFlowRate() const; | ||
| 260 | |||
| 261 | boost::optional<double> autosizedSourceSideDesignFlowRate() const; | ||
| 262 | |||
| 263 | //@} | ||
| 264 | protected: | ||
| 265 | /// @cond | ||
| 266 | using ImplType = detail::ThermalStorageChilledWaterStratified_Impl; | ||
| 267 | |||
| 268 | explicit ThermalStorageChilledWaterStratified(std::shared_ptr<detail::ThermalStorageChilledWaterStratified_Impl> impl); | ||
| 269 | |||
| 270 | friend class detail::ThermalStorageChilledWaterStratified_Impl; | ||
| 271 | friend class Model; | ||
| 272 | friend class IdfObject; | ||
| 273 | friend class openstudio::detail::IdfObject_Impl; | ||
| 274 | /// @endcond | ||
| 275 | private: | ||
| 276 | REGISTER_LOGGER("openstudio.model.ThermalStorageChilledWaterStratified"); | ||
| 277 | }; | ||
| 278 | |||
| 279 | /** \relates ThermalStorageChilledWaterStratified*/ | ||
| 280 | using OptionalThermalStorageChilledWaterStratified = boost::optional<ThermalStorageChilledWaterStratified>; | ||
| 281 | |||
| 282 | /** \relates ThermalStorageChilledWaterStratified*/ | ||
| 283 | using ThermalStorageChilledWaterStratifiedVector = std::vector<ThermalStorageChilledWaterStratified>; | ||
| 284 | |||
| 285 | } // namespace model | ||
| 286 | } // namespace openstudio | ||
| 287 | |||
| 288 | #endif // MODEL_THERMALSTORAGECHILLEDWATERSTRATIFIED_HPP | ||
| 289 |