src/model/ChillerElectricASHRAE205.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_CHILLERELECTRICASHRAE205_HPP | ||
| 7 | #define MODEL_CHILLERELECTRICASHRAE205_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "WaterToWaterComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class ExternalFile; | ||
| 17 | class Node; | ||
| 18 | class ThermalZone; | ||
| 19 | class Schedule; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | class ChillerElectricASHRAE205_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** ChillerElectricASHRAE205 is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:Chiller:Electric:ASHRAE205'. */ | ||
| 28 | class MODEL_API ChillerElectricASHRAE205 : public WaterToWaterComponent | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | explicit ChillerElectricASHRAE205(const ExternalFile& representationFile); | ||
| 35 | |||
| 36 | 55 | virtual ~ChillerElectricASHRAE205() override = default; | |
| 37 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 38 | 6 | ChillerElectricASHRAE205(const ChillerElectricASHRAE205& other) = default; | |
| 39 | 19 | ChillerElectricASHRAE205(ChillerElectricASHRAE205&& other) = default; | |
| 40 | ✗ | ChillerElectricASHRAE205& operator=(const ChillerElectricASHRAE205&) = default; | |
| 41 | ✗ | ChillerElectricASHRAE205& operator=(ChillerElectricASHRAE205&&) = default; | |
| 42 | |||
| 43 | // TODO: once supported by E+, re-enable | ||
| 44 | static constexpr bool isHeatRecoverySupportedByEnergyplus = false; | ||
| 45 | |||
| 46 | //@} | ||
| 47 | |||
| 48 | static IddObjectType iddObjectType(); | ||
| 49 | |||
| 50 | static std::vector<std::string> performanceInterpolationMethodValues(); | ||
| 51 | |||
| 52 | static std::vector<std::string> ambientTemperatureIndicatorValues(); | ||
| 53 | |||
| 54 | static std::vector<std::string> chillerFlowModeValues(); | ||
| 55 | |||
| 56 | /** @name Getters */ | ||
| 57 | //@{ | ||
| 58 | |||
| 59 | ExternalFile representationFile() const; | ||
| 60 | |||
| 61 | std::string performanceInterpolationMethod() const; | ||
| 62 | |||
| 63 | boost::optional<double> ratedCapacity() const; | ||
| 64 | bool isRatedCapacityAutosized() const; | ||
| 65 | |||
| 66 | double sizingFactor() const; | ||
| 67 | |||
| 68 | std::string ambientTemperatureIndicator() const; | ||
| 69 | |||
| 70 | boost::optional<Schedule> ambientTemperatureSchedule() const; | ||
| 71 | |||
| 72 | boost::optional<ThermalZone> ambientTemperatureZone() const; | ||
| 73 | |||
| 74 | boost::optional<std::string> ambientTemperatureOutdoorAirNodeName() const; | ||
| 75 | |||
| 76 | boost::optional<double> chilledWaterMaximumRequestedFlowRate() const; | ||
| 77 | bool isChilledWaterMaximumRequestedFlowRateAutosized() const; | ||
| 78 | |||
| 79 | boost::optional<double> condenserMaximumRequestedFlowRate() const; | ||
| 80 | bool isCondenserMaximumRequestedFlowRateAutosized() const; | ||
| 81 | |||
| 82 | std::string chillerFlowMode() const; | ||
| 83 | |||
| 84 | boost::optional<double> oilCoolerDesignFlowRate() const; | ||
| 85 | |||
| 86 | boost::optional<double> auxiliaryCoolingDesignFlowRate() const; | ||
| 87 | |||
| 88 | std::string endUseSubcategory() const; | ||
| 89 | bool isEndUseSubcategoryDefaulted() const; | ||
| 90 | |||
| 91 | //@} | ||
| 92 | /** @name Setters */ | ||
| 93 | //@{ | ||
| 94 | |||
| 95 | bool setRepresentationFile(const ExternalFile& externalFile); | ||
| 96 | |||
| 97 | bool setPerformanceInterpolationMethod(const std::string& performanceInterpolationMethod); | ||
| 98 | |||
| 99 | bool setRatedCapacity(double ratedCapacity); | ||
| 100 | void autosizeRatedCapacity(); | ||
| 101 | |||
| 102 | bool setSizingFactor(double sizingFactor); | ||
| 103 | |||
| 104 | // This is done via the setAmbientXXX methods | ||
| 105 | // bool setAmbientTemperatureIndicator(const std::string& ambientTemperatureIndicator); | ||
| 106 | |||
| 107 | /** This will make the Ambient Temperature Indicator = 'Schedule' */ | ||
| 108 | bool setAmbientTemperatureSchedule(Schedule& schedule); | ||
| 109 | /** This will reset the Ambient Temperature Indicator = 'Outdoors' */ | ||
| 110 | void resetAmbientTemperatureSchedule(); | ||
| 111 | |||
| 112 | /** This will make the Ambient Temperature Indicator = 'Zone' */ | ||
| 113 | bool setAmbientTemperatureZone(const ThermalZone& thermalZone); | ||
| 114 | /** This will reset the Ambient Temperature Indicator = 'Outdoors' */ | ||
| 115 | void resetAmbientTemperatureZone(); | ||
| 116 | |||
| 117 | /** This will make the Ambient Temperature Indicator = 'Outdoors' */ | ||
| 118 | bool setAmbientTemperatureOutdoorAirNodeName(const std::string& ambientTemperatureOutdoorAirNodeName); | ||
| 119 | /** This will reset the Ambient Temperature Indicator = 'Outdoors'. A default Outdoor Air Node Name will be used in the ForwardTranslator */ | ||
| 120 | void resetAmbientTemperatureOutdoorAirNodeName(); | ||
| 121 | |||
| 122 | bool setChilledWaterMaximumRequestedFlowRate(double chilledWaterMaximumRequestedFlowRate); | ||
| 123 | void autosizeChilledWaterMaximumRequestedFlowRate(); | ||
| 124 | |||
| 125 | bool setCondenserMaximumRequestedFlowRate(double condenserMaximumRequestedFlowRate); | ||
| 126 | void autosizeCondenserMaximumRequestedFlowRate(); | ||
| 127 | |||
| 128 | bool setChillerFlowMode(const std::string& chillerFlowMode); | ||
| 129 | |||
| 130 | bool setOilCoolerDesignFlowRate(double oilCoolerDesignFlowRate); | ||
| 131 | void resetOilCoolerDesignFlowRate(); | ||
| 132 | |||
| 133 | bool setAuxiliaryCoolingDesignFlowRate(double auxiliaryCoolingDesignFlowRate); | ||
| 134 | void resetAuxiliaryCoolingDesignFlowRate(); | ||
| 135 | |||
| 136 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 137 | void resetEndUseSubcategory(); | ||
| 138 | |||
| 139 | //@} | ||
| 140 | /** @name Other */ | ||
| 141 | //@{ | ||
| 142 | |||
| 143 | boost::optional<double> autosizedRatedCapacity(); | ||
| 144 | |||
| 145 | boost::optional<double> autosizedChilledWaterMaximumRequestedFlowRate(); | ||
| 146 | |||
| 147 | boost::optional<double> autosizedCondenserMaximumRequestedFlowRate(); | ||
| 148 | |||
| 149 | /** Convenience Function to return the Chilled Water Loop (chiller on supply) **/ | ||
| 150 | boost::optional<PlantLoop> chilledWaterLoop() const; | ||
| 151 | // Same as supplyInletModelObject, but cast to a Node | ||
| 152 | boost::optional<Node> chilledWaterInletNode() const; | ||
| 153 | boost::optional<Node> chilledWaterOutletNode() const; | ||
| 154 | |||
| 155 | /** Convenience Function to return the Condenser Water Loop (chiller on demand side) **/ | ||
| 156 | boost::optional<PlantLoop> condenserWaterLoop() const; | ||
| 157 | boost::optional<Node> condenserInletNode() const; | ||
| 158 | boost::optional<Node> condenserOutletNode() const; | ||
| 159 | |||
| 160 | // Not implemented in E+ 22.2.0, but reserved as a Tertiary Loop for now | ||
| 161 | boost::optional<PlantLoop> heatRecoveryLoop() const; | ||
| 162 | boost::optional<Node> heatRecoveryInletNode() const; | ||
| 163 | boost::optional<Node> heatRecoveryOutletNode() const; | ||
| 164 | |||
| 165 | unsigned oilCoolerInletPort() const; | ||
| 166 | boost::optional<ModelObject> oilCoolerInletModelObject() const; | ||
| 167 | boost::optional<Node> oilCoolerInletNode() const; | ||
| 168 | unsigned oilCoolerOutletPort() const; | ||
| 169 | boost::optional<ModelObject> oilCoolerOutletModelObject() const; | ||
| 170 | boost::optional<Node> oilCoolerOutletNode() const; | ||
| 171 | boost::optional<PlantLoop> oilCoolerLoop() const; | ||
| 172 | bool addDemandBranchOnOilCoolerLoop(PlantLoop& plantLoop); | ||
| 173 | bool addToOilCoolerLoopNode(Node& node); | ||
| 174 | bool removeFromOilCoolerLoop(); | ||
| 175 | |||
| 176 | unsigned auxiliaryInletPort() const; | ||
| 177 | boost::optional<ModelObject> auxiliaryInletModelObject() const; | ||
| 178 | boost::optional<Node> auxiliaryInletNode() const; | ||
| 179 | unsigned auxiliaryOutletPort() const; | ||
| 180 | boost::optional<ModelObject> auxiliaryOutletModelObject() const; | ||
| 181 | boost::optional<Node> auxiliaryOutletNode() const; | ||
| 182 | bool addDemandBranchOnAuxiliaryLoop(PlantLoop& plantLoop); | ||
| 183 | bool addToAuxiliaryLoopNode(Node& node); | ||
| 184 | bool removeFromAuxiliaryLoop(); | ||
| 185 | boost::optional<PlantLoop> auxiliaryLoop() const; | ||
| 186 | |||
| 187 | //@} | ||
| 188 | protected: | ||
| 189 | /// @cond | ||
| 190 | using ImplType = detail::ChillerElectricASHRAE205_Impl; | ||
| 191 | |||
| 192 | explicit ChillerElectricASHRAE205(std::shared_ptr<detail::ChillerElectricASHRAE205_Impl> impl); | ||
| 193 | |||
| 194 | friend class detail::ChillerElectricASHRAE205_Impl; | ||
| 195 | friend class Model; | ||
| 196 | friend class IdfObject; | ||
| 197 | friend class openstudio::detail::IdfObject_Impl; | ||
| 198 | /// @endcond | ||
| 199 | private: | ||
| 200 | − | REGISTER_LOGGER("openstudio.model.ChillerElectricASHRAE205"); | |
| 201 | }; | ||
| 202 | |||
| 203 | /** \relates ChillerElectricASHRAE205*/ | ||
| 204 | using OptionalChillerElectricASHRAE205 = boost::optional<ChillerElectricASHRAE205>; | ||
| 205 | |||
| 206 | /** \relates ChillerElectricASHRAE205*/ | ||
| 207 | using ChillerElectricASHRAE205Vector = std::vector<ChillerElectricASHRAE205>; | ||
| 208 | |||
| 209 | } // namespace model | ||
| 210 | } // namespace openstudio | ||
| 211 | |||
| 212 | #endif // MODEL_CHILLERELECTRICASHRAE205_HPP | ||
| 213 |