src/model/HeatExchangerFluidToFluid.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_HEATEXCHANGERFLUIDTOFLUID_HPP | ||
| 7 | #define MODEL_HEATEXCHANGERFLUIDTOFLUID_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "WaterToWaterComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class Node; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class HeatExchangerFluidToFluid_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** HeatExchangerFluidToFluid is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:HeatExchanger:FluidToFluid'. */ | ||
| 26 | class MODEL_API HeatExchangerFluidToFluid : public WaterToWaterComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit HeatExchangerFluidToFluid(const Model& model); | ||
| 33 | |||
| 34 | 10 | virtual ~HeatExchangerFluidToFluid() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | ✗ | HeatExchangerFluidToFluid(const HeatExchangerFluidToFluid& other) = default; | |
| 37 | ✗ | HeatExchangerFluidToFluid(HeatExchangerFluidToFluid&& other) = default; | |
| 38 | ✗ | HeatExchangerFluidToFluid& operator=(const HeatExchangerFluidToFluid&) = default; | |
| 39 | ✗ | HeatExchangerFluidToFluid& operator=(HeatExchangerFluidToFluid&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | static std::vector<std::string> heatExchangeModelTypeValues(); | ||
| 46 | |||
| 47 | static std::vector<std::string> controlTypeValues(); | ||
| 48 | |||
| 49 | static std::vector<std::string> heatTransferMeteringEndUseTypeValues(); | ||
| 50 | |||
| 51 | static std::vector<std::string> componentOverrideCoolingControlTemperatureModeValues(); | ||
| 52 | |||
| 53 | /** @name Getters */ | ||
| 54 | //@{ | ||
| 55 | |||
| 56 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 57 | |||
| 58 | boost::optional<double> loopDemandSideDesignFlowRate() const; | ||
| 59 | |||
| 60 | bool isLoopDemandSideDesignFlowRateAutosized() const; | ||
| 61 | |||
| 62 | boost::optional<double> loopSupplySideDesignFlowRate() const; | ||
| 63 | |||
| 64 | bool isLoopSupplySideDesignFlowRateAutosized() const; | ||
| 65 | |||
| 66 | std::string heatExchangeModelType() const; | ||
| 67 | |||
| 68 | bool isHeatExchangeModelTypeDefaulted() const; | ||
| 69 | |||
| 70 | boost::optional<double> heatExchangerUFactorTimesAreaValue() const; | ||
| 71 | |||
| 72 | bool isHeatExchangerUFactorTimesAreaValueAutosized() const; | ||
| 73 | |||
| 74 | std::string controlType() const; | ||
| 75 | |||
| 76 | bool isControlTypeDefaulted() const; | ||
| 77 | |||
| 78 | double minimumTemperatureDifferencetoActivateHeatExchanger() const; | ||
| 79 | |||
| 80 | bool isMinimumTemperatureDifferencetoActivateHeatExchangerDefaulted() const; | ||
| 81 | |||
| 82 | std::string heatTransferMeteringEndUseType() const; | ||
| 83 | |||
| 84 | bool isHeatTransferMeteringEndUseTypeDefaulted() const; | ||
| 85 | |||
| 86 | boost::optional<Node> componentOverrideLoopSupplySideInletNode() const; | ||
| 87 | |||
| 88 | boost::optional<Node> componentOverrideLoopDemandSideInletNode() const; | ||
| 89 | |||
| 90 | std::string componentOverrideCoolingControlTemperatureMode() const; | ||
| 91 | |||
| 92 | bool isComponentOverrideCoolingControlTemperatureModeDefaulted() const; | ||
| 93 | |||
| 94 | double sizingFactor() const; | ||
| 95 | |||
| 96 | bool isSizingFactorDefaulted() const; | ||
| 97 | |||
| 98 | boost::optional<double> operationMinimumTemperatureLimit() const; | ||
| 99 | |||
| 100 | boost::optional<double> operationMaximumTemperatureLimit() const; | ||
| 101 | |||
| 102 | //@} | ||
| 103 | /** @name Setters */ | ||
| 104 | //@{ | ||
| 105 | |||
| 106 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 107 | |||
| 108 | void resetAvailabilitySchedule(); | ||
| 109 | |||
| 110 | bool setLoopDemandSideDesignFlowRate(double loopDemandSideDesignFlowRate); | ||
| 111 | |||
| 112 | void autosizeLoopDemandSideDesignFlowRate(); | ||
| 113 | |||
| 114 | bool setLoopSupplySideDesignFlowRate(double loopSupplySideDesignFlowRate); | ||
| 115 | |||
| 116 | void autosizeLoopSupplySideDesignFlowRate(); | ||
| 117 | |||
| 118 | bool setHeatExchangeModelType(const std::string& heatExchangeModelType); | ||
| 119 | |||
| 120 | void resetHeatExchangeModelType(); | ||
| 121 | |||
| 122 | bool setHeatExchangerUFactorTimesAreaValue(double heatExchangerUFactorTimesAreaValue); | ||
| 123 | |||
| 124 | void autosizeHeatExchangerUFactorTimesAreaValue(); | ||
| 125 | |||
| 126 | bool setControlType(const std::string& controlType); | ||
| 127 | |||
| 128 | void resetControlType(); | ||
| 129 | |||
| 130 | bool setMinimumTemperatureDifferencetoActivateHeatExchanger(double minimumTemperatureDifferencetoActivateHeatExchanger); | ||
| 131 | |||
| 132 | void resetMinimumTemperatureDifferencetoActivateHeatExchanger(); | ||
| 133 | |||
| 134 | bool setHeatTransferMeteringEndUseType(const std::string& heatTransferMeteringEndUseType); | ||
| 135 | |||
| 136 | void resetHeatTransferMeteringEndUseType(); | ||
| 137 | |||
| 138 | bool setComponentOverrideLoopSupplySideInletNode(const Node& node); | ||
| 139 | |||
| 140 | void resetComponentOverrideLoopSupplySideInletNode(); | ||
| 141 | |||
| 142 | bool setComponentOverrideLoopDemandSideInletNode(const Node& node); | ||
| 143 | |||
| 144 | void resetComponentOverrideLoopDemandSideInletNode(); | ||
| 145 | |||
| 146 | bool setComponentOverrideCoolingControlTemperatureMode(const std::string& componentOverrideCoolingControlTemperatureMode); | ||
| 147 | |||
| 148 | void resetComponentOverrideCoolingControlTemperatureMode(); | ||
| 149 | |||
| 150 | bool setSizingFactor(double sizingFactor); | ||
| 151 | |||
| 152 | void resetSizingFactor(); | ||
| 153 | |||
| 154 | bool setOperationMinimumTemperatureLimit(double operationMinimumTemperatureLimit); | ||
| 155 | |||
| 156 | void resetOperationMinimumTemperatureLimit(); | ||
| 157 | |||
| 158 | bool setOperationMaximumTemperatureLimit(double operationMaximumTemperatureLimit); | ||
| 159 | |||
| 160 | void resetOperationMaximumTemperatureLimit(); | ||
| 161 | |||
| 162 | //@} | ||
| 163 | /** @name Other */ | ||
| 164 | //@{ | ||
| 165 | |||
| 166 | boost::optional<double> autosizedLoopDemandSideDesignFlowRate() const; | ||
| 167 | |||
| 168 | boost::optional<double> autosizedLoopSupplySideDesignFlowRate() const; | ||
| 169 | |||
| 170 | boost::optional<double> autosizedHeatExchangerUFactorTimesAreaValue() const; | ||
| 171 | |||
| 172 | //@} | ||
| 173 | protected: | ||
| 174 | /// @cond | ||
| 175 | using ImplType = detail::HeatExchangerFluidToFluid_Impl; | ||
| 176 | |||
| 177 | explicit HeatExchangerFluidToFluid(std::shared_ptr<detail::HeatExchangerFluidToFluid_Impl> impl); | ||
| 178 | |||
| 179 | friend class detail::HeatExchangerFluidToFluid_Impl; | ||
| 180 | friend class Model; | ||
| 181 | friend class IdfObject; | ||
| 182 | friend class openstudio::detail::IdfObject_Impl; | ||
| 183 | /// @endcond | ||
| 184 | private: | ||
| 185 | REGISTER_LOGGER("openstudio.model.HeatExchangerFluidToFluid"); | ||
| 186 | }; | ||
| 187 | |||
| 188 | /** \relates HeatExchangerFluidToFluid*/ | ||
| 189 | using OptionalHeatExchangerFluidToFluid = boost::optional<HeatExchangerFluidToFluid>; | ||
| 190 | |||
| 191 | /** \relates HeatExchangerFluidToFluid*/ | ||
| 192 | using HeatExchangerFluidToFluidVector = std::vector<HeatExchangerFluidToFluid>; | ||
| 193 | |||
| 194 | } // namespace model | ||
| 195 | } // namespace openstudio | ||
| 196 | |||
| 197 | #endif // MODEL_HEATEXCHANGERFLUIDTOFLUID_HPP | ||
| 198 |