src/model/GeneratorMicroTurbine.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_GENERATORMICROTURBINE_HPP | ||
| 7 | #define MODEL_GENERATORMICROTURBINE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Generator.hpp" | ||
| 11 | #include "GeneratorMicroTurbineHeatRecovery.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | class Curve; | ||
| 18 | // For the optional Generator:MicroTurbine:HeatRecovery | ||
| 19 | // It was broken out because that part needs to connect to a plant loop | ||
| 20 | class StraightComponent; | ||
| 21 | |||
| 22 | // TODO: add the tables class if they get added to OS later? | ||
| 23 | //class DataTables // UniVariateTables and BiVariateTables | ||
| 24 | |||
| 25 | //class Connection; | ||
| 26 | |||
| 27 | namespace detail { | ||
| 28 | |||
| 29 | class GeneratorMicroTurbine_Impl; | ||
| 30 | |||
| 31 | } // namespace detail | ||
| 32 | |||
| 33 | /** GeneratorMicroTurbine is a Generator that wraps the OpenStudio IDD object 'OS:Generator:MicroTurbine'. */ | ||
| 34 | class MODEL_API GeneratorMicroTurbine : public Generator | ||
| 35 | { | ||
| 36 | public: | ||
| 37 | /** @name Constructors and Destructors */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | // TODO: Could add a constructor with all the required inputs, but that's a lot of them | ||
| 41 | |||
| 42 | explicit GeneratorMicroTurbine(const Model& model); | ||
| 43 | |||
| 44 | 53 | virtual ~GeneratorMicroTurbine() override = default; | |
| 45 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 46 | 15 | GeneratorMicroTurbine(const GeneratorMicroTurbine& other) = default; | |
| 47 | 10 | GeneratorMicroTurbine(GeneratorMicroTurbine&& other) = default; | |
| 48 | ✗ | GeneratorMicroTurbine& operator=(const GeneratorMicroTurbine&) = default; | |
| 49 | ✗ | GeneratorMicroTurbine& operator=(GeneratorMicroTurbine&&) = default; | |
| 50 | |||
| 51 | virtual boost::optional<double> ratedThermaltoElectricalPowerRatio() const; | ||
| 52 | |||
| 53 | //@} | ||
| 54 | |||
| 55 | static IddObjectType iddObjectType(); | ||
| 56 | |||
| 57 | static std::vector<std::string> validFuelTypeValues(); | ||
| 58 | |||
| 59 | /** @name Getters */ | ||
| 60 | //@{ | ||
| 61 | |||
| 62 | // TODO: In E+ there's ElectricLoadCenter:GeneratorList where you'll specify the order of generators and the availability Schedule | ||
| 63 | // here it's been moved to the Generator themselves | ||
| 64 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 65 | |||
| 66 | double referenceElectricalPowerOutput() const; | ||
| 67 | |||
| 68 | double minimumFullLoadElectricalPowerOutput() const; | ||
| 69 | bool isMinimumFullLoadElectricalPowerOutputDefaulted() const; | ||
| 70 | |||
| 71 | // This will default to referenceElectricalPowerOutput if not defined, like E+ does | ||
| 72 | double maximumFullLoadElectricalPowerOutput() const; | ||
| 73 | bool isMaximumFullLoadElectricalPowerOutputDefaulted() const; | ||
| 74 | |||
| 75 | double referenceElectricalEfficiencyUsingLowerHeatingValue() const; | ||
| 76 | |||
| 77 | double referenceCombustionAirInletTemperature() const; | ||
| 78 | bool isReferenceCombustionAirInletTemperatureDefaulted() const; | ||
| 79 | |||
| 80 | double referenceCombustionAirInletHumidityRatio() const; | ||
| 81 | bool isReferenceCombustionAirInletHumidityRatioDefaulted() const; | ||
| 82 | |||
| 83 | double referenceElevation() const; | ||
| 84 | bool isReferenceElevationDefaulted() const; | ||
| 85 | |||
| 86 | Curve electricalPowerFunctionofTemperatureandElevationCurve() const; | ||
| 87 | |||
| 88 | Curve electricalEfficiencyFunctionofTemperatureCurve() const; | ||
| 89 | |||
| 90 | Curve electricalEfficiencyFunctionofPartLoadRatioCurve() const; | ||
| 91 | |||
| 92 | std::string fuelType() const; | ||
| 93 | bool isFuelTypeDefaulted() const; | ||
| 94 | |||
| 95 | double fuelHigherHeatingValue() const; | ||
| 96 | bool isFuelHigherHeatingValueDefaulted() const; | ||
| 97 | |||
| 98 | double fuelLowerHeatingValue() const; | ||
| 99 | bool isFuelLowerHeatingValueDefaulted() const; | ||
| 100 | |||
| 101 | double standbyPower() const; | ||
| 102 | bool isStandbyPowerDefaulted() const; | ||
| 103 | |||
| 104 | double ancillaryPower() const; | ||
| 105 | bool isAncillaryPowerDefaulted() const; | ||
| 106 | |||
| 107 | // TODO: Check return type. From object lists, some candidates are: QuadraticCurves, UniVariateTables. | ||
| 108 | boost::optional<Curve> ancillaryPowerFunctionofFuelInputCurve() const; | ||
| 109 | |||
| 110 | // Optional Generator:MicroTurbine:HeatRecovery | ||
| 111 | boost::optional<GeneratorMicroTurbineHeatRecovery> generatorMicroTurbineHeatRecovery() const; | ||
| 112 | |||
| 113 | // TODO: Check return type. From object lists, some candidates are: Connection. | ||
| 114 | //boost::optional<Connection> combustionAirInletNode() const; | ||
| 115 | |||
| 116 | // TODO: Check return type. From object lists, some candidates are: Connection. | ||
| 117 | // boost::optional<Connection> combustionAirOutletNode() const; | ||
| 118 | |||
| 119 | boost::optional<double> referenceExhaustAirMassFlowRate() const; | ||
| 120 | |||
| 121 | // TODO: Check return type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 122 | boost::optional<Curve> exhaustAirFlowRateFunctionofTemperatureCurve() const; | ||
| 123 | |||
| 124 | // TODO: Check return type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 125 | boost::optional<Curve> exhaustAirFlowRateFunctionofPartLoadRatioCurve() const; | ||
| 126 | |||
| 127 | boost::optional<double> nominalExhaustAirOutletTemperature() const; | ||
| 128 | |||
| 129 | // TODO: Check return type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 130 | boost::optional<Curve> exhaustAirTemperatureFunctionofTemperatureCurve() const; | ||
| 131 | |||
| 132 | // TODO: Check return type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 133 | boost::optional<Curve> exhaustAirTemperatureFunctionofPartLoadRatioCurve() const; | ||
| 134 | |||
| 135 | //@} | ||
| 136 | /** @name Setters */ | ||
| 137 | //@{ | ||
| 138 | |||
| 139 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 140 | void resetAvailabilitySchedule(); | ||
| 141 | |||
| 142 | bool setReferenceElectricalPowerOutput(double referenceElectricalPowerOutput); | ||
| 143 | |||
| 144 | bool setMinimumFullLoadElectricalPowerOutput(double minimumFullLoadElectricalPowerOutput); | ||
| 145 | void resetMinimumFullLoadElectricalPowerOutput(); | ||
| 146 | |||
| 147 | bool setMaximumFullLoadElectricalPowerOutput(double maximumFullLoadElectricalPowerOutput); | ||
| 148 | void resetMaximumFullLoadElectricalPowerOutput(); | ||
| 149 | |||
| 150 | bool setReferenceElectricalEfficiencyUsingLowerHeatingValue(double referenceElectricalEfficiencyUsingLowerHeatingValue); | ||
| 151 | |||
| 152 | bool setReferenceCombustionAirInletTemperature(double referenceCombustionAirInletTemperature); | ||
| 153 | void resetReferenceCombustionAirInletTemperature(); | ||
| 154 | |||
| 155 | bool setReferenceCombustionAirInletHumidityRatio(double referenceCombustionAirInletHumidityRatio); | ||
| 156 | void resetReferenceCombustionAirInletHumidityRatio(); | ||
| 157 | |||
| 158 | bool setReferenceElevation(double referenceElevation); | ||
| 159 | void resetReferenceElevation(); | ||
| 160 | |||
| 161 | // TODO: Check argument type. From object lists, some candidates are: BiquadraticCurves, BiVariateTables. | ||
| 162 | bool setElectricalPowerFunctionofTemperatureandElevationCurve(const Curve& electricalPowerFunctionofTemperatureandElevationCurve); | ||
| 163 | |||
| 164 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCubicCurves. | ||
| 165 | bool setElectricalEfficiencyFunctionofTemperatureCurve(const Curve& electricalEfficiencyFunctionofTemperatureCurve); | ||
| 166 | |||
| 167 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCubicCurves. | ||
| 168 | bool setElectricalEfficiencyFunctionofPartLoadRatioCurve(const Curve& electricalEfficiencyFunctionofPartLoadRatioCurve); | ||
| 169 | |||
| 170 | bool setFuelType(const std::string& fuelType); | ||
| 171 | void resetFuelType(); | ||
| 172 | |||
| 173 | bool setFuelHigherHeatingValue(double fuelHigherHeatingValue); | ||
| 174 | void resetFuelHigherHeatingValue(); | ||
| 175 | |||
| 176 | bool setFuelLowerHeatingValue(double fuelLowerHeatingValue); | ||
| 177 | void resetFuelLowerHeatingValue(); | ||
| 178 | |||
| 179 | bool setStandbyPower(double standbyPower); | ||
| 180 | void resetStandbyPower(); | ||
| 181 | |||
| 182 | bool setAncillaryPower(double ancillaryPower); | ||
| 183 | void resetAncillaryPower(); | ||
| 184 | |||
| 185 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCurves, UniVariateTables. | ||
| 186 | bool setAncillaryPowerFunctionofFuelInputCurve(const Curve& ancillaryPowerFunctionofFuelInputCurve); | ||
| 187 | void resetAncillaryPowerFunctionofFuelInputCurve(); | ||
| 188 | |||
| 189 | // Optional Generator:MicroTurbine:HeatRecovery | ||
| 190 | //bool setGeneratorMicroTurbineHeatRecovery(const GeneratorMicroTurbineHeatRecovery& generatorMicroTurbineHeatRecovery); | ||
| 191 | //void resetGeneratorMicroTurbineHeatRecovery(); | ||
| 192 | |||
| 193 | // TODO: Check argument type. From object lists, some candidates are: Connection. | ||
| 194 | //bool setCombustionAirInletNode(const Connection& connection); | ||
| 195 | //void resetCombustionAirInletNode(); | ||
| 196 | |||
| 197 | // TODO: Check argument type. From object lists, some candidates are: Connection. | ||
| 198 | //bool setCombustionAirOutletNode(const Connection& connection); | ||
| 199 | //void resetCombustionAirOutletNode(); | ||
| 200 | |||
| 201 | bool setReferenceExhaustAirMassFlowRate(double referenceExhaustAirMassFlowRate); | ||
| 202 | void resetReferenceExhaustAirMassFlowRate(); | ||
| 203 | |||
| 204 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 205 | bool setExhaustAirFlowRateFunctionofTemperatureCurve(const Curve& exhaustAirFlowRateFunctionofTemperatureCurve); | ||
| 206 | void resetExhaustAirFlowRateFunctionofTemperatureCurve(); | ||
| 207 | |||
| 208 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 209 | bool setExhaustAirFlowRateFunctionofPartLoadRatioCurve(const Curve& exhaustAirFlowRateFunctionofPartLoadRatioCurve); | ||
| 210 | void resetExhaustAirFlowRateFunctionofPartLoadRatioCurve(); | ||
| 211 | |||
| 212 | bool setNominalExhaustAirOutletTemperature(double nominalExhaustAirOutletTemperature); | ||
| 213 | void resetNominalExhaustAirOutletTemperature(); | ||
| 214 | |||
| 215 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 216 | bool setExhaustAirTemperatureFunctionofTemperatureCurve(const Curve& exhaustAirTemperatureFunctionofTemperatureCurve); | ||
| 217 | void resetExhaustAirTemperatureFunctionofTemperatureCurve(); | ||
| 218 | |||
| 219 | // TODO: Check argument type. From object lists, some candidates are: QuadraticCubicCurves, UniVariateTables. | ||
| 220 | bool setExhaustAirTemperatureFunctionofPartLoadRatioCurve(const Curve& exhaustAirTemperatureFunctionofPartLoadRatioCurve); | ||
| 221 | void resetExhaustAirTemperatureFunctionofPartLoadRatioCurve(); | ||
| 222 | |||
| 223 | //@} | ||
| 224 | /** @name Other */ | ||
| 225 | //@{ | ||
| 226 | |||
| 227 | //@} | ||
| 228 | protected: | ||
| 229 | /// @cond | ||
| 230 | using ImplType = detail::GeneratorMicroTurbine_Impl; | ||
| 231 | |||
| 232 | explicit GeneratorMicroTurbine(std::shared_ptr<detail::GeneratorMicroTurbine_Impl> impl); | ||
| 233 | |||
| 234 | friend class detail::GeneratorMicroTurbine_Impl; | ||
| 235 | friend class Model; | ||
| 236 | friend class IdfObject; | ||
| 237 | friend class openstudio::detail::IdfObject_Impl; | ||
| 238 | /// @endcond | ||
| 239 | private: | ||
| 240 | REGISTER_LOGGER("openstudio.model.GeneratorMicroTurbine"); | ||
| 241 | }; | ||
| 242 | |||
| 243 | /** \relates GeneratorMicroTurbine*/ | ||
| 244 | using OptionalGeneratorMicroTurbine = boost::optional<GeneratorMicroTurbine>; | ||
| 245 | |||
| 246 | /** \relates GeneratorMicroTurbine*/ | ||
| 247 | using GeneratorMicroTurbineVector = std::vector<GeneratorMicroTurbine>; | ||
| 248 | |||
| 249 | } // namespace model | ||
| 250 | } // namespace openstudio | ||
| 251 | |||
| 252 | #endif // MODEL_GENERATORMICROTURBINE_HPP | ||
| 253 |