src/model/GeneratorMicroTurbineHeatRecovery_Impl.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_IMPL_HPP | ||
| 7 | #define MODEL_GENERATORMICROTURBINEHEATRECOVERY_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | // TODO: Check the following class names against object getters and setters. | ||
| 17 | class Curve; | ||
| 18 | class GeneratorMicroTurbine; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class MODEL_API GeneratorMicroTurbineHeatRecovery_Impl : public StraightComponent_Impl | ||
| 23 | { | ||
| 24 | |||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | GeneratorMicroTurbineHeatRecovery_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | GeneratorMicroTurbineHeatRecovery_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | GeneratorMicroTurbineHeatRecovery_Impl(const GeneratorMicroTurbineHeatRecovery_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 15 | virtual ~GeneratorMicroTurbineHeatRecovery_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Virtual Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 42 | |||
| 43 | virtual IddObjectType iddObjectType() const override; | ||
| 44 | |||
| 45 | virtual unsigned inletPort() const override; | ||
| 46 | |||
| 47 | virtual unsigned outletPort() const override; | ||
| 48 | |||
| 49 | virtual bool addToNode(Node& node) override; | ||
| 50 | |||
| 51 | virtual ComponentType componentType() const override; | ||
| 52 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 53 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 54 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 55 | |||
| 56 | // DLM: consider reimplementing any other virtual methods of StraightComponent or HVACComponent | ||
| 57 | |||
| 58 | //@} | ||
| 59 | /** @name Getters */ | ||
| 60 | //@{ | ||
| 61 | |||
| 62 | //boost::optional<Connection> heatRecoveryWaterInletNode() const; | ||
| 63 | |||
| 64 | //boost::optional<Connection> heatRecoveryWaterOutletNode() const; | ||
| 65 | |||
| 66 | // TODO: I might need to make this one default to something that makes sense... | ||
| 67 | double referenceThermalEfficiencyUsingLowerHeatValue() const; | ||
| 68 | bool isReferenceThermalEfficiencyUsingLowerHeatValueDefaulted() const; | ||
| 69 | |||
| 70 | double referenceInletWaterTemperature() const; | ||
| 71 | |||
| 72 | std::string heatRecoveryWaterFlowOperatingMode() const; | ||
| 73 | bool isHeatRecoveryWaterFlowOperatingModeDefaulted() const; | ||
| 74 | |||
| 75 | double referenceHeatRecoveryWaterFlowRate() const; | ||
| 76 | |||
| 77 | // BiquadraticCurves, BiVariateTables. | ||
| 78 | boost::optional<Curve> heatRecoveryWaterFlowRateFunctionofTemperatureandPowerCurve() const; | ||
| 79 | |||
| 80 | // BicubicBiquadraticCurves, BiVariateTables. | ||
| 81 | boost::optional<Curve> thermalEfficiencyFunctionofTemperatureandElevationCurve() const; | ||
| 82 | |||
| 83 | // QuadraticCubicCurves, UniVariateTables. | ||
| 84 | boost::optional<Curve> heatRecoveryRateFunctionofPartLoadRatioCurve() const; | ||
| 85 | |||
| 86 | //QuadraticCurves, UniVariateTables. | ||
| 87 | boost::optional<Curve> heatRecoveryRateFunctionofInletWaterTemperatureCurve() const; | ||
| 88 | |||
| 89 | // QuadraticCurves, UniVariateTables. | ||
| 90 | boost::optional<Curve> heatRecoveryRateFunctionofWaterFlowRateCurve() const; | ||
| 91 | |||
| 92 | double minimumHeatRecoveryWaterFlowRate() const; | ||
| 93 | bool isMinimumHeatRecoveryWaterFlowRateDefaulted() const; | ||
| 94 | |||
| 95 | double maximumHeatRecoveryWaterFlowRate() const; | ||
| 96 | bool isMaximumHeatRecoveryWaterFlowRateDefaulted() const; | ||
| 97 | |||
| 98 | boost::optional<double> maximumHeatRecoveryWaterTemperature() const; | ||
| 99 | |||
| 100 | double ratedThermaltoElectricalPowerRatio() const; | ||
| 101 | bool isRatedThermaltoElectricalPowerRatioDefaulted() const; | ||
| 102 | |||
| 103 | // Return parent generator | ||
| 104 | GeneratorMicroTurbine generatorMicroTurbine() const; | ||
| 105 | |||
| 106 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 107 | |||
| 108 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 109 | |||
| 110 | //@} | ||
| 111 | /** @name Setters */ | ||
| 112 | //@{ | ||
| 113 | |||
| 114 | // TODO: Check argument type. From object lists, some candidates are: Connection. | ||
| 115 | //bool setHeatRecoveryWaterInletNode(const Connection& connection); | ||
| 116 | //void resetHeatRecoveryWaterInletNode(); | ||
| 117 | |||
| 118 | // TODO: Check argument type. From object lists, some candidates are: Connection. | ||
| 119 | //bool setHeatRecoveryWaterOutletNode(const Connection& connection); | ||
| 120 | //void resetHeatRecoveryWaterOutletNode(); | ||
| 121 | |||
| 122 | bool setReferenceThermalEfficiencyUsingLowerHeatValue(double referenceThermalEfficiencyUsingLowerHeatValue); | ||
| 123 | void resetReferenceThermalEfficiencyUsingLowerHeatValue(); | ||
| 124 | |||
| 125 | bool setReferenceInletWaterTemperature(double referenceInletWaterTemperature); | ||
| 126 | |||
| 127 | bool setHeatRecoveryWaterFlowOperatingMode(const std::string& heatRecoveryWaterFlowOperatingMode); | ||
| 128 | void resetHeatRecoveryWaterFlowOperatingMode(); | ||
| 129 | |||
| 130 | bool setReferenceHeatRecoveryWaterFlowRate(double referenceHeatRecoveryWaterFlowRate); | ||
| 131 | |||
| 132 | // BiquadraticCurves, BiVariateTables. | ||
| 133 | bool setHeatRecoveryWaterFlowRateFunctionofTemperatureandPowerCurve(const Curve& heatRecoveryWaterFlowRateFunctionofTemperatureandPowerCurve); | ||
| 134 | void resetHeatRecoveryWaterFlowRateFunctionofTemperatureandPowerCurve(); | ||
| 135 | |||
| 136 | // BicubicBiquadraticCurves, BiVariateTables. | ||
| 137 | bool setThermalEfficiencyFunctionofTemperatureandElevationCurve(const Curve& thermalEfficiencyFunctionofTemperatureandElevationCurve); | ||
| 138 | void resetThermalEfficiencyFunctionofTemperatureandElevationCurve(); | ||
| 139 | |||
| 140 | // QuadraticCubicCurves, UniVariateTables. | ||
| 141 | bool setHeatRecoveryRateFunctionofPartLoadRatioCurve(const Curve& heatRecoveryRateFunctionofPartLoadRatioCurve); | ||
| 142 | void resetHeatRecoveryRateFunctionofPartLoadRatioCurve(); | ||
| 143 | |||
| 144 | // QuadraticCurves, UniVariateTables. | ||
| 145 | bool setHeatRecoveryRateFunctionofInletWaterTemperatureCurve(const Curve& heatRecoveryRateFunctionofInletWaterTemperatureCurve); | ||
| 146 | void resetHeatRecoveryRateFunctionofInletWaterTemperatureCurve(); | ||
| 147 | |||
| 148 | // QuadraticCurves, UniVariateTables. | ||
| 149 | bool setHeatRecoveryRateFunctionofWaterFlowRateCurve(const Curve& heatRecoveryRateFunctionofWaterFlowRateCurve); | ||
| 150 | void resetHeatRecoveryRateFunctionofWaterFlowRateCurve(); | ||
| 151 | |||
| 152 | bool setMinimumHeatRecoveryWaterFlowRate(double minimumHeatRecoveryWaterFlowRate); | ||
| 153 | void resetMinimumHeatRecoveryWaterFlowRate(); | ||
| 154 | |||
| 155 | bool setMaximumHeatRecoveryWaterFlowRate(double maximumHeatRecoveryWaterFlowRate); | ||
| 156 | void resetMaximumHeatRecoveryWaterFlowRate(); | ||
| 157 | |||
| 158 | bool setMaximumHeatRecoveryWaterTemperature(double maximumHeatRecoveryWaterTemperature); | ||
| 159 | void resetMaximumHeatRecoveryWaterTemperature(); | ||
| 160 | |||
| 161 | bool setRatedThermaltoElectricalPowerRatio(double ratedThermaltoElectricalPowerRatio); | ||
| 162 | void resetRatedThermaltoElectricalPowerRatio(); | ||
| 163 | |||
| 164 | //@} | ||
| 165 | /** @name Other */ | ||
| 166 | //@{ | ||
| 167 | |||
| 168 | ModelObject clone(Model model) const override; | ||
| 169 | |||
| 170 | std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 171 | |||
| 172 | std::vector<ModelObject> children() const override; | ||
| 173 | |||
| 174 | //@} | ||
| 175 | protected: | ||
| 176 | private: | ||
| 177 | REGISTER_LOGGER("openstudio.model.GeneratorMicroTurbineHeatRecovery"); | ||
| 178 | }; | ||
| 179 | |||
| 180 | } // namespace detail | ||
| 181 | |||
| 182 | } // namespace model | ||
| 183 | } // namespace openstudio | ||
| 184 | |||
| 185 | #endif // MODEL_GENERATORMICROTURBINEHEATRECOVERY_IMPL_HPP | ||
| 186 |