src/model/AirTerminalSingleDuctParallelPIUReheat_Impl.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_AIRTERMINALSINGLEDUCTPARALLELPIUREHEAT_IMPL_HPP | ||
| 7 | #define MODEL_AIRTERMINALSINGLEDUCTPARALLELPIUREHEAT_IMPL_HPP | ||
| 8 | |||
| 9 | #include "StraightComponent_Impl.hpp" | ||
| 10 | |||
| 11 | namespace openstudio { | ||
| 12 | |||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** AirTerminalSingleDuctParallelPIUReheat_Impl is a StraightComponent_Impl that is the implementation class for AirTerminalSingleDuctParallelPIUReheat.*/ | ||
| 20 | class MODEL_API AirTerminalSingleDuctParallelPIUReheat_Impl : public StraightComponent_Impl | ||
| 21 | { | ||
| 22 | |||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | AirTerminalSingleDuctParallelPIUReheat_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | AirTerminalSingleDuctParallelPIUReheat_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | AirTerminalSingleDuctParallelPIUReheat_Impl(const AirTerminalSingleDuctParallelPIUReheat_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | 18 | virtual ~AirTerminalSingleDuctParallelPIUReheat_Impl() override = default; | |
| 34 | |||
| 35 | //@} | ||
| 36 | /** @name Virtual Methods */ | ||
| 37 | //@{ | ||
| 38 | |||
| 39 | virtual ModelObject clone(Model model) const override; | ||
| 40 | |||
| 41 | virtual std::vector<openstudio::IdfObject> remove() override; | ||
| 42 | |||
| 43 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 44 | |||
| 45 | virtual IddObjectType iddObjectType() const override; | ||
| 46 | |||
| 47 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 48 | |||
| 49 | virtual std::vector<ModelObject> children() const override; | ||
| 50 | |||
| 51 | virtual unsigned inletPort() const override; | ||
| 52 | |||
| 53 | virtual unsigned outletPort() const override; | ||
| 54 | |||
| 55 | virtual bool addToNode(Node& node) override; | ||
| 56 | |||
| 57 | virtual ComponentType componentType() const override; | ||
| 58 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 59 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 60 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 61 | |||
| 62 | //@} | ||
| 63 | /** @name Getters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | Schedule availabilitySchedule() const; | ||
| 67 | |||
| 68 | boost::optional<double> maximumPrimaryAirFlowRate() const; | ||
| 69 | |||
| 70 | bool isMaximumPrimaryAirFlowRateAutosized() const; | ||
| 71 | |||
| 72 | boost::optional<double> maximumSecondaryAirFlowRate() const; | ||
| 73 | |||
| 74 | bool isMaximumSecondaryAirFlowRateAutosized() const; | ||
| 75 | |||
| 76 | boost::optional<double> minimumPrimaryAirFlowFraction() const; | ||
| 77 | |||
| 78 | bool isMinimumPrimaryAirFlowFractionAutosized() const; | ||
| 79 | |||
| 80 | boost::optional<double> fanOnFlowFraction() const; | ||
| 81 | |||
| 82 | bool isFanOnFlowFractionAutosized() const; | ||
| 83 | |||
| 84 | boost::optional<Node> secondaryAirInletNode() const; | ||
| 85 | |||
| 86 | unsigned secondaryAirInletPort() const; | ||
| 87 | |||
| 88 | HVACComponent fan() const; | ||
| 89 | |||
| 90 | HVACComponent reheatCoil() const; | ||
| 91 | |||
| 92 | boost::optional<double> maximumHotWaterorSteamFlowRate() const; | ||
| 93 | |||
| 94 | bool isMaximumHotWaterorSteamFlowRateAutosized() const; | ||
| 95 | |||
| 96 | double minimumHotWaterorSteamFlowRate() const; | ||
| 97 | |||
| 98 | bool isMinimumHotWaterorSteamFlowRateDefaulted() const; | ||
| 99 | |||
| 100 | double convergenceTolerance() const; | ||
| 101 | |||
| 102 | std::string fanControlType() const; | ||
| 103 | |||
| 104 | double minimumFanTurnDownRatio() const; | ||
| 105 | |||
| 106 | std::string heatingControlType() const; | ||
| 107 | |||
| 108 | double designHeatingDischargeAirTemperature() const; | ||
| 109 | |||
| 110 | double highLimitHeatingDischargeAirTemperature() const; | ||
| 111 | |||
| 112 | bool isConvergenceToleranceDefaulted() const; | ||
| 113 | |||
| 114 | boost::optional<double> autosizedMaximumPrimaryAirFlowRate() const; | ||
| 115 | |||
| 116 | boost::optional<double> autosizedMaximumSecondaryAirFlowRate() const; | ||
| 117 | |||
| 118 | boost::optional<double> autosizedMinimumPrimaryAirFlowFraction() const; | ||
| 119 | |||
| 120 | boost::optional<double> autosizedFanOnFlowFraction() const; | ||
| 121 | |||
| 122 | boost::optional<double> autosizedMaximumHotWaterorSteamFlowRate() const; | ||
| 123 | |||
| 124 | virtual void autosize() override; | ||
| 125 | |||
| 126 | virtual void applySizingValues() override; | ||
| 127 | |||
| 128 | //@} | ||
| 129 | /** @name Setters */ | ||
| 130 | //@{ | ||
| 131 | |||
| 132 | // TODO: @macumber all of these should have a return type of bool, and shouldn't accept boost::optional double (or at least be overloaded to accept a | ||
| 133 | // double too), see https://github.com/NREL/OpenStudio/issues/2620 and https://github.com/jmarrec/OpenStudio/commit/5d295638aea240becc14a45641ea72a413e1c360 | ||
| 134 | // and https://github.com/NREL/OpenStudio/pull/2589 | ||
| 135 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 136 | |||
| 137 | bool setMaximumPrimaryAirFlowRate(boost::optional<double> maximumPrimaryAirFlowRate); | ||
| 138 | |||
| 139 | void autosizeMaximumPrimaryAirFlowRate(); | ||
| 140 | |||
| 141 | bool setMaximumSecondaryAirFlowRate(boost::optional<double> maximumSecondaryAirFlowRate); | ||
| 142 | |||
| 143 | void autosizeMaximumSecondaryAirFlowRate(); | ||
| 144 | |||
| 145 | bool setMinimumPrimaryAirFlowFraction(boost::optional<double> minimumPrimaryAirFlowFraction); | ||
| 146 | |||
| 147 | void autosizeMinimumPrimaryAirFlowFraction(); | ||
| 148 | |||
| 149 | bool setFanOnFlowFraction(boost::optional<double> fanOnFlowFraction); | ||
| 150 | |||
| 151 | void autosizeFanOnFlowFraction(); | ||
| 152 | |||
| 153 | bool setFan(HVACComponent& hvacComponent); | ||
| 154 | |||
| 155 | bool setReheatCoil(HVACComponent& hvacComponent); | ||
| 156 | |||
| 157 | bool setMaximumHotWaterorSteamFlowRate(boost::optional<double> maximumHotWaterorSteamFlowRate); | ||
| 158 | |||
| 159 | void resetMaximumHotWaterorSteamFlowRate(); | ||
| 160 | |||
| 161 | void autosizeMaximumHotWaterorSteamFlowRate(); | ||
| 162 | |||
| 163 | bool setMinimumHotWaterorSteamFlowRate(double minimumHotWaterorSteamFlowRate); | ||
| 164 | |||
| 165 | void resetMinimumHotWaterorSteamFlowRate(); | ||
| 166 | |||
| 167 | bool setConvergenceTolerance(double convergenceTolerance); | ||
| 168 | |||
| 169 | void resetConvergenceTolerance(); | ||
| 170 | |||
| 171 | bool setFanControlType(const std::string& fanControlType); | ||
| 172 | |||
| 173 | bool setMinimumFanTurnDownRatio(double minimumFanTurnDownRatio); | ||
| 174 | |||
| 175 | bool setHeatingControlType(const std::string& heatingControlType); | ||
| 176 | |||
| 177 | bool setDesignHeatingDischargeAirTemperature(double designHeatingDischargeAirTemperature); | ||
| 178 | |||
| 179 | bool setHighLimitHeatingDischargeAirTemperature(double highLimitHeatingDischargeAirTemperature); | ||
| 180 | |||
| 181 | // This is a non publlic method to draw recirculation air from a plenum | ||
| 182 | // Use carefully. Removing (or moving) plenum will leave model in invalid state | ||
| 183 | bool setInducedAirPlenumZone(ThermalZone& thermalZone); | ||
| 184 | |||
| 185 | bool setFanAvailabilitySchedule(Schedule& schedule); | ||
| 186 | |||
| 187 | //@} | ||
| 188 | protected: | ||
| 189 | private: | ||
| 190 | − | REGISTER_LOGGER("openstudio.model.AirTerminalSingleDuctParallelPIUReheat"); | |
| 191 | |||
| 192 | // optional getters for children() (in case want to remove() before fully constructed). | ||
| 193 | boost::optional<Schedule> optionalAvailabilitySchedule() const; | ||
| 194 | boost::optional<HVACComponent> optionalFan() const; | ||
| 195 | boost::optional<HVACComponent> optionalReheatCoil() const; | ||
| 196 | |||
| 197 | boost::optional<ModelObject> availabilityScheduleAsModelObject() const; | ||
| 198 | |||
| 199 | bool setAvailabilityScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 200 | }; | ||
| 201 | |||
| 202 | } // namespace detail | ||
| 203 | |||
| 204 | } // namespace model | ||
| 205 | } // namespace openstudio | ||
| 206 | |||
| 207 | #endif // MODEL_AIRTERMINALSINGLEDUCTPARALLELPIUREHEAT_IMPL_HPP | ||
| 208 |