src/model/ZoneVentilationDesignFlowRate.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_ZONEVENTILATIONDESIGNFLOWRATE_HPP | ||
| 7 | #define MODEL_ZONEVENTILATIONDESIGNFLOWRATE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class ZoneVentilationDesignFlowRate_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** ZoneVentilationDesignFlowRate is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneVentilation:DesignFlowRate'. */ | ||
| 25 | class MODEL_API ZoneVentilationDesignFlowRate : public ZoneHVACComponent | ||
| 26 | { | ||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | explicit ZoneVentilationDesignFlowRate(const Model& model); | ||
| 32 | |||
| 33 | 8 | virtual ~ZoneVentilationDesignFlowRate() override = default; | |
| 34 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 35 | ✗ | ZoneVentilationDesignFlowRate(const ZoneVentilationDesignFlowRate& other) = default; | |
| 36 | ✗ | ZoneVentilationDesignFlowRate(ZoneVentilationDesignFlowRate&& other) = default; | |
| 37 | ✗ | ZoneVentilationDesignFlowRate& operator=(const ZoneVentilationDesignFlowRate&) = default; | |
| 38 | ✗ | ZoneVentilationDesignFlowRate& operator=(ZoneVentilationDesignFlowRate&&) = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | |||
| 42 | static IddObjectType iddObjectType(); | ||
| 43 | |||
| 44 | static std::vector<std::string> designFlowRateCalculationMethodValues(); | ||
| 45 | |||
| 46 | static std::vector<std::string> ventilationTypeValues(); | ||
| 47 | |||
| 48 | static std::vector<std::string> densityBasisValues(); | ||
| 49 | |||
| 50 | /** @name Getters */ | ||
| 51 | //@{ | ||
| 52 | |||
| 53 | Schedule schedule() const; | ||
| 54 | |||
| 55 | std::string designFlowRateCalculationMethod() const; | ||
| 56 | |||
| 57 | double designFlowRate() const; | ||
| 58 | |||
| 59 | double flowRateperZoneFloorArea() const; | ||
| 60 | |||
| 61 | double flowRateperPerson() const; | ||
| 62 | |||
| 63 | double airChangesperHour() const; | ||
| 64 | |||
| 65 | std::string ventilationType() const; | ||
| 66 | |||
| 67 | double fanPressureRise() const; | ||
| 68 | |||
| 69 | double fanTotalEfficiency() const; | ||
| 70 | |||
| 71 | double constantTermCoefficient() const; | ||
| 72 | |||
| 73 | double temperatureTermCoefficient() const; | ||
| 74 | |||
| 75 | double velocityTermCoefficient() const; | ||
| 76 | |||
| 77 | double velocitySquaredTermCoefficient() const; | ||
| 78 | |||
| 79 | double minimumIndoorTemperature() const; | ||
| 80 | |||
| 81 | boost::optional<Schedule> minimumIndoorTemperatureSchedule() const; | ||
| 82 | |||
| 83 | double maximumIndoorTemperature() const; | ||
| 84 | |||
| 85 | boost::optional<Schedule> maximumIndoorTemperatureSchedule() const; | ||
| 86 | |||
| 87 | double deltaTemperature() const; | ||
| 88 | |||
| 89 | boost::optional<Schedule> deltaTemperatureSchedule() const; | ||
| 90 | |||
| 91 | double minimumOutdoorTemperature() const; | ||
| 92 | |||
| 93 | boost::optional<Schedule> minimumOutdoorTemperatureSchedule() const; | ||
| 94 | |||
| 95 | double maximumOutdoorTemperature() const; | ||
| 96 | |||
| 97 | boost::optional<Schedule> maximumOutdoorTemperatureSchedule() const; | ||
| 98 | |||
| 99 | double maximumWindSpeed() const; | ||
| 100 | |||
| 101 | std::string densityBasis() const; | ||
| 102 | |||
| 103 | //@} | ||
| 104 | /** @name Setters */ | ||
| 105 | //@{ | ||
| 106 | |||
| 107 | bool setSchedule(Schedule& schedule); | ||
| 108 | |||
| 109 | bool setDesignFlowRate(double designFlowRate); | ||
| 110 | |||
| 111 | bool setFlowRateperZoneFloorArea(double flowRateperZoneFloorArea); | ||
| 112 | |||
| 113 | bool setFlowRateperPerson(double flowRateperPerson); | ||
| 114 | |||
| 115 | bool setAirChangesperHour(double airChangesperHour); | ||
| 116 | |||
| 117 | bool setVentilationType(const std::string& ventilationType); | ||
| 118 | |||
| 119 | bool setFanPressureRise(double fanPressureRise); | ||
| 120 | |||
| 121 | bool setFanTotalEfficiency(double fanTotalEfficiency); | ||
| 122 | |||
| 123 | bool setConstantTermCoefficient(double constantTermCoefficient); | ||
| 124 | |||
| 125 | bool setTemperatureTermCoefficient(double temperatureTermCoefficient); | ||
| 126 | |||
| 127 | bool setVelocityTermCoefficient(double velocityTermCoefficient); | ||
| 128 | |||
| 129 | bool setVelocitySquaredTermCoefficient(double velocitySquaredTermCoefficient); | ||
| 130 | |||
| 131 | bool setMinimumIndoorTemperature(double minimumIndoorTemperature); | ||
| 132 | |||
| 133 | bool setMinimumIndoorTemperatureSchedule(Schedule& schedule); | ||
| 134 | |||
| 135 | void resetMinimumIndoorTemperatureSchedule(); | ||
| 136 | |||
| 137 | bool setMaximumIndoorTemperature(double maximumIndoorTemperature); | ||
| 138 | |||
| 139 | bool setMaximumIndoorTemperatureSchedule(Schedule& schedule); | ||
| 140 | |||
| 141 | void resetMaximumIndoorTemperatureSchedule(); | ||
| 142 | |||
| 143 | bool setDeltaTemperature(double deltaTemperature); | ||
| 144 | |||
| 145 | bool setDeltaTemperatureSchedule(Schedule& schedule); | ||
| 146 | |||
| 147 | void resetDeltaTemperatureSchedule(); | ||
| 148 | |||
| 149 | bool setMinimumOutdoorTemperature(double minimumOutdoorTemperature); | ||
| 150 | |||
| 151 | bool setMinimumOutdoorTemperatureSchedule(Schedule& schedule); | ||
| 152 | |||
| 153 | void resetMinimumOutdoorTemperatureSchedule(); | ||
| 154 | |||
| 155 | bool setMaximumOutdoorTemperature(double maximumOutdoorTemperature); | ||
| 156 | |||
| 157 | bool setMaximumOutdoorTemperatureSchedule(Schedule& schedule); | ||
| 158 | |||
| 159 | void resetMaximumOutdoorTemperatureSchedule(); | ||
| 160 | |||
| 161 | bool setMaximumWindSpeed(double maximumWindSpeed); | ||
| 162 | |||
| 163 | bool setDensityBasis(const std::string& densityBasis); | ||
| 164 | |||
| 165 | //@} | ||
| 166 | /** @name Other */ | ||
| 167 | //@{ | ||
| 168 | |||
| 169 | //@} | ||
| 170 | protected: | ||
| 171 | /// @cond | ||
| 172 | using ImplType = detail::ZoneVentilationDesignFlowRate_Impl; | ||
| 173 | |||
| 174 | explicit ZoneVentilationDesignFlowRate(std::shared_ptr<detail::ZoneVentilationDesignFlowRate_Impl> impl); | ||
| 175 | |||
| 176 | friend class detail::ZoneVentilationDesignFlowRate_Impl; | ||
| 177 | friend class Model; | ||
| 178 | friend class IdfObject; | ||
| 179 | friend class openstudio::detail::IdfObject_Impl; | ||
| 180 | /// @endcond | ||
| 181 | private: | ||
| 182 | REGISTER_LOGGER("openstudio.model.ZoneVentilationDesignFlowRate"); | ||
| 183 | }; | ||
| 184 | |||
| 185 | /** \relates ZoneVentilationDesignFlowRate*/ | ||
| 186 | using OptionalZoneVentilationDesignFlowRate = boost::optional<ZoneVentilationDesignFlowRate>; | ||
| 187 | |||
| 188 | /** \relates ZoneVentilationDesignFlowRate*/ | ||
| 189 | using ZoneVentilationDesignFlowRateVector = std::vector<ZoneVentilationDesignFlowRate>; | ||
| 190 | |||
| 191 | } // namespace model | ||
| 192 | } // namespace openstudio | ||
| 193 | |||
| 194 | #endif // MODEL_ZONEVENTILATIONDESIGNFLOWRATE_HPP | ||
| 195 |