src/model/ZoneHVACEnergyRecoveryVentilator.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_ZONEHVACENERGYRECOVERYVENTILATOR_HPP | ||
| 7 | #define MODEL_ZONEHVACENERGYRECOVERYVENTILATOR_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 | class ZoneHVACEnergyRecoveryVentilatorController; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class ZoneHVACEnergyRecoveryVentilator_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** ZoneHVACEnergyRecoveryVentilator is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:EnergyRecoveryVentilator'. */ | ||
| 27 | class MODEL_API ZoneHVACEnergyRecoveryVentilator : public ZoneHVACComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit ZoneHVACEnergyRecoveryVentilator(const Model& model); | ||
| 34 | |||
| 35 | explicit ZoneHVACEnergyRecoveryVentilator(const Model& model, const HVACComponent& heatExchanger, const HVACComponent& supplyAirFan, | ||
| 36 | const HVACComponent& exhaustAirFan); | ||
| 37 | |||
| 38 | 4 | virtual ~ZoneHVACEnergyRecoveryVentilator() override = default; | |
| 39 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 40 | ✗ | ZoneHVACEnergyRecoveryVentilator(const ZoneHVACEnergyRecoveryVentilator& other) = default; | |
| 41 | ✗ | ZoneHVACEnergyRecoveryVentilator(ZoneHVACEnergyRecoveryVentilator&& other) = default; | |
| 42 | ✗ | ZoneHVACEnergyRecoveryVentilator& operator=(const ZoneHVACEnergyRecoveryVentilator&) = default; | |
| 43 | ✗ | ZoneHVACEnergyRecoveryVentilator& operator=(ZoneHVACEnergyRecoveryVentilator&&) = default; | |
| 44 | |||
| 45 | //@} | ||
| 46 | |||
| 47 | static IddObjectType iddObjectType(); | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | Schedule availabilitySchedule() const; | ||
| 53 | |||
| 54 | HVACComponent heatExchanger() const; | ||
| 55 | |||
| 56 | boost::optional<double> supplyAirFlowRate() const; | ||
| 57 | |||
| 58 | bool isSupplyAirFlowRateAutosized() const; | ||
| 59 | |||
| 60 | boost::optional<double> exhaustAirFlowRate() const; | ||
| 61 | |||
| 62 | bool isExhaustAirFlowRateAutosized() const; | ||
| 63 | |||
| 64 | HVACComponent supplyAirFan() const; | ||
| 65 | |||
| 66 | HVACComponent exhaustAirFan() const; | ||
| 67 | |||
| 68 | boost::optional<ZoneHVACEnergyRecoveryVentilatorController> controller() const; | ||
| 69 | |||
| 70 | double ventilationRateperUnitFloorArea() const; | ||
| 71 | |||
| 72 | double ventilationRateperOccupant() const; | ||
| 73 | |||
| 74 | // boost::optional<ModelObject> availabilityManagerList() const; | ||
| 75 | |||
| 76 | //@} | ||
| 77 | /** @name Setters */ | ||
| 78 | //@{ | ||
| 79 | |||
| 80 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 81 | |||
| 82 | bool setHeatExchanger(const HVACComponent& hxAirToAirSensibleAndLatent); | ||
| 83 | |||
| 84 | bool setSupplyAirFlowRate(double supplyAirFlowRate); | ||
| 85 | |||
| 86 | void autosizeSupplyAirFlowRate(); | ||
| 87 | |||
| 88 | bool setExhaustAirFlowRate(double exhaustAirFlowRate); | ||
| 89 | |||
| 90 | void autosizeExhaustAirFlowRate(); | ||
| 91 | |||
| 92 | bool setSupplyAirFan(const HVACComponent& supplyAirFan); | ||
| 93 | |||
| 94 | bool setExhaustAirFan(const HVACComponent& exhaustAirFan); | ||
| 95 | |||
| 96 | bool setController(const ZoneHVACEnergyRecoveryVentilatorController& zoneHVACEnergyRecoveryVentilatorController); | ||
| 97 | |||
| 98 | void resetController(); | ||
| 99 | |||
| 100 | bool setVentilationRateperUnitFloorArea(double ventilationRateperUnitFloorArea); | ||
| 101 | |||
| 102 | bool setVentilationRateperOccupant(double ventilationRateperOccupant); | ||
| 103 | |||
| 104 | // bool setAvailabilityManagerList(const ModelObject& systemAvailabilityManagerLists); | ||
| 105 | |||
| 106 | // void resetAvailabilityManagerList(); | ||
| 107 | |||
| 108 | //@} | ||
| 109 | /** @name Other */ | ||
| 110 | //@{ | ||
| 111 | |||
| 112 | boost::optional<double> autosizedSupplyAirFlowRate() const; | ||
| 113 | |||
| 114 | boost::optional<double> autosizedExhaustAirFlowRate() const; | ||
| 115 | |||
| 116 | //@} | ||
| 117 | protected: | ||
| 118 | /// @cond | ||
| 119 | using ImplType = detail::ZoneHVACEnergyRecoveryVentilator_Impl; | ||
| 120 | |||
| 121 | explicit ZoneHVACEnergyRecoveryVentilator(std::shared_ptr<detail::ZoneHVACEnergyRecoveryVentilator_Impl> impl); | ||
| 122 | |||
| 123 | friend class detail::ZoneHVACEnergyRecoveryVentilator_Impl; | ||
| 124 | friend class Model; | ||
| 125 | friend class IdfObject; | ||
| 126 | friend class openstudio::detail::IdfObject_Impl; | ||
| 127 | /// @endcond | ||
| 128 | private: | ||
| 129 | REGISTER_LOGGER("openstudio.model.ZoneHVACEnergyRecoveryVentilator"); | ||
| 130 | }; | ||
| 131 | |||
| 132 | /** \relates ZoneHVACEnergyRecoveryVentilator*/ | ||
| 133 | using OptionalZoneHVACEnergyRecoveryVentilator = boost::optional<ZoneHVACEnergyRecoveryVentilator>; | ||
| 134 | |||
| 135 | /** \relates ZoneHVACEnergyRecoveryVentilator*/ | ||
| 136 | using ZoneHVACEnergyRecoveryVentilatorVector = std::vector<ZoneHVACEnergyRecoveryVentilator>; | ||
| 137 | |||
| 138 | } // namespace model | ||
| 139 | } // namespace openstudio | ||
| 140 | |||
| 141 | #endif // MODEL_ZONEHVACENERGYRECOVERYVENTILATOR_HPP | ||
| 142 |