src/model/PhotovoltaicPerformanceSandia.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_PHOTOVOLTAICPERFORMANCESANDIA_HPP | ||
| 7 | #define MODEL_PHOTOVOLTAICPERFORMANCESANDIA_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "PhotovoltaicPerformance.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class PhotovoltaicPerformanceSandia_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** PhotovoltaicPerformanceSandia is a PhotovoltaicPerformance that wraps the OpenStudio IDD object 'OS:PhotovoltaicPerformance:Sandia'. */ | ||
| 23 | class MODEL_API PhotovoltaicPerformanceSandia : public PhotovoltaicPerformance | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | // Defaults all characteristics to one random entry in the Sandia Database | ||
| 30 | explicit PhotovoltaicPerformanceSandia(const Model& model); | ||
| 31 | |||
| 32 | explicit PhotovoltaicPerformanceSandia( | ||
| 33 | const Model& model, double activeArea, int numberofCellsinSeries, int numberofCellsinParallel, double shortCircuitCurrent, | ||
| 34 | double openCircuitVoltage, double currentatMaximumPowerPoint, double voltageatMaximumPowerPoint, double sandiaDatabaseParameteraIsc, | ||
| 35 | double sandiaDatabaseParameteraImp, double sandiaDatabaseParameterc0, double sandiaDatabaseParameterc1, double sandiaDatabaseParameterBVoc0, | ||
| 36 | double sandiaDatabaseParametermBVoc, double sandiaDatabaseParameterBVmp0, double sandiaDatabaseParametermBVmp, double diodeFactor, | ||
| 37 | double sandiaDatabaseParameterc2, double sandiaDatabaseParameterc3, double sandiaDatabaseParametera0, double sandiaDatabaseParametera1, | ||
| 38 | double sandiaDatabaseParametera2, double sandiaDatabaseParametera3, double sandiaDatabaseParametera4, double sandiaDatabaseParameterb0, | ||
| 39 | double sandiaDatabaseParameterb1, double sandiaDatabaseParameterb2, double sandiaDatabaseParameterb3, double sandiaDatabaseParameterb4, | ||
| 40 | double sandiaDatabaseParameterb5, double sandiaDatabaseParameterDeltaTc, double sandiaDatabaseParameterfd, double sandiaDatabaseParametera, | ||
| 41 | double sandiaDatabaseParameterb, double sandiaDatabaseParameterc4, double sandiaDatabaseParameterc5, double sandiaDatabaseParameterIx0, | ||
| 42 | double sandiaDatabaseParameterIxx0, double sandiaDatabaseParameterc6, double sandiaDatabaseParameterc7); | ||
| 43 | |||
| 44 | /// Factory method to creates a PhotovoltaicPerformanceSandia by looking up characteristics in the embedded Sandia database by its name | ||
| 45 | // Please use the PhotovoltaicPerformanceSandia::sandiaModulePerformanceNames() static method to look up the valid names | ||
| 46 | // as it will throw if it cannot find it | ||
| 47 | static PhotovoltaicPerformanceSandia fromSandiaDatabase(const Model& model, const std::string& sandiaModulePerformanceName); | ||
| 48 | |||
| 49 | 15 | virtual ~PhotovoltaicPerformanceSandia() override = default; | |
| 50 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 51 | 1 | PhotovoltaicPerformanceSandia(const PhotovoltaicPerformanceSandia& other) = default; | |
| 52 | 2 | PhotovoltaicPerformanceSandia(PhotovoltaicPerformanceSandia&& other) = default; | |
| 53 | ✗ | PhotovoltaicPerformanceSandia& operator=(const PhotovoltaicPerformanceSandia&) = default; | |
| 54 | ✗ | PhotovoltaicPerformanceSandia& operator=(PhotovoltaicPerformanceSandia&&) = default; | |
| 55 | |||
| 56 | //@} | ||
| 57 | |||
| 58 | static std::vector<std::string> sandiaModulePerformanceNames(); | ||
| 59 | |||
| 60 | static IddObjectType iddObjectType(); | ||
| 61 | |||
| 62 | /** @name Getters */ | ||
| 63 | //@{ | ||
| 64 | |||
| 65 | double activeArea() const; | ||
| 66 | |||
| 67 | int numberofCellsinSeries() const; | ||
| 68 | |||
| 69 | int numberofCellsinParallel() const; | ||
| 70 | |||
| 71 | double shortCircuitCurrent() const; | ||
| 72 | |||
| 73 | double openCircuitVoltage() const; | ||
| 74 | |||
| 75 | double currentatMaximumPowerPoint() const; | ||
| 76 | |||
| 77 | double voltageatMaximumPowerPoint() const; | ||
| 78 | |||
| 79 | double sandiaDatabaseParameteraIsc() const; | ||
| 80 | |||
| 81 | double sandiaDatabaseParameteraImp() const; | ||
| 82 | |||
| 83 | double sandiaDatabaseParameterc0() const; | ||
| 84 | |||
| 85 | double sandiaDatabaseParameterc1() const; | ||
| 86 | |||
| 87 | double sandiaDatabaseParameterBVoc0() const; | ||
| 88 | |||
| 89 | double sandiaDatabaseParametermBVoc() const; | ||
| 90 | |||
| 91 | double sandiaDatabaseParameterBVmp0() const; | ||
| 92 | |||
| 93 | double sandiaDatabaseParametermBVmp() const; | ||
| 94 | |||
| 95 | double diodeFactor() const; | ||
| 96 | |||
| 97 | double sandiaDatabaseParameterc2() const; | ||
| 98 | |||
| 99 | double sandiaDatabaseParameterc3() const; | ||
| 100 | |||
| 101 | double sandiaDatabaseParametera0() const; | ||
| 102 | |||
| 103 | double sandiaDatabaseParametera1() const; | ||
| 104 | |||
| 105 | double sandiaDatabaseParametera2() const; | ||
| 106 | |||
| 107 | double sandiaDatabaseParametera3() const; | ||
| 108 | |||
| 109 | double sandiaDatabaseParametera4() const; | ||
| 110 | |||
| 111 | double sandiaDatabaseParameterb0() const; | ||
| 112 | |||
| 113 | double sandiaDatabaseParameterb1() const; | ||
| 114 | |||
| 115 | double sandiaDatabaseParameterb2() const; | ||
| 116 | |||
| 117 | double sandiaDatabaseParameterb3() const; | ||
| 118 | |||
| 119 | double sandiaDatabaseParameterb4() const; | ||
| 120 | |||
| 121 | double sandiaDatabaseParameterb5() const; | ||
| 122 | |||
| 123 | double sandiaDatabaseParameterDeltaTc() const; | ||
| 124 | |||
| 125 | double sandiaDatabaseParameterfd() const; | ||
| 126 | |||
| 127 | double sandiaDatabaseParametera() const; | ||
| 128 | |||
| 129 | double sandiaDatabaseParameterb() const; | ||
| 130 | |||
| 131 | double sandiaDatabaseParameterc4() const; | ||
| 132 | |||
| 133 | double sandiaDatabaseParameterc5() const; | ||
| 134 | |||
| 135 | double sandiaDatabaseParameterIx0() const; | ||
| 136 | |||
| 137 | double sandiaDatabaseParameterIxx0() const; | ||
| 138 | |||
| 139 | double sandiaDatabaseParameterc6() const; | ||
| 140 | |||
| 141 | double sandiaDatabaseParameterc7() const; | ||
| 142 | |||
| 143 | //@} | ||
| 144 | /** @name Setters */ | ||
| 145 | //@{ | ||
| 146 | |||
| 147 | bool setActiveArea(double activeArea); | ||
| 148 | |||
| 149 | bool setNumberofCellsinSeries(int numberofCellsinSeries); | ||
| 150 | |||
| 151 | bool setNumberofCellsinParallel(int numberofCellsinParallel); | ||
| 152 | |||
| 153 | bool setShortCircuitCurrent(double shortCircuitCurrent); | ||
| 154 | |||
| 155 | bool setOpenCircuitVoltage(double openCircuitVoltage); | ||
| 156 | |||
| 157 | bool setCurrentatMaximumPowerPoint(double currentatMaximumPowerPoint); | ||
| 158 | |||
| 159 | bool setVoltageatMaximumPowerPoint(double voltageatMaximumPowerPoint); | ||
| 160 | |||
| 161 | bool setSandiaDatabaseParameteraIsc(double sandiaDatabaseParameteraIsc); | ||
| 162 | |||
| 163 | bool setSandiaDatabaseParameteraImp(double sandiaDatabaseParameteraImp); | ||
| 164 | |||
| 165 | bool setSandiaDatabaseParameterc0(double sandiaDatabaseParameterc0); | ||
| 166 | |||
| 167 | bool setSandiaDatabaseParameterc1(double sandiaDatabaseParameterc1); | ||
| 168 | |||
| 169 | bool setSandiaDatabaseParameterBVoc0(double sandiaDatabaseParameterBVoc0); | ||
| 170 | |||
| 171 | bool setSandiaDatabaseParametermBVoc(double sandiaDatabaseParametermBVoc); | ||
| 172 | |||
| 173 | bool setSandiaDatabaseParameterBVmp0(double sandiaDatabaseParameterBVmp0); | ||
| 174 | |||
| 175 | bool setSandiaDatabaseParametermBVmp(double sandiaDatabaseParametermBVmp); | ||
| 176 | |||
| 177 | bool setDiodeFactor(double diodeFactor); | ||
| 178 | |||
| 179 | bool setSandiaDatabaseParameterc2(double sandiaDatabaseParameterc2); | ||
| 180 | |||
| 181 | bool setSandiaDatabaseParameterc3(double sandiaDatabaseParameterc3); | ||
| 182 | |||
| 183 | bool setSandiaDatabaseParametera0(double sandiaDatabaseParametera0); | ||
| 184 | |||
| 185 | bool setSandiaDatabaseParametera1(double sandiaDatabaseParametera1); | ||
| 186 | |||
| 187 | bool setSandiaDatabaseParametera2(double sandiaDatabaseParametera2); | ||
| 188 | |||
| 189 | bool setSandiaDatabaseParametera3(double sandiaDatabaseParametera3); | ||
| 190 | |||
| 191 | bool setSandiaDatabaseParametera4(double sandiaDatabaseParametera4); | ||
| 192 | |||
| 193 | bool setSandiaDatabaseParameterb0(double sandiaDatabaseParameterb0); | ||
| 194 | |||
| 195 | bool setSandiaDatabaseParameterb1(double sandiaDatabaseParameterb1); | ||
| 196 | |||
| 197 | bool setSandiaDatabaseParameterb2(double sandiaDatabaseParameterb2); | ||
| 198 | |||
| 199 | bool setSandiaDatabaseParameterb3(double sandiaDatabaseParameterb3); | ||
| 200 | |||
| 201 | bool setSandiaDatabaseParameterb4(double sandiaDatabaseParameterb4); | ||
| 202 | |||
| 203 | bool setSandiaDatabaseParameterb5(double sandiaDatabaseParameterb5); | ||
| 204 | |||
| 205 | bool setSandiaDatabaseParameterDeltaTc(double sandiaDatabaseParameterDeltaTc); | ||
| 206 | |||
| 207 | bool setSandiaDatabaseParameterfd(double sandiaDatabaseParameterfd); | ||
| 208 | |||
| 209 | bool setSandiaDatabaseParametera(double sandiaDatabaseParametera); | ||
| 210 | |||
| 211 | bool setSandiaDatabaseParameterb(double sandiaDatabaseParameterb); | ||
| 212 | |||
| 213 | bool setSandiaDatabaseParameterc4(double sandiaDatabaseParameterc4); | ||
| 214 | |||
| 215 | bool setSandiaDatabaseParameterc5(double sandiaDatabaseParameterc5); | ||
| 216 | |||
| 217 | bool setSandiaDatabaseParameterIx0(double sandiaDatabaseParameterIx0); | ||
| 218 | |||
| 219 | bool setSandiaDatabaseParameterIxx0(double sandiaDatabaseParameterIxx0); | ||
| 220 | |||
| 221 | bool setSandiaDatabaseParameterc6(double sandiaDatabaseParameterc6); | ||
| 222 | |||
| 223 | bool setSandiaDatabaseParameterc7(double sandiaDatabaseParameterc7); | ||
| 224 | |||
| 225 | //@} | ||
| 226 | /** @name Other */ | ||
| 227 | //@{ | ||
| 228 | |||
| 229 | //@} | ||
| 230 | protected: | ||
| 231 | /// @cond | ||
| 232 | using ImplType = detail::PhotovoltaicPerformanceSandia_Impl; | ||
| 233 | |||
| 234 | explicit PhotovoltaicPerformanceSandia(std::shared_ptr<detail::PhotovoltaicPerformanceSandia_Impl> impl); | ||
| 235 | |||
| 236 | friend class detail::PhotovoltaicPerformanceSandia_Impl; | ||
| 237 | friend class Model; | ||
| 238 | friend class IdfObject; | ||
| 239 | friend class openstudio::detail::IdfObject_Impl; | ||
| 240 | /// @endcond | ||
| 241 | private: | ||
| 242 | REGISTER_LOGGER("openstudio.model.PhotovoltaicPerformanceSandia"); | ||
| 243 | }; | ||
| 244 | |||
| 245 | /** \relates PhotovoltaicPerformanceSandia*/ | ||
| 246 | using OptionalPhotovoltaicPerformanceSandia = boost::optional<PhotovoltaicPerformanceSandia>; | ||
| 247 | |||
| 248 | /** \relates PhotovoltaicPerformanceSandia*/ | ||
| 249 | using PhotovoltaicPerformanceSandiaVector = std::vector<PhotovoltaicPerformanceSandia>; | ||
| 250 | |||
| 251 | } // namespace model | ||
| 252 | } // namespace openstudio | ||
| 253 | |||
| 254 | #endif // MODEL_PHOTOVOLTAICPERFORMANCESANDIA_HPP | ||
| 255 |