src/model/GeneratorFuelCellExhaustGasToWaterHeatExchanger.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_GENERATORFUELCELLEXHAUSTGASTOWATERHEATEXCHANGER_HPP | ||
| 7 | #define MODEL_GENERATORFUELCELLEXHAUSTGASTOWATERHEATEXCHANGER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Connection; | ||
| 17 | class Node; | ||
| 18 | class GeneratorFuelCell; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class GeneratorFuelCellExhaustGasToWaterHeatExchanger_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** GeneratorFuelCellExhaustGasToWaterHeatExchanger is a ModelObject that wraps the OpenStudio IDD object 'OS:Generator:FuelCell:ExhaustGasToWaterHeatExchanger'. */ | ||
| 27 | class MODEL_API GeneratorFuelCellExhaustGasToWaterHeatExchanger : public StraightComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit GeneratorFuelCellExhaustGasToWaterHeatExchanger(const Model& model); | ||
| 34 | |||
| 35 | explicit GeneratorFuelCellExhaustGasToWaterHeatExchanger(const Model& model, const Node& exhaustOutletAirNode); | ||
| 36 | |||
| 37 | 43 | virtual ~GeneratorFuelCellExhaustGasToWaterHeatExchanger() override = default; | |
| 38 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 39 | 7 | GeneratorFuelCellExhaustGasToWaterHeatExchanger(const GeneratorFuelCellExhaustGasToWaterHeatExchanger& other) = default; | |
| 40 | 15 | GeneratorFuelCellExhaustGasToWaterHeatExchanger(GeneratorFuelCellExhaustGasToWaterHeatExchanger&& other) = default; | |
| 41 | ✗ | GeneratorFuelCellExhaustGasToWaterHeatExchanger& operator=(const GeneratorFuelCellExhaustGasToWaterHeatExchanger&) = default; | |
| 42 | ✗ | GeneratorFuelCellExhaustGasToWaterHeatExchanger& operator=(GeneratorFuelCellExhaustGasToWaterHeatExchanger&&) = default; | |
| 43 | |||
| 44 | //@} | ||
| 45 | |||
| 46 | static IddObjectType iddObjectType(); | ||
| 47 | |||
| 48 | static std::vector<std::string> heatExchangerCalculationMethodValues(); | ||
| 49 | |||
| 50 | /** @name Getters */ | ||
| 51 | //@{ | ||
| 52 | |||
| 53 | double heatRecoveryWaterMaximumFlowRate() const; | ||
| 54 | |||
| 55 | boost::optional<Node> exhaustOutletAirNode() const; | ||
| 56 | |||
| 57 | std::string heatExchangerCalculationMethod() const; | ||
| 58 | |||
| 59 | boost::optional<double> method1HeatExchangerEffectiveness() const; | ||
| 60 | |||
| 61 | boost::optional<double> method2Parameterhxs0() const; | ||
| 62 | |||
| 63 | boost::optional<double> method2Parameterhxs1() const; | ||
| 64 | |||
| 65 | boost::optional<double> method2Parameterhxs2() const; | ||
| 66 | |||
| 67 | boost::optional<double> method2Parameterhxs3() const; | ||
| 68 | |||
| 69 | boost::optional<double> method2Parameterhxs4() const; | ||
| 70 | |||
| 71 | boost::optional<double> method3h0GasCoefficient() const; | ||
| 72 | |||
| 73 | boost::optional<double> method3NdotGasRefCoefficient() const; | ||
| 74 | |||
| 75 | boost::optional<double> method3nCoefficient() const; | ||
| 76 | |||
| 77 | boost::optional<double> method3GasArea() const; | ||
| 78 | |||
| 79 | boost::optional<double> method3h0WaterCoefficient() const; | ||
| 80 | |||
| 81 | boost::optional<double> method3NdotWaterrefCoefficient() const; | ||
| 82 | |||
| 83 | boost::optional<double> method3mCoefficient() const; | ||
| 84 | |||
| 85 | boost::optional<double> method3WaterArea() const; | ||
| 86 | |||
| 87 | boost::optional<double> method3FAdjustmentFactor() const; | ||
| 88 | |||
| 89 | boost::optional<double> method4hxl1Coefficient() const; | ||
| 90 | |||
| 91 | boost::optional<double> method4hxl2Coefficient() const; | ||
| 92 | |||
| 93 | boost::optional<double> method4CondensationThreshold() const; | ||
| 94 | |||
| 95 | // Return optional parent generator | ||
| 96 | boost::optional<GeneratorFuelCell> fuelCell() const; | ||
| 97 | |||
| 98 | //@} | ||
| 99 | /** @name Setters */ | ||
| 100 | //@{ | ||
| 101 | |||
| 102 | bool setHeatRecoveryWaterMaximumFlowRate(double heatRecoveryWaterMaximumFlowRate); | ||
| 103 | |||
| 104 | void resetHeatRecoveryWaterMaximumFlowRate(); | ||
| 105 | |||
| 106 | bool setExhaustOutletAirNode(const Node& node); | ||
| 107 | |||
| 108 | void resetExhaustOutletAirNode(); | ||
| 109 | |||
| 110 | bool setHeatExchangerCalculationMethod(const std::string& heatExchangerCalculationMethod); | ||
| 111 | |||
| 112 | void resetHeatExchangerCalculationMethod(); | ||
| 113 | |||
| 114 | bool setMethod1HeatExchangerEffectiveness(double method1HeatExchangerEffectiveness); | ||
| 115 | |||
| 116 | void resetMethod1HeatExchangerEffectiveness(); | ||
| 117 | |||
| 118 | bool setMethod2Parameterhxs0(double method2Parameterhxs0); | ||
| 119 | |||
| 120 | void resetMethod2Parameterhxs0(); | ||
| 121 | |||
| 122 | bool setMethod2Parameterhxs1(double method2Parameterhxs1); | ||
| 123 | |||
| 124 | void resetMethod2Parameterhxs1(); | ||
| 125 | |||
| 126 | bool setMethod2Parameterhxs2(double method2Parameterhxs2); | ||
| 127 | |||
| 128 | void resetMethod2Parameterhxs2(); | ||
| 129 | |||
| 130 | bool setMethod2Parameterhxs3(double method2Parameterhxs3); | ||
| 131 | |||
| 132 | void resetMethod2Parameterhxs3(); | ||
| 133 | |||
| 134 | bool setMethod2Parameterhxs4(double method2Parameterhxs4); | ||
| 135 | |||
| 136 | void resetMethod2Parameterhxs4(); | ||
| 137 | |||
| 138 | bool setMethod3h0GasCoefficient(double method3h0GasCoefficient); | ||
| 139 | |||
| 140 | void resetMethod3h0GasCoefficient(); | ||
| 141 | |||
| 142 | bool setMethod3NdotGasRefCoefficient(double method3NdotGasRefCoefficient); | ||
| 143 | |||
| 144 | void resetMethod3NdotGasRefCoefficient(); | ||
| 145 | |||
| 146 | bool setMethod3nCoefficient(double method3nCoefficient); | ||
| 147 | |||
| 148 | void resetMethod3nCoefficient(); | ||
| 149 | |||
| 150 | bool setMethod3GasArea(double method3GasArea); | ||
| 151 | |||
| 152 | void resetMethod3GasArea(); | ||
| 153 | |||
| 154 | bool setMethod3h0WaterCoefficient(double method3h0WaterCoefficient); | ||
| 155 | |||
| 156 | void resetMethod3h0WaterCoefficient(); | ||
| 157 | |||
| 158 | bool setMethod3NdotWaterrefCoefficient(double method3NdotWaterrefCoefficient); | ||
| 159 | |||
| 160 | void resetMethod3NdotWaterrefCoefficient(); | ||
| 161 | |||
| 162 | bool setMethod3mCoefficient(double method3mCoefficient); | ||
| 163 | |||
| 164 | void resetMethod3mCoefficient(); | ||
| 165 | |||
| 166 | bool setMethod3WaterArea(double method3WaterArea); | ||
| 167 | |||
| 168 | void resetMethod3WaterArea(); | ||
| 169 | |||
| 170 | bool setMethod3FAdjustmentFactor(double method3FAdjustmentFactor); | ||
| 171 | |||
| 172 | void resetMethod3FAdjustmentFactor(); | ||
| 173 | |||
| 174 | bool setMethod4hxl1Coefficient(double method4hxl1Coefficient); | ||
| 175 | |||
| 176 | void resetMethod4hxl1Coefficient(); | ||
| 177 | |||
| 178 | bool setMethod4hxl2Coefficient(double method4hxl2Coefficient); | ||
| 179 | |||
| 180 | void resetMethod4hxl2Coefficient(); | ||
| 181 | |||
| 182 | bool setMethod4CondensationThreshold(double method4CondensationThreshold); | ||
| 183 | |||
| 184 | void resetMethod4CondensationThreshold(); | ||
| 185 | |||
| 186 | //@} | ||
| 187 | /** @name Other */ | ||
| 188 | //@{ | ||
| 189 | |||
| 190 | //@} | ||
| 191 | protected: | ||
| 192 | /// @cond | ||
| 193 | using ImplType = detail::GeneratorFuelCellExhaustGasToWaterHeatExchanger_Impl; | ||
| 194 | |||
| 195 | explicit GeneratorFuelCellExhaustGasToWaterHeatExchanger(std::shared_ptr<detail::GeneratorFuelCellExhaustGasToWaterHeatExchanger_Impl> impl); | ||
| 196 | |||
| 197 | friend class detail::GeneratorFuelCellExhaustGasToWaterHeatExchanger_Impl; | ||
| 198 | friend class Model; | ||
| 199 | friend class IdfObject; | ||
| 200 | friend class openstudio::detail::IdfObject_Impl; | ||
| 201 | /// @endcond | ||
| 202 | private: | ||
| 203 | REGISTER_LOGGER("openstudio.model.GeneratorFuelCellExhaustGasToWaterHeatExchanger"); | ||
| 204 | }; | ||
| 205 | |||
| 206 | /** \relates GeneratorFuelCellExhaustGasToWaterHeatExchanger*/ | ||
| 207 | using OptionalGeneratorFuelCellExhaustGasToWaterHeatExchanger = boost::optional<GeneratorFuelCellExhaustGasToWaterHeatExchanger>; | ||
| 208 | |||
| 209 | /** \relates GeneratorFuelCellExhaustGasToWaterHeatExchanger*/ | ||
| 210 | using GeneratorFuelCellExhaustGasToWaterHeatExchangerVector = std::vector<GeneratorFuelCellExhaustGasToWaterHeatExchanger>; | ||
| 211 | |||
| 212 | } // namespace model | ||
| 213 | } // namespace openstudio | ||
| 214 | |||
| 215 | #endif // MODEL_GENERATORFUELCELLEXHAUSTGASTOWATERHEATEXCHANGER_HPP | ||
| 216 |