src/model/GeneratorWindTurbine.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_GENERATORWINDTURBINE_HPP | ||
| 7 | #define MODEL_GENERATORWINDTURBINE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Generator.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class GeneratorWindTurbine_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** GeneratorWindTurbine is a Generator that wraps the OpenStudio IDD object 'OS:Generator:WindTurbine'. */ | ||
| 23 | class MODEL_API GeneratorWindTurbine : public Generator | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | explicit GeneratorWindTurbine(const Model& model); | ||
| 30 | |||
| 31 | 17 | virtual ~GeneratorWindTurbine() override = default; | |
| 32 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 33 | 1 | GeneratorWindTurbine(const GeneratorWindTurbine& other) = default; | |
| 34 | 2 | GeneratorWindTurbine(GeneratorWindTurbine&& other) = default; | |
| 35 | ✗ | GeneratorWindTurbine& operator=(const GeneratorWindTurbine&) = default; | |
| 36 | ✗ | GeneratorWindTurbine& operator=(GeneratorWindTurbine&&) = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | /** @name Getters */ | ||
| 43 | //@{ | ||
| 44 | |||
| 45 | std::string rotorType() const; | ||
| 46 | |||
| 47 | std::string powerControl() const; | ||
| 48 | |||
| 49 | double ratedRotorSpeed() const; | ||
| 50 | |||
| 51 | double rotorDiameter() const; | ||
| 52 | |||
| 53 | double overallHeight() const; | ||
| 54 | |||
| 55 | int numberofBlades() const; | ||
| 56 | |||
| 57 | double ratedPower() const; | ||
| 58 | |||
| 59 | double ratedWindSpeed() const; | ||
| 60 | |||
| 61 | double cutInWindSpeed() const; | ||
| 62 | |||
| 63 | double cutOutWindSpeed() const; | ||
| 64 | |||
| 65 | double fractionSystemEfficiency() const; | ||
| 66 | |||
| 67 | double maximumTipSpeedRatio() const; | ||
| 68 | |||
| 69 | double maximumPowerCoefficient() const; | ||
| 70 | |||
| 71 | boost::optional<double> annualLocalAverageWindSpeed() const; | ||
| 72 | |||
| 73 | double heightforLocalAverageWindSpeed() const; | ||
| 74 | |||
| 75 | double bladeChordArea() const; | ||
| 76 | |||
| 77 | double bladeDragCoefficient() const; | ||
| 78 | |||
| 79 | double bladeLiftCoefficient() const; | ||
| 80 | |||
| 81 | double powerCoefficientC1() const; | ||
| 82 | |||
| 83 | double powerCoefficientC2() const; | ||
| 84 | |||
| 85 | double powerCoefficientC3() const; | ||
| 86 | |||
| 87 | double powerCoefficientC4() const; | ||
| 88 | |||
| 89 | double powerCoefficientC5() const; | ||
| 90 | |||
| 91 | double powerCoefficientC6() const; | ||
| 92 | |||
| 93 | //@} | ||
| 94 | /** @name Setters */ | ||
| 95 | //@{ | ||
| 96 | |||
| 97 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 98 | |||
| 99 | bool setRotorType(const std::string& rotorType); | ||
| 100 | |||
| 101 | bool setPowerControl(const std::string& powerControl); | ||
| 102 | |||
| 103 | bool setRatedRotorSpeed(double ratedRotorSpeed); | ||
| 104 | |||
| 105 | bool setRotorDiameter(double rotorDiameter); | ||
| 106 | |||
| 107 | bool setOverallHeight(double overallHeight); | ||
| 108 | |||
| 109 | bool setNumberofBlades(int numberofBlades); | ||
| 110 | |||
| 111 | bool setRatedPower(double ratedPower); | ||
| 112 | |||
| 113 | bool setRatedWindSpeed(double ratedWindSpeed); | ||
| 114 | |||
| 115 | bool setCutInWindSpeed(double cutInWindSpeed); | ||
| 116 | |||
| 117 | bool setCutOutWindSpeed(double cutOutWindSpeed); | ||
| 118 | |||
| 119 | bool setFractionSystemEfficiency(double fractionSystemEfficiency); | ||
| 120 | |||
| 121 | bool setMaximumTipSpeedRatio(double maximumTipSpeedRatio); | ||
| 122 | |||
| 123 | bool setMaximumPowerCoefficient(double maximumPowerCoefficient); | ||
| 124 | |||
| 125 | bool setAnnualLocalAverageWindSpeed(double annualLocalAverageWindSpeed); | ||
| 126 | |||
| 127 | void resetAnnualLocalAverageWindSpeed(); | ||
| 128 | |||
| 129 | bool setHeightforLocalAverageWindSpeed(double heightforLocalAverageWindSpeed); | ||
| 130 | |||
| 131 | bool setBladeChordArea(double bladeChordArea); | ||
| 132 | |||
| 133 | bool setBladeDragCoefficient(double bladeDragCoefficient); | ||
| 134 | |||
| 135 | bool setBladeLiftCoefficient(double bladeLiftCoefficient); | ||
| 136 | |||
| 137 | bool setPowerCoefficientC1(double powerCoefficientC1); | ||
| 138 | |||
| 139 | bool setPowerCoefficientC2(double powerCoefficientC2); | ||
| 140 | |||
| 141 | bool setPowerCoefficientC3(double powerCoefficientC3); | ||
| 142 | |||
| 143 | bool setPowerCoefficientC4(double powerCoefficientC4); | ||
| 144 | |||
| 145 | bool setPowerCoefficientC5(double powerCoefficientC5); | ||
| 146 | |||
| 147 | bool setPowerCoefficientC6(double powerCoefficientC6); | ||
| 148 | |||
| 149 | //@} | ||
| 150 | /** @name Other */ | ||
| 151 | //@{ | ||
| 152 | |||
| 153 | //@} | ||
| 154 | protected: | ||
| 155 | /// @cond | ||
| 156 | using ImplType = detail::GeneratorWindTurbine_Impl; | ||
| 157 | |||
| 158 | explicit GeneratorWindTurbine(std::shared_ptr<detail::GeneratorWindTurbine_Impl> impl); | ||
| 159 | |||
| 160 | friend class detail::GeneratorWindTurbine_Impl; | ||
| 161 | friend class Model; | ||
| 162 | friend class IdfObject; | ||
| 163 | friend class openstudio::detail::IdfObject_Impl; | ||
| 164 | /// @endcond | ||
| 165 | private: | ||
| 166 | REGISTER_LOGGER("openstudio.model.GeneratorWindTurbine"); | ||
| 167 | }; | ||
| 168 | |||
| 169 | /** \relates GeneratorWindTurbine*/ | ||
| 170 | using OptionalGeneratorWindTurbine = boost::optional<GeneratorWindTurbine>; | ||
| 171 | |||
| 172 | /** \relates GeneratorWindTurbine*/ | ||
| 173 | using GeneratorWindTurbineVector = std::vector<GeneratorWindTurbine>; | ||
| 174 | |||
| 175 | } // namespace model | ||
| 176 | } // namespace openstudio | ||
| 177 | |||
| 178 | #endif // MODEL_GENERATORWINDTURBINE_HPP | ||
| 179 |