src/model/GeneratorFuelCellPowerModule.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_GENERATORFUELCELLPOWERMODULE_HPP | ||
| 7 | #define MODEL_GENERATORFUELCELLPOWERMODULE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | #include "GeneratorFuelCell.hpp" | ||
| 12 | #include "GeneratorFuelCell_Impl.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class CurveQuadratic; | ||
| 19 | class ThermalZone; | ||
| 20 | class Node; | ||
| 21 | class GeneratorFuelCell; | ||
| 22 | |||
| 23 | namespace detail { | ||
| 24 | |||
| 25 | class GeneratorFuelCellPowerModule_Impl; | ||
| 26 | |||
| 27 | } // namespace detail | ||
| 28 | |||
| 29 | /** GeneratorFuelCellPowerModule is a ModelObject that wraps the OpenStudio IDD object 'OS:Generator:FuelCell:PowerModule'. */ | ||
| 30 | class MODEL_API GeneratorFuelCellPowerModule : public ModelObject | ||
| 31 | { | ||
| 32 | public: | ||
| 33 | /** @name Constructors and Destructors */ | ||
| 34 | //@{ | ||
| 35 | |||
| 36 | explicit GeneratorFuelCellPowerModule(const Model& model, const ThermalZone& heatlossZone, const Node& dilutionInletAirNode, | ||
| 37 | const Node& dilutionOutletAirNode); | ||
| 38 | |||
| 39 | explicit GeneratorFuelCellPowerModule(const Model& model, const CurveQuadratic& efficiencyCurve, const ThermalZone& heatlossZone, | ||
| 40 | const Node& dilutionInletAirNode, const Node& dilutionOutletAirNode); | ||
| 41 | |||
| 42 | explicit GeneratorFuelCellPowerModule(const Model& model, const CurveQuadratic& efficiencyCurve, const ThermalZone& heatlossZone, | ||
| 43 | const Node& dilutionInletAirNode, const Node& dilutionOutletAirNode, const CurveQuadratic& skinlossCurve); | ||
| 44 | |||
| 45 | explicit GeneratorFuelCellPowerModule(const Model& model, const CurveQuadratic& efficiencyCurve); | ||
| 46 | |||
| 47 | explicit GeneratorFuelCellPowerModule(const Model& model); | ||
| 48 | |||
| 49 | 121 | virtual ~GeneratorFuelCellPowerModule() override = default; | |
| 50 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 51 | 25 | GeneratorFuelCellPowerModule(const GeneratorFuelCellPowerModule& other) = default; | |
| 52 | 56 | GeneratorFuelCellPowerModule(GeneratorFuelCellPowerModule&& other) = default; | |
| 53 | ✗ | GeneratorFuelCellPowerModule& operator=(const GeneratorFuelCellPowerModule&) = default; | |
| 54 | ✗ | GeneratorFuelCellPowerModule& operator=(GeneratorFuelCellPowerModule&&) = default; | |
| 55 | |||
| 56 | //@} | ||
| 57 | |||
| 58 | static IddObjectType iddObjectType(); | ||
| 59 | |||
| 60 | static std::vector<std::string> efficiencyCurveModeValues(); | ||
| 61 | |||
| 62 | static std::vector<std::string> skinLossCalculationModeValues(); | ||
| 63 | |||
| 64 | /** @name Getters */ | ||
| 65 | //@{ | ||
| 66 | |||
| 67 | std::string efficiencyCurveMode() const; | ||
| 68 | |||
| 69 | CurveQuadratic efficiencyCurve() const; | ||
| 70 | |||
| 71 | double nominalEfficiency() const; | ||
| 72 | |||
| 73 | double nominalElectricalPower() const; | ||
| 74 | |||
| 75 | double numberofStopsatStartofSimulation() const; | ||
| 76 | |||
| 77 | double cyclingPerformanceDegradationCoefficient() const; | ||
| 78 | |||
| 79 | double numberofRunHoursatBeginningofSimulation() const; | ||
| 80 | |||
| 81 | double accumulatedRunTimeDegradationCoefficient() const; | ||
| 82 | |||
| 83 | double runTimeDegradationInitiationTimeThreshold() const; | ||
| 84 | |||
| 85 | double powerUpTransientLimit() const; | ||
| 86 | |||
| 87 | double powerDownTransientLimit() const; | ||
| 88 | |||
| 89 | double startUpTime() const; | ||
| 90 | |||
| 91 | double startUpFuel() const; | ||
| 92 | |||
| 93 | double startUpElectricityConsumption() const; | ||
| 94 | |||
| 95 | double startUpElectricityProduced() const; | ||
| 96 | |||
| 97 | double shutDownTime() const; | ||
| 98 | |||
| 99 | double shutDownFuel() const; | ||
| 100 | |||
| 101 | double shutDownElectricityConsumption() const; | ||
| 102 | |||
| 103 | double ancillaryElectricityConstantTerm() const; | ||
| 104 | |||
| 105 | double ancillaryElectricityLinearTerm() const; | ||
| 106 | |||
| 107 | std::string skinLossCalculationMode() const; | ||
| 108 | |||
| 109 | boost::optional<ThermalZone> zone() const; | ||
| 110 | |||
| 111 | double skinLossRadiativeFraction() const; | ||
| 112 | |||
| 113 | double constantSkinLossRate() const; | ||
| 114 | |||
| 115 | double skinLossUFactorTimesAreaTerm() const; | ||
| 116 | |||
| 117 | boost::optional<CurveQuadratic> skinLossQuadraticCurve() const; | ||
| 118 | |||
| 119 | double dilutionAirFlowRate() const; | ||
| 120 | |||
| 121 | double stackHeatlosstoDilutionAir() const; | ||
| 122 | |||
| 123 | boost::optional<Node> dilutionInletAirNode() const; | ||
| 124 | |||
| 125 | boost::optional<Node> dilutionOutletAirNode() const; | ||
| 126 | |||
| 127 | double minimumOperatingPoint() const; | ||
| 128 | |||
| 129 | double maximumOperatingPoint() const; | ||
| 130 | |||
| 131 | // Return optional parent generator | ||
| 132 | boost::optional<GeneratorFuelCell> fuelCell() const; | ||
| 133 | |||
| 134 | //@} | ||
| 135 | /** @name Setters */ | ||
| 136 | //@{ | ||
| 137 | |||
| 138 | bool setEfficiencyCurveMode(const std::string& efficiencyCurveMode); | ||
| 139 | |||
| 140 | void resetEfficiencyCurveMode(); | ||
| 141 | |||
| 142 | bool setEfficiencyCurve(const CurveQuadratic& quadraticCurve); | ||
| 143 | |||
| 144 | bool setNominalEfficiency(double nominalEfficiency); | ||
| 145 | |||
| 146 | void resetNominalEfficiency(); | ||
| 147 | |||
| 148 | bool setNominalElectricalPower(double nominalElectricalPower); | ||
| 149 | |||
| 150 | void resetNominalElectricalPower(); | ||
| 151 | |||
| 152 | bool setNumberofStopsatStartofSimulation(double numberofStopsatStartofSimulation); | ||
| 153 | |||
| 154 | void resetNumberofStopsatStartofSimulation(); | ||
| 155 | |||
| 156 | bool setCyclingPerformanceDegradationCoefficient(double cyclingPerformanceDegradationCoefficient); | ||
| 157 | |||
| 158 | void resetCyclingPerformanceDegradationCoefficient(); | ||
| 159 | |||
| 160 | bool setNumberofRunHoursatBeginningofSimulation(double numberofRunHoursatBeginningofSimulation); | ||
| 161 | |||
| 162 | void resetNumberofRunHoursatBeginningofSimulation(); | ||
| 163 | |||
| 164 | bool setAccumulatedRunTimeDegradationCoefficient(double accumulatedRunTimeDegradationCoefficient); | ||
| 165 | |||
| 166 | void resetAccumulatedRunTimeDegradationCoefficient(); | ||
| 167 | |||
| 168 | bool setRunTimeDegradationInitiationTimeThreshold(double runTimeDegradationInitiationTimeThreshold); | ||
| 169 | |||
| 170 | void resetRunTimeDegradationInitiationTimeThreshold(); | ||
| 171 | |||
| 172 | bool setPowerUpTransientLimit(double powerUpTransientLimit); | ||
| 173 | |||
| 174 | void resetPowerUpTransientLimit(); | ||
| 175 | |||
| 176 | bool setPowerDownTransientLimit(double powerDownTransientLimit); | ||
| 177 | |||
| 178 | void resetPowerDownTransientLimit(); | ||
| 179 | |||
| 180 | bool setStartUpTime(double startUpTime); | ||
| 181 | |||
| 182 | void resetStartUpTime(); | ||
| 183 | |||
| 184 | bool setStartUpFuel(double startUpFuel); | ||
| 185 | |||
| 186 | void resetStartUpFuel(); | ||
| 187 | |||
| 188 | bool setStartUpElectricityConsumption(double startUpElectricityConsumption); | ||
| 189 | |||
| 190 | void resetStartUpElectricityConsumption(); | ||
| 191 | |||
| 192 | bool setStartUpElectricityProduced(double startUpElectricityProduced); | ||
| 193 | |||
| 194 | void resetStartUpElectricityProduced(); | ||
| 195 | |||
| 196 | bool setShutDownTime(double shutDownTime); | ||
| 197 | |||
| 198 | void resetShutDownTime(); | ||
| 199 | |||
| 200 | bool setShutDownFuel(double shutDownFuel); | ||
| 201 | |||
| 202 | void resetShutDownFuel(); | ||
| 203 | |||
| 204 | bool setShutDownElectricityConsumption(double shutDownElectricityConsumption); | ||
| 205 | |||
| 206 | void resetShutDownElectricityConsumption(); | ||
| 207 | |||
| 208 | bool setAncillaryElectricityConstantTerm(double ancillaryElectricityConstantTerm); | ||
| 209 | |||
| 210 | void resetAncillaryElectricityConstantTerm(); | ||
| 211 | |||
| 212 | bool setAncillaryElectricityLinearTerm(double ancillaryElectricityLinearTerm); | ||
| 213 | |||
| 214 | void resetAncillaryElectricityLinearTerm(); | ||
| 215 | |||
| 216 | bool setSkinLossCalculationMode(const std::string& skinLossCalculationMode); | ||
| 217 | |||
| 218 | void resetSkinLossCalculationMode(); | ||
| 219 | |||
| 220 | bool setZone(const ThermalZone& zone); | ||
| 221 | |||
| 222 | void resetZone(); | ||
| 223 | |||
| 224 | bool setSkinLossRadiativeFraction(double skinLossRadiativeFraction); | ||
| 225 | |||
| 226 | void resetSkinLossRadiativeFraction(); | ||
| 227 | |||
| 228 | bool setConstantSkinLossRate(double constantSkinLossRate); | ||
| 229 | |||
| 230 | void resetConstantSkinLossRate(); | ||
| 231 | |||
| 232 | bool setSkinLossUFactorTimesAreaTerm(double skinLossUFactorTimesAreaTerm); | ||
| 233 | |||
| 234 | void resetSkinLossUFactorTimesAreaTerm(); | ||
| 235 | |||
| 236 | bool setSkinLossQuadraticCurve(const CurveQuadratic& quadraticCurves); | ||
| 237 | |||
| 238 | void resetSkinLossQuadraticCurve(); | ||
| 239 | |||
| 240 | bool setDilutionAirFlowRate(double dilutionAirFlowRate); | ||
| 241 | |||
| 242 | void resetDilutionAirFlowRate(); | ||
| 243 | |||
| 244 | bool setStackHeatlosstoDilutionAir(double stackHeatlosstoDilutionAir); | ||
| 245 | |||
| 246 | void resetStackHeatlosstoDilutionAir(); | ||
| 247 | |||
| 248 | bool setDilutionInletAirNode(const Node& connection); | ||
| 249 | |||
| 250 | void resetDilutionInletAirNode(); | ||
| 251 | |||
| 252 | bool setDilutionOutletAirNode(const Node& connection); | ||
| 253 | |||
| 254 | void resetDilutionOutletAirNode(); | ||
| 255 | |||
| 256 | bool setMinimumOperatingPoint(double minimumOperatingPoint); | ||
| 257 | |||
| 258 | void resetMinimumOperatingPoint(); | ||
| 259 | |||
| 260 | bool setMaximumOperatingPoint(double maximumOperatingPoint); | ||
| 261 | |||
| 262 | void resetMaximumOperatingPoint(); | ||
| 263 | |||
| 264 | //@} | ||
| 265 | /** @name Other */ | ||
| 266 | //@{ | ||
| 267 | |||
| 268 | //@} | ||
| 269 | protected: | ||
| 270 | /// @cond | ||
| 271 | using ImplType = detail::GeneratorFuelCellPowerModule_Impl; | ||
| 272 | |||
| 273 | explicit GeneratorFuelCellPowerModule(std::shared_ptr<detail::GeneratorFuelCellPowerModule_Impl> impl); | ||
| 274 | |||
| 275 | friend class detail::GeneratorFuelCellPowerModule_Impl; | ||
| 276 | friend class Model; | ||
| 277 | friend class IdfObject; | ||
| 278 | friend class openstudio::detail::IdfObject_Impl; | ||
| 279 | /// @endcond | ||
| 280 | private: | ||
| 281 | − | REGISTER_LOGGER("openstudio.model.GeneratorFuelCellPowerModule"); | |
| 282 | }; | ||
| 283 | |||
| 284 | /** \relates GeneratorFuelCellPowerModule*/ | ||
| 285 | using OptionalGeneratorFuelCellPowerModule = boost::optional<GeneratorFuelCellPowerModule>; | ||
| 286 | |||
| 287 | /** \relates GeneratorFuelCellPowerModule*/ | ||
| 288 | using GeneratorFuelCellPowerModuleVector = std::vector<GeneratorFuelCellPowerModule>; | ||
| 289 | |||
| 290 | } // namespace model | ||
| 291 | } // namespace openstudio | ||
| 292 | |||
| 293 | #endif // MODEL_GENERATORFUELCELLPOWERMODULE_HPP | ||
| 294 |