GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 100.0% 1 / 1 / 2
Functions: 100.0% 1 / 1 / 2
Branches: -% 0 / 1 / 1

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