GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 60.0% 3 / 0 / 5
Functions: 60.0% 3 / 0 / 5
Branches: -% 0 / 0 / 0

src/model/ElectricLoadCenterStorageLiIonNMCBattery.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_ELECTRICLOADCENTERSTORAGELIIONNMCBATTERY_HPP
7 #define MODEL_ELECTRICLOADCENTERSTORAGELIIONNMCBATTERY_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ElectricalStorage.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Schedule;
17 class ThermalZone;
18
19 namespace detail {
20
21 class ElectricLoadCenterStorageLiIonNMCBattery_Impl;
22
23 } // namespace detail
24
25 /** ElectricLoadCenterStorageLiIonNMCBattery is a ElectricalStorage that wraps the OpenStudio IDD object 'OS:ElectricLoadCenter:Storage:LiIonNMCBattery'. */
26 class MODEL_API ElectricLoadCenterStorageLiIonNMCBattery : public ElectricalStorage
27 {
28 public:
29 /** @name Constructors and Destructors */
30 //@{
31
32 explicit ElectricLoadCenterStorageLiIonNMCBattery(const Model& model);
33
34 explicit ElectricLoadCenterStorageLiIonNMCBattery(const Model& model, const int numberofCellsinSeries, const int numberofStringsinParallel,
35 const double batteryMass, const double batterySurfaceArea);
36
37 16 virtual ~ElectricLoadCenterStorageLiIonNMCBattery() override = default;
38 // Default the copy and move operators because the virtual dtor is explicit
39 1 ElectricLoadCenterStorageLiIonNMCBattery(const ElectricLoadCenterStorageLiIonNMCBattery& other) = default;
40 1 ElectricLoadCenterStorageLiIonNMCBattery(ElectricLoadCenterStorageLiIonNMCBattery&& other) = default;
41 ✗ ElectricLoadCenterStorageLiIonNMCBattery& operator=(const ElectricLoadCenterStorageLiIonNMCBattery&) = default;
42 ✗ ElectricLoadCenterStorageLiIonNMCBattery& operator=(ElectricLoadCenterStorageLiIonNMCBattery&&) = default;
43
44 //@}
45
46 static IddObjectType iddObjectType();
47
48 static std::vector<std::string> lifetimeModelValues();
49
50 /** @name Getters */
51 //@{
52
53 // Convenience method to return the electricalLoadCenter on which it's assigned (optional)
54 // In parent
55 // boost::optional<ElectricLoadCenterDistribution> electricLoadCenterDistribution() const;
56
57 Schedule availabilitySchedule() const;
58
59 // Included in parent class, shouldn't need to define it here...
60 //virtual boost::optional<ThermalZone> thermalZone() const override;
61
62 double radiativeFraction() const;
63
64 std::string lifetimeModel() const;
65
66 int numberofCellsinSeries() const;
67
68 int numberofStringsinParallel() const;
69
70 double initialFractionalStateofCharge() const;
71
72 double dctoDCChargingEfficiency() const;
73
74 double batteryMass() const;
75
76 double batterySurfaceArea() const;
77
78 double batterySpecificHeatCapacity() const;
79
80 double heatTransferCoefficientBetweenBatteryandAmbient() const;
81
82 double fullyChargedCellVoltage() const;
83
84 double cellVoltageatEndofExponentialZone() const;
85
86 double cellVoltageatEndofNominalZone() const;
87
88 double defaultNominalCellVoltage() const;
89
90 double fullyChargedCellCapacity() const;
91
92 double fractionofCellCapacityRemovedattheEndofExponentialZone() const;
93
94 double fractionofCellCapacityRemovedattheEndofNominalZone() const;
95
96 double chargeRateatWhichVoltagevsCapacityCurveWasGenerated() const;
97
98 double batteryCellInternalElectricalResistance() const;
99
100 //@}
101 /** @name Setters */
102 //@{
103
104 bool setAvailabilitySchedule(Schedule& schedule);
105
106 // Included in parent class, shouldn't need to define it...
107 //virtual bool setThermalZone(ThermalZone& zone) override;
108 //virtual void resetThermalZone() override;
109
110 bool setRadiativeFraction(double radiativeFraction);
111
112 bool setLifetimeModel(const std::string& lifetimeModel);
113
114 bool setNumberofCellsinSeries(int numberofCellsinSeries);
115
116 bool setNumberofStringsinParallel(int numberofStringsinParallel);
117
118 bool setInitialFractionalStateofCharge(double initialFractionalStateofCharge);
119
120 bool setDCtoDCChargingEfficiency(double dctoDCChargingEfficiency);
121
122 bool setBatteryMass(double batteryMass);
123
124 bool setBatterySurfaceArea(double batterySurfaceArea);
125
126 bool setBatterySpecificHeatCapacity(double batterySpecificHeatCapacity);
127
128 bool setHeatTransferCoefficientBetweenBatteryandAmbient(double heatTransferCoefficientBetweenBatteryandAmbient);
129
130 bool setFullyChargedCellVoltage(double fullyChargedCellCapacity);
131
132 bool setCellVoltageatEndofExponentialZone(double cellVoltageatEndofExponentialZone);
133
134 bool setCellVoltageatEndofNominalZone(double cellVoltageatEndofNominalZone);
135
136 bool setDefaultNominalCellVoltage(double defaultNominalCellVoltage);
137
138 bool setFullyChargedCellCapacity(double fullyChargedCellCapacity);
139
140 bool setFractionofCellCapacityRemovedattheEndofExponentialZone(double fractionofCellCapacityRemovedattheEndofExponentialZone);
141
142 bool setFractionofCellCapacityRemovedattheEndofNominalZone(double fractionofCellCapacityRemovedattheEndofNominalZone);
143
144 bool setChargeRateatWhichVoltagevsCapacityCurveWasGenerated(double chargeRateatWhichVoltagevsCapacityCurveWasGenerated);
145
146 bool setBatteryCellInternalElectricalResistance(double batteryCellInternalElectricalResistance);
147
148 //@}
149 /** @name Other */
150 //@{
151
152 //@}
153 protected:
154 /// @cond
155 using ImplType = detail::ElectricLoadCenterStorageLiIonNMCBattery_Impl;
156
157 explicit ElectricLoadCenterStorageLiIonNMCBattery(std::shared_ptr<detail::ElectricLoadCenterStorageLiIonNMCBattery_Impl> impl);
158
159 friend class detail::ElectricLoadCenterStorageLiIonNMCBattery_Impl;
160 friend class Model;
161 friend class IdfObject;
162 friend class openstudio::detail::IdfObject_Impl;
163 /// @endcond
164 private:
165 REGISTER_LOGGER("openstudio.model.ElectricLoadCenterStorageLiIonNMCBattery");
166 };
167
168 /** \relates ElectricLoadCenterStorageLiIonNMCBattery*/
169 using OptionalElectricLoadCenterStorageLiIonNMCBattery = boost::optional<ElectricLoadCenterStorageLiIonNMCBattery>;
170
171 /** \relates ElectricLoadCenterStorageLiIonNMCBattery*/
172 using ElectricLoadCenterStorageLiIonNMCBatteryVector = std::vector<ElectricLoadCenterStorageLiIonNMCBattery>;
173
174 } // namespace model
175 } // namespace openstudio
176
177 #endif // MODEL_ELECTRICLOADCENTERSTORAGELIIONNMCBATTERY_HPP
178