src/model/GeneratorMicroTurbineHeatRecovery.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_GENERATORMICROTURBINEHEATRECOVERY_HPP | ||
| 7 | #define MODEL_GENERATORMICROTURBINEHEATRECOVERY_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | // TODO: Check the following class names against object getters and setters. | ||
| 16 | class Curve; | ||
| 17 | class GeneratorMicroTurbine; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class GeneratorMicroTurbineHeatRecovery_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** GeneratorMicroTurbineHeatRecovery is a StraightComponent that wraps the OpenStudio IDD object 'OS:Generator:MicroTurbine:HeatRecovery'. */ | ||
| 26 | class MODEL_API GeneratorMicroTurbineHeatRecovery : public StraightComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | // Constructs a new GeneratorMicroTurbineHeatRecovery object in the model, given a GeneratorMicroTurbine | ||
| 33 | explicit GeneratorMicroTurbineHeatRecovery(const Model& model, GeneratorMicroTurbine& mchp); | ||
| 34 | |||
| 35 | 94 | virtual ~GeneratorMicroTurbineHeatRecovery() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | 3 | GeneratorMicroTurbineHeatRecovery(const GeneratorMicroTurbineHeatRecovery& other) = default; | |
| 38 | 52 | GeneratorMicroTurbineHeatRecovery(GeneratorMicroTurbineHeatRecovery&& other) = default; | |
| 39 | ✗ | GeneratorMicroTurbineHeatRecovery& operator=(const GeneratorMicroTurbineHeatRecovery&) = default; | |
| 40 | ✗ | GeneratorMicroTurbineHeatRecovery& operator=(GeneratorMicroTurbineHeatRecovery&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | static std::vector<std::string> validHeatRecoveryWaterFlowOperatingModeValues(); | ||
| 47 | |||
| 48 | /** @name Getters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | // TODO: Check return type. From object lists, some candidates are: Connection. | ||
| 52 | // boost::optional<Connection> heatRecoveryWaterInletNode() const; | ||
| 53 | |||
| 54 | // TODO: Check return type. From object lists, some candidates are: Connection. | ||
| 55 | // boost::optional<Connection> heatRecoveryWaterOutletNode() const; | ||
| 56 | |||
| 57 | double referenceThermalEfficiencyUsingLowerHeatValue() const; | ||
| 58 | bool isReferenceThermalEfficiencyUsingLowerHeatValueDefaulted() const; | ||
| 59 | |||
| 60 | double referenceInletWaterTemperature() const; | ||
| 61 | |||
| 62 | std::string heatRecoveryWaterFlowOperatingMode() const; | ||
| 63 | bool isHeatRecoveryWaterFlowOperatingModeDefaulted() const; | ||
| 64 | |||
| 65 | double referenceHeatRecoveryWaterFlowRate() const; | ||
| 66 | |||
| 67 | // TODO: Check return type. From object lists, some candidates are: BiquadraticCurves, BiVariateTables. | ||
| 68 | boost::optional<Curve> heatRecoveryWaterFlowRateFunctionofTemperatureandPowerCurve() const; | ||
| 69 | |||
| 70 | // TODO: Check return type. From object lists, some candidates are: BicubicBiquadraticCurves, BiVariateTables. | ||
| 71 | boost::optional<Curve> thermalEfficiencyFunctionofTemperatureandElevationCurve() const; | ||
| 72 | |||
| 73 | // TODO: Check return type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 74 | boost::optional<Curve> heatRecoveryRateFunctionofPartLoadRatioCurve() const; | ||
| 75 | |||
| 76 | // TODO: Check return type. From object lists, some candidates are: QuadraticCurves, UniVariateTables. | ||
| 77 | boost::optional<Curve> heatRecoveryRateFunctionofInletWaterTemperatureCurve() const; | ||
| 78 | |||
| 79 | // TODO: Check return type. From object lists, some candidates are: QuadraticCurves, UniVariateTables. | ||
| 80 | boost::optional<Curve> heatRecoveryRateFunctionofWaterFlowRateCurve() const; | ||
| 81 | |||
| 82 | double minimumHeatRecoveryWaterFlowRate() const; | ||
| 83 | bool isMinimumHeatRecoveryWaterFlowRateDefaulted() const; | ||
| 84 | |||
| 85 | double maximumHeatRecoveryWaterFlowRate() const; | ||
| 86 | bool isMaximumHeatRecoveryWaterFlowRateDefaulted() const; | ||
| 87 | |||
| 88 | boost::optional<double> maximumHeatRecoveryWaterTemperature() const; | ||
| 89 | |||
| 90 | double ratedThermaltoElectricalPowerRatio() const; | ||
| 91 | bool isRatedThermaltoElectricalPowerRatioDefaulted() const; | ||
| 92 | |||
| 93 | // Return parent generator | ||
| 94 | GeneratorMicroTurbine generatorMicroTurbine() const; | ||
| 95 | |||
| 96 | //@} | ||
| 97 | /** @name Setters */ | ||
| 98 | //@{ | ||
| 99 | |||
| 100 | // TODO: Check argument type. From object lists, some candidates are: Connection. | ||
| 101 | //bool setHeatRecoveryWaterInletNode(const Connection& connection); | ||
| 102 | //void resetHeatRecoveryWaterInletNode(); | ||
| 103 | |||
| 104 | // TODO: Check argument type. From object lists, some candidates are: Connection. | ||
| 105 | //bool setHeatRecoveryWaterOutletNode(const Connection& connection); | ||
| 106 | //void resetHeatRecoveryWaterOutletNode(); | ||
| 107 | |||
| 108 | bool setReferenceThermalEfficiencyUsingLowerHeatValue(double referenceThermalEfficiencyUsingLowerHeatValue); | ||
| 109 | void resetReferenceThermalEfficiencyUsingLowerHeatValue(); | ||
| 110 | |||
| 111 | bool setReferenceInletWaterTemperature(double referenceInletWaterTemperature); | ||
| 112 | |||
| 113 | bool setHeatRecoveryWaterFlowOperatingMode(const std::string& heatRecoveryWaterFlowOperatingMode); | ||
| 114 | void resetHeatRecoveryWaterFlowOperatingMode(); | ||
| 115 | |||
| 116 | bool setReferenceHeatRecoveryWaterFlowRate(double referenceHeatRecoveryWaterFlowRate); | ||
| 117 | //void resetReferenceHeatRecoveryWaterFlowRate(); | ||
| 118 | |||
| 119 | // TODO: Check argument type. From object lists, some candidates are: BiquadraticCurves, BiVariateTables. | ||
| 120 | bool setHeatRecoveryWaterFlowRateFunctionofTemperatureandPowerCurve(const Curve& heatRecoveryWaterFlowRateFunctionofTemperatureandPowerCurve); | ||
| 121 | void resetHeatRecoveryWaterFlowRateFunctionofTemperatureandPowerCurve(); | ||
| 122 | |||
| 123 | // TODO: Check argument type. From object lists, some candidates are: BicubicBiquadraticCurves, BiVariateTables. | ||
| 124 | bool setThermalEfficiencyFunctionofTemperatureandElevationCurve(const Curve& thermalEfficiencyFunctionofTemperatureandElevationCurve); | ||
| 125 | void resetThermalEfficiencyFunctionofTemperatureandElevationCurve(); | ||
| 126 | |||
| 127 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 128 | bool setHeatRecoveryRateFunctionofPartLoadRatioCurve(const Curve& heatRecoveryRateFunctionofPartLoadRatioCurve); | ||
| 129 | void resetHeatRecoveryRateFunctionofPartLoadRatioCurve(); | ||
| 130 | |||
| 131 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCurves, UniVariateTables. | ||
| 132 | bool setHeatRecoveryRateFunctionofInletWaterTemperatureCurve(const Curve& heatRecoveryRateFunctionofInletWaterTemperatureCurve); | ||
| 133 | void resetHeatRecoveryRateFunctionofInletWaterTemperatureCurve(); | ||
| 134 | |||
| 135 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCurves, UniVariateTables. | ||
| 136 | bool setHeatRecoveryRateFunctionofWaterFlowRateCurve(const Curve& heatRecoveryRateFunctionofWaterFlowRateCurve); | ||
| 137 | void resetHeatRecoveryRateFunctionofWaterFlowRateCurve(); | ||
| 138 | |||
| 139 | bool setMinimumHeatRecoveryWaterFlowRate(double minimumHeatRecoveryWaterFlowRate); | ||
| 140 | void resetMinimumHeatRecoveryWaterFlowRate(); | ||
| 141 | |||
| 142 | bool setMaximumHeatRecoveryWaterFlowRate(double maximumHeatRecoveryWaterFlowRate); | ||
| 143 | void resetMaximumHeatRecoveryWaterFlowRate(); | ||
| 144 | |||
| 145 | bool setMaximumHeatRecoveryWaterTemperature(double maximumHeatRecoveryWaterTemperature); | ||
| 146 | void resetMaximumHeatRecoveryWaterTemperature(); | ||
| 147 | |||
| 148 | bool setRatedThermaltoElectricalPowerRatio(double ratedThermaltoElectricalPowerRatio); | ||
| 149 | void resetRatedThermaltoElectricalPowerRatio(); | ||
| 150 | |||
| 151 | //@} | ||
| 152 | /** @name Other */ | ||
| 153 | //@{ | ||
| 154 | |||
| 155 | //@} | ||
| 156 | protected: | ||
| 157 | /// @cond | ||
| 158 | using ImplType = detail::GeneratorMicroTurbineHeatRecovery_Impl; | ||
| 159 | |||
| 160 | explicit GeneratorMicroTurbineHeatRecovery(std::shared_ptr<detail::GeneratorMicroTurbineHeatRecovery_Impl> impl); | ||
| 161 | |||
| 162 | friend class detail::GeneratorMicroTurbineHeatRecovery_Impl; | ||
| 163 | friend class Model; | ||
| 164 | friend class IdfObject; | ||
| 165 | friend class openstudio::detail::IdfObject_Impl; | ||
| 166 | /// @endcond | ||
| 167 | private: | ||
| 168 | REGISTER_LOGGER("openstudio.model.GeneratorMicroTurbineHeatRecovery"); | ||
| 169 | }; | ||
| 170 | |||
| 171 | /** \relates GeneratorMicroTurbineHeatRecovery*/ | ||
| 172 | using OptionalGeneratorMicroTurbineHeatRecovery = boost::optional<GeneratorMicroTurbineHeatRecovery>; | ||
| 173 | |||
| 174 | /** \relates GeneratorMicroTurbineHeatRecovery*/ | ||
| 175 | using GeneratorMicroTurbineHeatRecoveryVector = std::vector<GeneratorMicroTurbineHeatRecovery>; | ||
| 176 | |||
| 177 | } // namespace model | ||
| 178 | } // namespace openstudio | ||
| 179 | |||
| 180 | #endif // MODEL_GENERATORMICROTURBINEHEATRECOVERY_HPP | ||
| 181 |