src/model/ZoneHVACUnitHeater.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_ZONEHVACUNITHEATER_HPP | ||
| 7 | #define MODEL_ZONEHVACUNITHEATER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class HVACComponent; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class ZoneHVACUnitHeater_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACUnitHeater is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:UnitHeater'. */ | ||
| 26 | |||
| 27 | class MODEL_API ZoneHVACUnitHeater : public ZoneHVACComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | |||
| 32 | ZoneHVACUnitHeater(const Model& model, Schedule& availabilitySchedule, HVACComponent& supplyAirFan, HVACComponent& heatingCoil); | ||
| 33 | |||
| 34 | 21 | virtual ~ZoneHVACUnitHeater() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | ✗ | ZoneHVACUnitHeater(const ZoneHVACUnitHeater& other) = default; | |
| 37 | ✗ | ZoneHVACUnitHeater(ZoneHVACUnitHeater&& other) = default; | |
| 38 | ✗ | ZoneHVACUnitHeater& operator=(const ZoneHVACUnitHeater&) = default; | |
| 39 | ✗ | ZoneHVACUnitHeater& operator=(ZoneHVACUnitHeater&&) = default; | |
| 40 | |||
| 41 | static IddObjectType iddObjectType(); | ||
| 42 | |||
| 43 | static std::vector<std::string> fanControlTypeValues(); | ||
| 44 | |||
| 45 | /** @name Getters */ | ||
| 46 | |||
| 47 | Schedule availabilitySchedule() const; | ||
| 48 | |||
| 49 | HVACComponent supplyAirFan() const; | ||
| 50 | |||
| 51 | boost::optional<double> maximumSupplyAirFlowRate() const; | ||
| 52 | |||
| 53 | bool isMaximumSupplyAirFlowRateAutosized() const; | ||
| 54 | |||
| 55 | /** In EnergyPlus 8.2.0 and above this property maps to the EnergyPlus field "Supply Air Fan Operation During No Heating" **/ | ||
| 56 | std::string fanControlType() const; | ||
| 57 | |||
| 58 | HVACComponent heatingCoil() const; | ||
| 59 | |||
| 60 | boost::optional<double> maximumHotWaterFlowRate() const; | ||
| 61 | |||
| 62 | bool isMaximumHotWaterFlowRateAutosized() const; | ||
| 63 | |||
| 64 | double minimumHotWaterFlowRate() const; | ||
| 65 | |||
| 66 | bool isMinimumHotWaterFlowRateDefaulted() const; | ||
| 67 | |||
| 68 | double heatingConvergenceTolerance() const; | ||
| 69 | |||
| 70 | bool isHeatingConvergenceToleranceDefaulted() const; | ||
| 71 | |||
| 72 | /** @name Setters */ | ||
| 73 | |||
| 74 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 75 | |||
| 76 | bool setSupplyAirFan(const HVACComponent& fan); | ||
| 77 | |||
| 78 | bool setMaximumSupplyAirFlowRate(double maximumSupplyAirFlowRate); | ||
| 79 | |||
| 80 | void autosizeMaximumSupplyAirFlowRate(); | ||
| 81 | |||
| 82 | bool setFanControlType(const std::string& fanControlType); | ||
| 83 | |||
| 84 | bool setHeatingCoil(const HVACComponent& heatingCoil); | ||
| 85 | |||
| 86 | bool setMaximumHotWaterFlowRate(double maximumHotWaterFlowRate); | ||
| 87 | |||
| 88 | void resetMaximumHotWaterFlowRate(); | ||
| 89 | |||
| 90 | void autosizeMaximumHotWaterFlowRate(); | ||
| 91 | |||
| 92 | bool setMinimumHotWaterFlowRate(double minimumHotWaterFlowRate); | ||
| 93 | |||
| 94 | void resetMinimumHotWaterFlowRate(); | ||
| 95 | |||
| 96 | bool setHeatingConvergenceTolerance(double heatingConvergenceTolerance); | ||
| 97 | |||
| 98 | void resetHeatingConvergenceTolerance(); | ||
| 99 | |||
| 100 | /** @name Other */ | ||
| 101 | |||
| 102 | boost::optional<double> autosizedMaximumSupplyAirFlowRate() const; | ||
| 103 | |||
| 104 | boost::optional<double> autosizedMaximumHotWaterFlowRate() const; | ||
| 105 | |||
| 106 | protected: | ||
| 107 | /// @cond | ||
| 108 | using ImplType = detail::ZoneHVACUnitHeater_Impl; | ||
| 109 | |||
| 110 | explicit ZoneHVACUnitHeater(std::shared_ptr<detail::ZoneHVACUnitHeater_Impl> impl); | ||
| 111 | |||
| 112 | friend class detail::ZoneHVACUnitHeater_Impl; | ||
| 113 | friend class Model; | ||
| 114 | friend class IdfObject; | ||
| 115 | friend class openstudio::detail::IdfObject_Impl; | ||
| 116 | /// @endcond | ||
| 117 | |||
| 118 | private: | ||
| 119 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACUnitHeater"); | |
| 120 | }; | ||
| 121 | |||
| 122 | /** \relates ZoneHVACUnitHeater*/ | ||
| 123 | using OptionalZoneHVACUnitHeater = boost::optional<ZoneHVACUnitHeater>; | ||
| 124 | |||
| 125 | /** \relates ZoneHVACUnitHeater*/ | ||
| 126 | using ZoneHVACUnitHeaterVector = std::vector<ZoneHVACUnitHeater>; | ||
| 127 | |||
| 128 | } // namespace model | ||
| 129 | } // namespace openstudio | ||
| 130 | |||
| 131 | #endif // MODEL_ZONEHVACUNITHEATER_HPP | ||
| 132 |