src/model/ThermalStorageChilledWaterStratified_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_THERMALSTORAGECHILLEDWATERSTRATIFIED_IMPL_HPP | ||
| 7 | #define MODEL_THERMALSTORAGECHILLEDWATERSTRATIFIED_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "WaterToWaterComponent_Impl.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 | /** ThermalStorageChilledWaterStratified_Impl is a WaterToWaterComponent_Impl that is the implementation class for ThermalStorageChilledWaterStratified.*/ | ||
| 23 | class MODEL_API ThermalStorageChilledWaterStratified_Impl : public WaterToWaterComponent_Impl | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | ThermalStorageChilledWaterStratified_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | ThermalStorageChilledWaterStratified_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | ThermalStorageChilledWaterStratified_Impl(const ThermalStorageChilledWaterStratified_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 11 | virtual ~ThermalStorageChilledWaterStratified_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Virtual Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 42 | |||
| 43 | virtual IddObjectType iddObjectType() const override; | ||
| 44 | |||
| 45 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 46 | |||
| 47 | virtual unsigned supplyInletPort() const override; | ||
| 48 | |||
| 49 | virtual unsigned supplyOutletPort() const override; | ||
| 50 | |||
| 51 | virtual unsigned demandInletPort() const override; | ||
| 52 | |||
| 53 | virtual unsigned demandOutletPort() const override; | ||
| 54 | |||
| 55 | virtual std::vector<ModelObject> children() const override; | ||
| 56 | |||
| 57 | virtual ModelObject clone(Model model) const override; | ||
| 58 | |||
| 59 | virtual void autosize() override; | ||
| 60 | |||
| 61 | virtual void applySizingValues() override; | ||
| 62 | |||
| 63 | virtual ComponentType componentType() const override; | ||
| 64 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 65 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 66 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 67 | |||
| 68 | //@} | ||
| 69 | /** @name Getters */ | ||
| 70 | //@{ | ||
| 71 | |||
| 72 | double tankVolume() const; | ||
| 73 | |||
| 74 | double tankHeight() const; | ||
| 75 | |||
| 76 | std::string tankShape() const; | ||
| 77 | |||
| 78 | boost::optional<double> tankPerimeter() const; | ||
| 79 | |||
| 80 | boost::optional<Schedule> setpointTemperatureSchedule() const; | ||
| 81 | |||
| 82 | double deadbandTemperatureDifference() const; | ||
| 83 | |||
| 84 | boost::optional<double> temperatureSensorHeight() const; | ||
| 85 | |||
| 86 | boost::optional<double> minimumTemperatureLimit() const; | ||
| 87 | |||
| 88 | boost::optional<double> nominalCoolingCapacity() const; | ||
| 89 | |||
| 90 | bool isNominalCoolingCapacityAutosized() const; | ||
| 91 | |||
| 92 | std::string ambientTemperatureIndicator() const; | ||
| 93 | |||
| 94 | boost::optional<Schedule> ambientTemperatureSchedule() const; | ||
| 95 | |||
| 96 | boost::optional<ThermalZone> ambientTemperatureThermalZone() const; | ||
| 97 | |||
| 98 | boost::optional<std::string> ambientTemperatureOutdoorAirNodeName() const; | ||
| 99 | |||
| 100 | boost::optional<double> uniformSkinLossCoefficientperUnitAreatoAmbientTemperature() const; | ||
| 101 | |||
| 102 | double useSideHeatTransferEffectiveness() const; | ||
| 103 | |||
| 104 | boost::optional<Schedule> useSideAvailabilitySchedule() const; | ||
| 105 | |||
| 106 | boost::optional<double> useSideInletHeight() const; | ||
| 107 | |||
| 108 | bool isUseSideInletHeightAutocalculated() const; | ||
| 109 | |||
| 110 | double useSideOutletHeight() const; | ||
| 111 | |||
| 112 | boost::optional<double> useSideDesignFlowRate() const; | ||
| 113 | |||
| 114 | bool isUseSideDesignFlowRateAutosized() const; | ||
| 115 | |||
| 116 | double sourceSideHeatTransferEffectiveness() const; | ||
| 117 | |||
| 118 | boost::optional<Schedule> sourceSideAvailabilitySchedule() const; | ||
| 119 | |||
| 120 | double sourceSideInletHeight() const; | ||
| 121 | |||
| 122 | boost::optional<double> sourceSideOutletHeight() const; | ||
| 123 | |||
| 124 | bool isSourceSideOutletHeightAutocalculated() const; | ||
| 125 | |||
| 126 | boost::optional<double> sourceSideDesignFlowRate() const; | ||
| 127 | |||
| 128 | bool isSourceSideDesignFlowRateAutosized() const; | ||
| 129 | |||
| 130 | double tankRecoveryTime() const; | ||
| 131 | |||
| 132 | std::string inletMode() const; | ||
| 133 | |||
| 134 | int numberofNodes() const; | ||
| 135 | |||
| 136 | double additionalDestratificationConductivity() const; | ||
| 137 | |||
| 138 | double node1AdditionalLossCoefficient() const; | ||
| 139 | |||
| 140 | double node2AdditionalLossCoefficient() const; | ||
| 141 | |||
| 142 | double node3AdditionalLossCoefficient() const; | ||
| 143 | |||
| 144 | double node4AdditionalLossCoefficient() const; | ||
| 145 | |||
| 146 | double node5AdditionalLossCoefficient() const; | ||
| 147 | |||
| 148 | double node6AdditionalLossCoefficient() const; | ||
| 149 | |||
| 150 | double node7AdditionalLossCoefficient() const; | ||
| 151 | |||
| 152 | double node8AdditionalLossCoefficient() const; | ||
| 153 | |||
| 154 | double node9AdditionalLossCoefficient() const; | ||
| 155 | |||
| 156 | double node10AdditionalLossCoefficient() const; | ||
| 157 | |||
| 158 | boost::optional<double> autosizedNominalCoolingCapacity() const; | ||
| 159 | |||
| 160 | boost::optional<double> autosizedUseSideDesignFlowRate() const; | ||
| 161 | |||
| 162 | boost::optional<double> autosizedSourceSideDesignFlowRate() const; | ||
| 163 | |||
| 164 | //@} | ||
| 165 | /** @name Setters */ | ||
| 166 | //@{ | ||
| 167 | |||
| 168 | bool setTankVolume(double tankVolume); | ||
| 169 | |||
| 170 | bool setTankHeight(double tankHeight); | ||
| 171 | |||
| 172 | bool setTankShape(const std::string& tankShape); | ||
| 173 | |||
| 174 | bool setTankPerimeter(boost::optional<double> tankPerimeter); | ||
| 175 | |||
| 176 | void resetTankPerimeter(); | ||
| 177 | |||
| 178 | bool setSetpointTemperatureSchedule(Schedule& schedule); | ||
| 179 | |||
| 180 | void resetSetpointTemperatureSchedule(); | ||
| 181 | |||
| 182 | bool setDeadbandTemperatureDifference(double deadbandTemperatureDifference); | ||
| 183 | |||
| 184 | bool setTemperatureSensorHeight(boost::optional<double> temperatureSensorHeight); | ||
| 185 | |||
| 186 | void resetTemperatureSensorHeight(); | ||
| 187 | |||
| 188 | bool setMinimumTemperatureLimit(boost::optional<double> minimumTemperatureLimit); | ||
| 189 | |||
| 190 | void resetMinimumTemperatureLimit(); | ||
| 191 | |||
| 192 | bool setNominalCoolingCapacity(boost::optional<double> nominalCoolingCapacity); | ||
| 193 | |||
| 194 | void autosizeNominalCoolingCapacity(); | ||
| 195 | |||
| 196 | bool setAmbientTemperatureIndicator(const std::string& ambientTemperatureIndicator); | ||
| 197 | |||
| 198 | bool setAmbientTemperatureSchedule(Schedule& schedule); | ||
| 199 | |||
| 200 | void resetAmbientTemperatureSchedule(); | ||
| 201 | |||
| 202 | bool setAmbientTemperatureThermalZone(const boost::optional<ThermalZone>& thermalZone); | ||
| 203 | |||
| 204 | void resetAmbientTemperatureThermalZone(); | ||
| 205 | |||
| 206 | bool setAmbientTemperatureOutdoorAirNodeName(boost::optional<std::string> ambientTemperatureOutdoorAirNodeName); | ||
| 207 | |||
| 208 | void resetAmbientTemperatureOutdoorAirNodeName(); | ||
| 209 | |||
| 210 | bool setUniformSkinLossCoefficientperUnitAreatoAmbientTemperature( | ||
| 211 | boost::optional<double> uniformSkinLossCoefficientperUnitAreatoAmbientTemperature); | ||
| 212 | |||
| 213 | void resetUniformSkinLossCoefficientperUnitAreatoAmbientTemperature(); | ||
| 214 | |||
| 215 | bool setUseSideHeatTransferEffectiveness(double useSideHeatTransferEffectiveness); | ||
| 216 | |||
| 217 | bool setUseSideAvailabilitySchedule(Schedule& schedule); | ||
| 218 | |||
| 219 | void resetUseSideAvailabilitySchedule(); | ||
| 220 | |||
| 221 | bool setUseSideInletHeight(boost::optional<double> useSideInletHeight); | ||
| 222 | |||
| 223 | void autocalculateUseSideInletHeight(); | ||
| 224 | |||
| 225 | bool setUseSideOutletHeight(double useSideOutletHeight); | ||
| 226 | |||
| 227 | bool setUseSideDesignFlowRate(boost::optional<double> useSideDesignFlowRate); | ||
| 228 | |||
| 229 | void autosizeUseSideDesignFlowRate(); | ||
| 230 | |||
| 231 | bool setSourceSideHeatTransferEffectiveness(double sourceSideHeatTransferEffectiveness); | ||
| 232 | |||
| 233 | bool setSourceSideAvailabilitySchedule(Schedule& schedule); | ||
| 234 | |||
| 235 | void resetSourceSideAvailabilitySchedule(); | ||
| 236 | |||
| 237 | bool setSourceSideInletHeight(double sourceSideInletHeight); | ||
| 238 | |||
| 239 | bool setSourceSideOutletHeight(boost::optional<double> sourceSideOutletHeight); | ||
| 240 | |||
| 241 | void autocalculateSourceSideOutletHeight(); | ||
| 242 | |||
| 243 | bool setSourceSideDesignFlowRate(boost::optional<double> sourceSideDesignFlowRate); | ||
| 244 | |||
| 245 | void autosizeSourceSideDesignFlowRate(); | ||
| 246 | |||
| 247 | bool setTankRecoveryTime(double tankRecoveryTime); | ||
| 248 | |||
| 249 | bool setInletMode(const std::string& inletMode); | ||
| 250 | |||
| 251 | bool setNumberofNodes(int numberofNodes); | ||
| 252 | |||
| 253 | bool setAdditionalDestratificationConductivity(double additionalDestratificationConductivity); | ||
| 254 | |||
| 255 | bool setNode1AdditionalLossCoefficient(double node1AdditionalLossCoefficient); | ||
| 256 | |||
| 257 | bool setNode2AdditionalLossCoefficient(double node2AdditionalLossCoefficient); | ||
| 258 | |||
| 259 | bool setNode3AdditionalLossCoefficient(double node3AdditionalLossCoefficient); | ||
| 260 | |||
| 261 | bool setNode4AdditionalLossCoefficient(double node4AdditionalLossCoefficient); | ||
| 262 | |||
| 263 | bool setNode5AdditionalLossCoefficient(double node5AdditionalLossCoefficient); | ||
| 264 | |||
| 265 | bool setNode6AdditionalLossCoefficient(double node6AdditionalLossCoefficient); | ||
| 266 | |||
| 267 | bool setNode7AdditionalLossCoefficient(double node7AdditionalLossCoefficient); | ||
| 268 | |||
| 269 | bool setNode8AdditionalLossCoefficient(double node8AdditionalLossCoefficient); | ||
| 270 | |||
| 271 | bool setNode9AdditionalLossCoefficient(double node9AdditionalLossCoefficient); | ||
| 272 | |||
| 273 | bool setNode10AdditionalLossCoefficient(double node10AdditionalLossCoefficient); | ||
| 274 | |||
| 275 | //@} | ||
| 276 | /** @name Other */ | ||
| 277 | //@{ | ||
| 278 | |||
| 279 | WaterHeaterSizing waterHeaterSizing() const; | ||
| 280 | |||
| 281 | //@} | ||
| 282 | protected: | ||
| 283 | private: | ||
| 284 | − | REGISTER_LOGGER("openstudio.model.ThermalStorageChilledWaterStratified"); | |
| 285 | |||
| 286 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 287 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 288 | // objects should be returned as boost::optionals | ||
| 289 | }; | ||
| 290 | |||
| 291 | } // namespace detail | ||
| 292 | |||
| 293 | } // namespace model | ||
| 294 | } // namespace openstudio | ||
| 295 | |||
| 296 | #endif // MODEL_THERMALSTORAGECHILLEDWATERSTRATIFIED_IMPL_HPP | ||
| 297 |