src/model/ElectricEquipmentITEAirCooledDefinition.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_ELECTRICEQUIPMENTITEAIRCOOLEDDEFINITION_HPP | ||
| 7 | #define MODEL_ELECTRICEQUIPMENTITEAIRCOOLEDDEFINITION_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "SpaceLoadDefinition.hpp" | ||
| 11 | |||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Curve; | ||
| 19 | class Connection; | ||
| 20 | class Schedule; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class ElectricEquipmentITEAirCooledDefinition_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** ElectricEquipmentITEAirCooledDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS:ElectricEquipment:ITE:AirCooled:Definition'. */ | ||
| 29 | class MODEL_API ElectricEquipmentITEAirCooledDefinition : public SpaceLoadDefinition | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | explicit ElectricEquipmentITEAirCooledDefinition(const Model& model, const Curve& cPUPowerInputFunctionofLoadingandAirTemperatureCurve, | ||
| 36 | const Curve& airFlowFunctionofLoadingandAirTemperatureCurve, | ||
| 37 | const Curve& fanPowerInputFunctionofFlowCurve); | ||
| 38 | |||
| 39 | /** Create ElectricEquipmentITEAirCooledDefinition with default curves **/ | ||
| 40 | explicit ElectricEquipmentITEAirCooledDefinition(const Model& model); | ||
| 41 | |||
| 42 | 203 | virtual ~ElectricEquipmentITEAirCooledDefinition() override = default; | |
| 43 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 44 | ✗ | ElectricEquipmentITEAirCooledDefinition(const ElectricEquipmentITEAirCooledDefinition& other) = default; | |
| 45 | 3 | ElectricEquipmentITEAirCooledDefinition(ElectricEquipmentITEAirCooledDefinition&& other) = default; | |
| 46 | ✗ | ElectricEquipmentITEAirCooledDefinition& operator=(const ElectricEquipmentITEAirCooledDefinition&) = default; | |
| 47 | ✗ | ElectricEquipmentITEAirCooledDefinition& operator=(ElectricEquipmentITEAirCooledDefinition&&) = default; | |
| 48 | |||
| 49 | //@} | ||
| 50 | |||
| 51 | static IddObjectType iddObjectType(); | ||
| 52 | |||
| 53 | static std::vector<std::string> validAirFlowCalculationMethodValues(); | ||
| 54 | |||
| 55 | static std::vector<std::string> validDesignPowerInputCalculationMethodValues(); | ||
| 56 | |||
| 57 | static std::vector<std::string> validEnvironmentalClassValues(); | ||
| 58 | |||
| 59 | static std::vector<std::string> validAirInletConnectionTypeValues(); | ||
| 60 | |||
| 61 | /** @name Getters */ | ||
| 62 | //@{ | ||
| 63 | |||
| 64 | std::string airFlowCalculationMethod() const; | ||
| 65 | |||
| 66 | std::string designPowerInputCalculationMethod() const; | ||
| 67 | |||
| 68 | boost::optional<double> designLevel() const; | ||
| 69 | OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperUnit() const; | ||
| 70 | |||
| 71 | boost::optional<double> wattsperSpaceFloorArea() const; | ||
| 72 | OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperZoneFloorArea() const; | ||
| 73 | |||
| 74 | Curve cPUPowerInputFunctionofLoadingandAirTemperatureCurve() const; | ||
| 75 | |||
| 76 | double designFanPowerInputFraction() const; | ||
| 77 | |||
| 78 | bool isDesignFanPowerInputFractionDefaulted() const; | ||
| 79 | |||
| 80 | boost::optional<double> designFanAirFlowRateperPowerInput() const; | ||
| 81 | |||
| 82 | Curve airFlowFunctionofLoadingandAirTemperatureCurve() const; | ||
| 83 | |||
| 84 | Curve fanPowerInputFunctionofFlowCurve() const; | ||
| 85 | |||
| 86 | double designEnteringAirTemperature() const; | ||
| 87 | |||
| 88 | bool isDesignEnteringAirTemperatureDefaulted() const; | ||
| 89 | |||
| 90 | std::string environmentalClass() const; | ||
| 91 | |||
| 92 | std::string airInletConnectionType() const; | ||
| 93 | |||
| 94 | double designRecirculationFraction() const; | ||
| 95 | |||
| 96 | bool isDesignRecirculationFractionDefaulted() const; | ||
| 97 | |||
| 98 | boost::optional<Curve> recirculationFunctionofLoadingandSupplyTemperatureCurve() const; | ||
| 99 | |||
| 100 | double designElectricPowerSupplyEfficiency() const; | ||
| 101 | |||
| 102 | bool isDesignElectricPowerSupplyEfficiencyDefaulted() const; | ||
| 103 | |||
| 104 | boost::optional<Curve> electricPowerSupplyEfficiencyFunctionofPartLoadRatioCurve() const; | ||
| 105 | |||
| 106 | double fractionofElectricPowerSupplyLossestoZone() const; | ||
| 107 | |||
| 108 | bool isFractionofElectricPowerSupplyLossestoZoneDefaulted() const; | ||
| 109 | |||
| 110 | double supplyTemperatureDifference() const; | ||
| 111 | |||
| 112 | bool isSupplyTemperatureDifferenceDefaulted() const; | ||
| 113 | |||
| 114 | boost::optional<Schedule> supplyTemperatureDifferenceSchedule() const; | ||
| 115 | |||
| 116 | double returnTemperatureDifference() const; | ||
| 117 | |||
| 118 | bool isReturnTemperatureDifferenceDefaulted() const; | ||
| 119 | |||
| 120 | boost::optional<Schedule> returnTemperatureDifferenceSchedule() const; | ||
| 121 | |||
| 122 | //@} | ||
| 123 | /** @name Setters */ | ||
| 124 | //@{ | ||
| 125 | |||
| 126 | bool setAirFlowCalculationMethod(const std::string& airFlowCalculationMethod); | ||
| 127 | |||
| 128 | /** Also sets setDesignPowerInputCalculationMethod accordingly. */ | ||
| 129 | bool setDesignLevel(double designLevel); | ||
| 130 | OS_DEPRECATED(3, 8, 0) bool setWattsperUnit(double designLevel); | ||
| 131 | |||
| 132 | /** Also sets setDesignPowerInputCalculationMethod accordingly. */ | ||
| 133 | bool setWattsperSpaceFloorArea(double wattsperSpaceFloorArea); | ||
| 134 | OS_DEPRECATED(3, 8, 0) bool setWattsperZoneFloorArea(double wattsperSpaceFloorArea); | ||
| 135 | |||
| 136 | bool setCPUPowerInputFunctionofLoadingandAirTemperatureCurve(const Curve& curve); | ||
| 137 | |||
| 138 | bool setDesignFanPowerInputFraction(double designFanPowerInputFraction); | ||
| 139 | |||
| 140 | void resetDesignFanPowerInputFraction(); | ||
| 141 | |||
| 142 | bool setDesignFanAirFlowRateperPowerInput(double designFanAirFlowRateperPowerInput); | ||
| 143 | |||
| 144 | bool setAirFlowFunctionofLoadingandAirTemperatureCurve(const Curve& curve); | ||
| 145 | |||
| 146 | bool setFanPowerInputFunctionofFlowCurve(const Curve& curve); | ||
| 147 | |||
| 148 | void setDesignEnteringAirTemperature(double designEnteringAirTemperature); | ||
| 149 | |||
| 150 | void resetDesignEnteringAirTemperature(); | ||
| 151 | |||
| 152 | bool setEnvironmentalClass(const std::string& environmentalClass); | ||
| 153 | |||
| 154 | bool setAirInletConnectionType(const std::string& airInletConnectionType); | ||
| 155 | |||
| 156 | bool setDesignRecirculationFraction(double designRecirculationFraction); | ||
| 157 | |||
| 158 | void resetDesignRecirculationFraction(); | ||
| 159 | |||
| 160 | bool setRecirculationFunctionofLoadingandSupplyTemperatureCurve(const Curve& curve); | ||
| 161 | |||
| 162 | void resetRecirculationFunctionofLoadingandSupplyTemperatureCurve(); | ||
| 163 | |||
| 164 | bool setDesignElectricPowerSupplyEfficiency(double designElectricPowerSupplyEfficiency); | ||
| 165 | |||
| 166 | void resetDesignElectricPowerSupplyEfficiency(); | ||
| 167 | |||
| 168 | bool setElectricPowerSupplyEfficiencyFunctionofPartLoadRatioCurve(const Curve& curve); | ||
| 169 | |||
| 170 | void resetElectricPowerSupplyEfficiencyFunctionofPartLoadRatioCurve(); | ||
| 171 | |||
| 172 | bool setFractionofElectricPowerSupplyLossestoZone(double fractionofElectricPowerSupplyLossestoZone); | ||
| 173 | |||
| 174 | void resetFractionofElectricPowerSupplyLossestoZone(); | ||
| 175 | |||
| 176 | bool setSupplyTemperatureDifference(double supplyTemperatureDifference); | ||
| 177 | |||
| 178 | void resetSupplyTemperatureDifference(); | ||
| 179 | |||
| 180 | // Note Schedules are passed by reference, not const reference. | ||
| 181 | bool setSupplyTemperatureDifferenceSchedule(Schedule& schedule); | ||
| 182 | |||
| 183 | void resetSupplyTemperatureDifferenceSchedule(); | ||
| 184 | |||
| 185 | bool setReturnTemperatureDifference(double returnTemperatureDifference); | ||
| 186 | |||
| 187 | void resetReturnTemperatureDifference(); | ||
| 188 | |||
| 189 | // Note Schedules are passed by reference, not const reference. | ||
| 190 | bool setReturnTemperatureDifferenceSchedule(Schedule& schedule); | ||
| 191 | |||
| 192 | void resetReturnTemperatureDifferenceSchedule(); | ||
| 193 | |||
| 194 | //@} | ||
| 195 | /** @name Other */ | ||
| 196 | //@{ | ||
| 197 | |||
| 198 | /** Returns the design level represented by this definition, assuming floorArea (m^2). */ | ||
| 199 | double getDesignLevel(double floorArea) const; | ||
| 200 | OS_DEPRECATED(3, 8, 0) double getWattsperUnit(double floorArea) const; | ||
| 201 | |||
| 202 | /** Returns the watts/m^2 represented by this definition, assuming floorArea (m^2) */ | ||
| 203 | double getPowerPerFloorArea(double floorArea) const; | ||
| 204 | OS_DEPRECATED(3, 8, 0) double getWattsperZoneFloorArea(double floorArea) const; | ||
| 205 | |||
| 206 | /** If method is a \link validDesignPowerInputCalculationMethodValues valid design power input calculation method \endlink, | ||
| 207 | * changes this definition to an equivalent power level, under the assumptions of floorArea (m^2). */ | ||
| 208 | bool setDesignPowerInputCalculationMethod(const std::string& designPowerInputCalculationMethod, double floorArea); | ||
| 209 | |||
| 210 | //@} | ||
| 211 | protected: | ||
| 212 | /// @cond | ||
| 213 | using ImplType = detail::ElectricEquipmentITEAirCooledDefinition_Impl; | ||
| 214 | |||
| 215 | explicit ElectricEquipmentITEAirCooledDefinition(std::shared_ptr<detail::ElectricEquipmentITEAirCooledDefinition_Impl> impl); | ||
| 216 | |||
| 217 | friend class Model; | ||
| 218 | friend class openstudio::IdfObject; | ||
| 219 | |||
| 220 | /// @endcond | ||
| 221 | private: | ||
| 222 | − | REGISTER_LOGGER("openstudio.model.ElectricEquipmentITEAirCooledDefinition"); | |
| 223 | }; | ||
| 224 | |||
| 225 | /** \relates ElectricEquipmentITEAirCooledDefinition*/ | ||
| 226 | using OptionalElectricEquipmentITEAirCooledDefinition = boost::optional<ElectricEquipmentITEAirCooledDefinition>; | ||
| 227 | |||
| 228 | /** \relates ElectricEquipmentITEAirCooledDefinition*/ | ||
| 229 | using ElectricEquipmentITEAirCooledDefinitionVector = std::vector<ElectricEquipmentITEAirCooledDefinition>; | ||
| 230 | |||
| 231 | } // namespace model | ||
| 232 | } // namespace openstudio | ||
| 233 | |||
| 234 | #endif // MODEL_ELECTRICEQUIPMENTITEAIRCOOLEDDEFINITION_HPP | ||
| 235 |