src/model/AirTerminalDualDuctVAV.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_AIRTERMINALDUALDUCTVAV_HPP | ||
| 7 | #define MODEL_AIRTERMINALDUALDUCTVAV_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Mixer.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class DesignSpecificationOutdoorAir; | ||
| 18 | class Node; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class AirTerminalDualDuctVAV_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** AirTerminalDualDuctVAV is a Mixer that wraps the OpenStudio IDD object 'OS:AirTerminal:DualDuct:VAV'. */ | ||
| 27 | class MODEL_API AirTerminalDualDuctVAV : public Mixer | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit AirTerminalDualDuctVAV(const Model& model); | ||
| 34 | |||
| 35 | 31 | virtual ~AirTerminalDualDuctVAV() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | 2 | AirTerminalDualDuctVAV(const AirTerminalDualDuctVAV& other) = default; | |
| 38 | 3 | AirTerminalDualDuctVAV(AirTerminalDualDuctVAV&& other) = default; | |
| 39 | ✗ | AirTerminalDualDuctVAV& operator=(const AirTerminalDualDuctVAV&) = default; | |
| 40 | ✗ | AirTerminalDualDuctVAV& operator=(AirTerminalDualDuctVAV&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 50 | |||
| 51 | boost::optional<double> maximumDamperAirFlowRate() const; | ||
| 52 | |||
| 53 | bool isMaximumDamperAirFlowRateAutosized() const; | ||
| 54 | |||
| 55 | double zoneMinimumAirFlowFraction() const; | ||
| 56 | |||
| 57 | boost::optional<DesignSpecificationOutdoorAir> designSpecificationOutdoorAirObject() const; | ||
| 58 | |||
| 59 | boost::optional<Schedule> minimumAirFlowTurndownSchedule() const; | ||
| 60 | |||
| 61 | //@} | ||
| 62 | /** @name Setters */ | ||
| 63 | //@{ | ||
| 64 | |||
| 65 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 66 | |||
| 67 | void resetAvailabilitySchedule(); | ||
| 68 | |||
| 69 | bool setMaximumDamperAirFlowRate(double maximumDamperAirFlowRate); | ||
| 70 | |||
| 71 | void autosizeMaximumDamperAirFlowRate(); | ||
| 72 | |||
| 73 | bool setZoneMinimumAirFlowFraction(double zoneMinimumAirFlowFraction); | ||
| 74 | |||
| 75 | bool setDesignSpecificationOutdoorAirObject(const DesignSpecificationOutdoorAir& designSpecificationOutdoorAir); | ||
| 76 | |||
| 77 | void resetDesignSpecificationOutdoorAirObject(); | ||
| 78 | |||
| 79 | bool setMinimumAirFlowTurndownSchedule(Schedule& schedule); | ||
| 80 | |||
| 81 | void resetMinimumAirFlowTurndownSchedule(); | ||
| 82 | |||
| 83 | //@} | ||
| 84 | /** @name Other */ | ||
| 85 | //@{ | ||
| 86 | |||
| 87 | /** This corresponds to Mixer::inletModelObject(0), as well as the system's branch 0 | ||
| 88 | * (ie. AirLoopHVAC::demandInletNodes()[0] and AirLoopHVAC::supplyOutletNodes()[0]) | ||
| 89 | * In OpenStudio we avoid using hot / cold nomenclature in the dual duct system api, | ||
| 90 | * but here in the terminal interface we use the language for transparency with the idf. | ||
| 91 | */ | ||
| 92 | boost::optional<Node> hotAirInletNode() const; | ||
| 93 | |||
| 94 | /** This corresponds to Mixer::inletModelObject(1), as well as the system's branch 1 | ||
| 95 | * (ie. AirLoopHVAC::demandInletNodes()[1] and AirLoopHVAC::supplyOutletNodes()[1]) | ||
| 96 | */ | ||
| 97 | boost::optional<Node> coldAirInletNode() const; | ||
| 98 | |||
| 99 | /* Queries the autosized value from the SQL file */ | ||
| 100 | boost::optional<double> autosizedMaximumDamperAirFlowRate() const; | ||
| 101 | |||
| 102 | /* Autosize all autosizeable fields */ | ||
| 103 | // void autosize(); | ||
| 104 | |||
| 105 | /* Hard applies the autosized values from SQL file */ | ||
| 106 | // void applySizingValues(); | ||
| 107 | |||
| 108 | //@} | ||
| 109 | protected: | ||
| 110 | /// @cond | ||
| 111 | using ImplType = detail::AirTerminalDualDuctVAV_Impl; | ||
| 112 | |||
| 113 | explicit AirTerminalDualDuctVAV(std::shared_ptr<detail::AirTerminalDualDuctVAV_Impl> impl); | ||
| 114 | |||
| 115 | friend class detail::AirTerminalDualDuctVAV_Impl; | ||
| 116 | friend class Model; | ||
| 117 | friend class IdfObject; | ||
| 118 | friend class openstudio::detail::IdfObject_Impl; | ||
| 119 | /// @endcond | ||
| 120 | private: | ||
| 121 | REGISTER_LOGGER("openstudio.model.AirTerminalDualDuctVAV"); | ||
| 122 | }; | ||
| 123 | |||
| 124 | /** \relates AirTerminalDualDuctVAV*/ | ||
| 125 | using OptionalAirTerminalDualDuctVAV = boost::optional<AirTerminalDualDuctVAV>; | ||
| 126 | |||
| 127 | /** \relates AirTerminalDualDuctVAV*/ | ||
| 128 | using AirTerminalDualDuctVAVVector = std::vector<AirTerminalDualDuctVAV>; | ||
| 129 | |||
| 130 | } // namespace model | ||
| 131 | } // namespace openstudio | ||
| 132 | |||
| 133 | #endif // MODEL_AIRTERMINALDUALDUCTVAV_HPP | ||
| 134 |