src/model/ChillerAbsorption.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_CHILLERABSORPTION_HPP | ||
| 7 | #define MODEL_CHILLERABSORPTION_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "WaterToWaterComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class ChillerAbsorption_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** ChillerAbsorption is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:Chiller:Absorption'. */ | ||
| 23 | class MODEL_API ChillerAbsorption : public WaterToWaterComponent | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | explicit ChillerAbsorption(const Model& model); | ||
| 30 | |||
| 31 | 3 | virtual ~ChillerAbsorption() override = default; | |
| 32 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 33 | ✗ | ChillerAbsorption(const ChillerAbsorption& other) = default; | |
| 34 | ✗ | ChillerAbsorption(ChillerAbsorption&& other) = default; | |
| 35 | ✗ | ChillerAbsorption& operator=(const ChillerAbsorption&) = default; | |
| 36 | ✗ | ChillerAbsorption& operator=(ChillerAbsorption&&) = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | static std::vector<std::string> chillerFlowModeValues(); | ||
| 43 | |||
| 44 | static std::vector<std::string> generatorHeatSourceTypeValues(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | boost::optional<double> nominalCapacity() const; | ||
| 50 | |||
| 51 | bool isNominalCapacityAutosized() const; | ||
| 52 | |||
| 53 | boost::optional<double> nominalPumpingPower() const; | ||
| 54 | |||
| 55 | bool isNominalPumpingPowerAutosized() const; | ||
| 56 | |||
| 57 | double minimumPartLoadRatio() const; | ||
| 58 | |||
| 59 | double maximumPartLoadRatio() const; | ||
| 60 | |||
| 61 | double optimumPartLoadRatio() const; | ||
| 62 | |||
| 63 | double designCondenserInletTemperature() const; | ||
| 64 | |||
| 65 | boost::optional<double> designChilledWaterFlowRate() const; | ||
| 66 | |||
| 67 | bool isDesignChilledWaterFlowRateAutosized() const; | ||
| 68 | |||
| 69 | boost::optional<double> designCondenserWaterFlowRate() const; | ||
| 70 | |||
| 71 | bool isDesignCondenserWaterFlowRateAutosized() const; | ||
| 72 | |||
| 73 | double coefficient1oftheHotWaterorSteamUsePartLoadRatioCurve() const; | ||
| 74 | |||
| 75 | double coefficient2oftheHotWaterorSteamUsePartLoadRatioCurve() const; | ||
| 76 | |||
| 77 | double coefficient3oftheHotWaterorSteamUsePartLoadRatioCurve() const; | ||
| 78 | |||
| 79 | double coefficient1ofthePumpElectricUsePartLoadRatioCurve() const; | ||
| 80 | |||
| 81 | double coefficient2ofthePumpElectricUsePartLoadRatioCurve() const; | ||
| 82 | |||
| 83 | double coefficient3ofthePumpElectricUsePartLoadRatioCurve() const; | ||
| 84 | |||
| 85 | double chilledWaterOutletTemperatureLowerLimit() const; | ||
| 86 | |||
| 87 | std::string chillerFlowMode() const; | ||
| 88 | |||
| 89 | std::string generatorHeatSourceType() const; | ||
| 90 | |||
| 91 | boost::optional<double> designGeneratorFluidFlowRate() const; | ||
| 92 | |||
| 93 | bool isDesignGeneratorFluidFlowRateAutosized() const; | ||
| 94 | |||
| 95 | double degreeofSubcoolinginSteamGenerator() const; | ||
| 96 | |||
| 97 | double sizingFactor() const; | ||
| 98 | |||
| 99 | //@} | ||
| 100 | /** @name Setters */ | ||
| 101 | //@{ | ||
| 102 | |||
| 103 | bool setNominalCapacity(double nominalCapacity); | ||
| 104 | |||
| 105 | void autosizeNominalCapacity(); | ||
| 106 | |||
| 107 | bool setNominalPumpingPower(double nominalPumpingPower); | ||
| 108 | |||
| 109 | void autosizeNominalPumpingPower(); | ||
| 110 | |||
| 111 | bool setMinimumPartLoadRatio(double minimumPartLoadRatio); | ||
| 112 | |||
| 113 | bool setMaximumPartLoadRatio(double maximumPartLoadRatio); | ||
| 114 | |||
| 115 | bool setOptimumPartLoadRatio(double optimumPartLoadRatio); | ||
| 116 | |||
| 117 | bool setDesignCondenserInletTemperature(double designCondenserInletTemperature); | ||
| 118 | |||
| 119 | bool setDesignChilledWaterFlowRate(double designChilledWaterFlowRate); | ||
| 120 | |||
| 121 | void autosizeDesignChilledWaterFlowRate(); | ||
| 122 | |||
| 123 | bool setDesignCondenserWaterFlowRate(double designCondenserWaterFlowRate); | ||
| 124 | |||
| 125 | void autosizeDesignCondenserWaterFlowRate(); | ||
| 126 | |||
| 127 | bool setCoefficient1oftheHotWaterorSteamUsePartLoadRatioCurve(double coefficient1oftheHotWaterorSteamUsePartLoadRatioCurve); | ||
| 128 | |||
| 129 | bool setCoefficient2oftheHotWaterorSteamUsePartLoadRatioCurve(double coefficient2oftheHotWaterorSteamUsePartLoadRatioCurve); | ||
| 130 | |||
| 131 | bool setCoefficient3oftheHotWaterorSteamUsePartLoadRatioCurve(double coefficient3oftheHotWaterorSteamUsePartLoadRatioCurve); | ||
| 132 | |||
| 133 | bool setCoefficient1ofthePumpElectricUsePartLoadRatioCurve(double coefficient1ofthePumpElectricUsePartLoadRatioCurve); | ||
| 134 | |||
| 135 | bool setCoefficient2ofthePumpElectricUsePartLoadRatioCurve(double coefficient2ofthePumpElectricUsePartLoadRatioCurve); | ||
| 136 | |||
| 137 | bool setCoefficient3ofthePumpElectricUsePartLoadRatioCurve(double coefficient3ofthePumpElectricUsePartLoadRatioCurve); | ||
| 138 | |||
| 139 | bool setChilledWaterOutletTemperatureLowerLimit(double chilledWaterOutletTemperatureLowerLimit); | ||
| 140 | |||
| 141 | bool setChillerFlowMode(const std::string& chillerFlowMode); | ||
| 142 | |||
| 143 | // Will not accept "Steam" if chiller is connected to a Generator Loop as we do not support Steam Loops (yet) | ||
| 144 | bool setGeneratorHeatSourceType(const std::string& generatorHeatSourceType); | ||
| 145 | |||
| 146 | bool setDesignGeneratorFluidFlowRate(double designGeneratorFluidFlowRate); | ||
| 147 | |||
| 148 | void autosizeDesignGeneratorFluidFlowRate(); | ||
| 149 | |||
| 150 | bool setDegreeofSubcoolinginSteamGenerator(double degreeofSubcoolinginSteamGenerator); | ||
| 151 | |||
| 152 | bool setSizingFactor(double sizingFactor); | ||
| 153 | |||
| 154 | //@} | ||
| 155 | /** @name Other */ | ||
| 156 | //@{ | ||
| 157 | |||
| 158 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 159 | |||
| 160 | boost::optional<double> autosizedNominalPumpingPower() const; | ||
| 161 | |||
| 162 | boost::optional<double> autosizedDesignChilledWaterFlowRate() const; | ||
| 163 | |||
| 164 | boost::optional<double> autosizedDesignCondenserWaterFlowRate() const; | ||
| 165 | |||
| 166 | boost::optional<double> autosizedDesignGeneratorFluidFlowRate() const; | ||
| 167 | |||
| 168 | /** Convenience Function to return the Chilled Water Loop (chiller on supply) **/ | ||
| 169 | boost::optional<PlantLoop> chilledWaterLoop() const; | ||
| 170 | |||
| 171 | /** Convenience Function to return the Condenser Water Loop (chiller on demand side) **/ | ||
| 172 | boost::optional<PlantLoop> condenserWaterLoop() const; | ||
| 173 | |||
| 174 | /** Convenience Function to return the Generator Loop (chiller on the demand side - tertiary) **/ | ||
| 175 | boost::optional<PlantLoop> generatorLoop() const; | ||
| 176 | |||
| 177 | //@} | ||
| 178 | protected: | ||
| 179 | /// @cond | ||
| 180 | using ImplType = detail::ChillerAbsorption_Impl; | ||
| 181 | |||
| 182 | explicit ChillerAbsorption(std::shared_ptr<detail::ChillerAbsorption_Impl> impl); | ||
| 183 | |||
| 184 | friend class detail::ChillerAbsorption_Impl; | ||
| 185 | friend class Model; | ||
| 186 | friend class IdfObject; | ||
| 187 | friend class openstudio::detail::IdfObject_Impl; | ||
| 188 | /// @endcond | ||
| 189 | private: | ||
| 190 | REGISTER_LOGGER("openstudio.model.ChillerAbsorption"); | ||
| 191 | }; | ||
| 192 | |||
| 193 | /** \relates ChillerAbsorption*/ | ||
| 194 | using OptionalChillerAbsorption = boost::optional<ChillerAbsorption>; | ||
| 195 | |||
| 196 | /** \relates ChillerAbsorption*/ | ||
| 197 | using ChillerAbsorptionVector = std::vector<ChillerAbsorption>; | ||
| 198 | |||
| 199 | } // namespace model | ||
| 200 | } // namespace openstudio | ||
| 201 | |||
| 202 | #endif // MODEL_CHILLERABSORPTION_HPP | ||
| 203 |