src/model/HeatExchangerAirToAirSensibleAndLatent.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_HEATEXCHANGERAIRTOAIRSENSIBLEANDLATENT_HPP | ||
| 7 | #define MODEL_HEATEXCHANGERAIRTOAIRSENSIBLEANDLATENT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "AirToAirComponent.hpp" | ||
| 11 | |||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Schedule; | ||
| 19 | class AirflowNetworkEquivalentDuct; | ||
| 20 | class Curve; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class HeatExchangerAirToAirSensibleAndLatent_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** HeatExchangerAirToAirSensibleAndLatent is a AirToAirComponent that wraps the OpenStudio IDD object 'OS:HeatExchanger:AirToAir:SensibleAndLatent'. */ | ||
| 29 | class MODEL_API HeatExchangerAirToAirSensibleAndLatent : public AirToAirComponent | ||
| 30 | { | ||
| 31 | |||
| 32 | public: | ||
| 33 | /** @name Constructors and Destructors */ | ||
| 34 | //@{ | ||
| 35 | |||
| 36 | /** Constructor. It will **not** instantiate the optional effectivness curve/tables objects and effectiveness will be constant. | ||
| 37 | * You can then call the helper method `bool assignHistoricalEffectivenessCurves()` to assign 4 TableLookups that will match the pre E+ 24.1.0 | ||
| 38 | * defaults for Sensible/Latent Effectiveness at 75% Heating/Cooling airflow */ | ||
| 39 | explicit HeatExchangerAirToAirSensibleAndLatent(const Model& model); | ||
| 40 | |||
| 41 | 130 | virtual ~HeatExchangerAirToAirSensibleAndLatent() override = default; | |
| 42 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 43 | ✗ | HeatExchangerAirToAirSensibleAndLatent(const HeatExchangerAirToAirSensibleAndLatent& other) = default; | |
| 44 | 23 | HeatExchangerAirToAirSensibleAndLatent(HeatExchangerAirToAirSensibleAndLatent&& other) = default; | |
| 45 | ✗ | HeatExchangerAirToAirSensibleAndLatent& operator=(const HeatExchangerAirToAirSensibleAndLatent&) = default; | |
| 46 | ✗ | HeatExchangerAirToAirSensibleAndLatent& operator=(HeatExchangerAirToAirSensibleAndLatent&&) = default; | |
| 47 | |||
| 48 | //@} | ||
| 49 | |||
| 50 | static IddObjectType iddObjectType(); | ||
| 51 | |||
| 52 | static std::vector<std::string> heatExchangerTypeValues(); | ||
| 53 | |||
| 54 | static std::vector<std::string> frostControlTypeValues(); | ||
| 55 | |||
| 56 | Schedule availabilitySchedule() const; | ||
| 57 | |||
| 58 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 59 | |||
| 60 | boost::optional<double> nominalSupplyAirFlowRate() const; | ||
| 61 | |||
| 62 | bool isNominalSupplyAirFlowRateAutosized() const; | ||
| 63 | |||
| 64 | bool setNominalSupplyAirFlowRate(double nominalSupplyAirFlowRate); | ||
| 65 | |||
| 66 | void autosizeNominalSupplyAirFlowRate(); | ||
| 67 | |||
| 68 | double sensibleEffectivenessat100HeatingAirFlow() const; | ||
| 69 | |||
| 70 | bool setSensibleEffectivenessat100HeatingAirFlow(double sensibleEffectivenessat100HeatingAirFlow); | ||
| 71 | |||
| 72 | double latentEffectivenessat100HeatingAirFlow() const; | ||
| 73 | |||
| 74 | bool setLatentEffectivenessat100HeatingAirFlow(double latentEffectivenessat100HeatingAirFlow); | ||
| 75 | |||
| 76 | OS_DEPRECATED(3, 8, 0) double sensibleEffectivenessat75HeatingAirFlow() const; | ||
| 77 | |||
| 78 | OS_DEPRECATED(3, 8, 0) bool setSensibleEffectivenessat75HeatingAirFlow(double sensibleEffectivenessat75HeatingAirFlow); | ||
| 79 | |||
| 80 | OS_DEPRECATED(3, 8, 0) double latentEffectivenessat75HeatingAirFlow() const; | ||
| 81 | |||
| 82 | OS_DEPRECATED(3, 8, 0) bool setLatentEffectivenessat75HeatingAirFlow(double latentEffectivenessat75HeatingAirFlow); | ||
| 83 | |||
| 84 | double sensibleEffectivenessat100CoolingAirFlow() const; | ||
| 85 | |||
| 86 | bool setSensibleEffectivenessat100CoolingAirFlow(double sensibleEffectivenessat100CoolingAirFlow); | ||
| 87 | |||
| 88 | double latentEffectivenessat100CoolingAirFlow() const; | ||
| 89 | |||
| 90 | bool setLatentEffectivenessat100CoolingAirFlow(double latentEffectivenessat100CoolingAirFlow); | ||
| 91 | |||
| 92 | OS_DEPRECATED(3, 8, 0) double sensibleEffectivenessat75CoolingAirFlow() const; | ||
| 93 | |||
| 94 | OS_DEPRECATED(3, 8, 0) bool setSensibleEffectivenessat75CoolingAirFlow(double sensibleEffectivenessat75CoolingAirFlow); | ||
| 95 | |||
| 96 | OS_DEPRECATED(3, 8, 0) double latentEffectivenessat75CoolingAirFlow() const; | ||
| 97 | |||
| 98 | OS_DEPRECATED(3, 8, 0) bool setLatentEffectivenessat75CoolingAirFlow(double latentEffectivenessat75CoolingAirFlow); | ||
| 99 | |||
| 100 | double nominalElectricPower() const; | ||
| 101 | |||
| 102 | bool setNominalElectricPower(double nominalElectricPower); | ||
| 103 | |||
| 104 | bool supplyAirOutletTemperatureControl() const; | ||
| 105 | |||
| 106 | bool setSupplyAirOutletTemperatureControl(bool supplyAirOutletTemperatureControl); | ||
| 107 | |||
| 108 | std::string heatExchangerType() const; | ||
| 109 | |||
| 110 | bool setHeatExchangerType(const std::string& heatExchangerType); | ||
| 111 | |||
| 112 | std::string frostControlType() const; | ||
| 113 | |||
| 114 | bool setFrostControlType(const std::string& frostControlType); | ||
| 115 | |||
| 116 | double thresholdTemperature() const; | ||
| 117 | |||
| 118 | bool isThresholdTemperatureDefaulted() const; | ||
| 119 | |||
| 120 | bool setThresholdTemperature(double thresholdTemperature); | ||
| 121 | |||
| 122 | void resetThresholdTemperature(); | ||
| 123 | |||
| 124 | boost::optional<double> initialDefrostTimeFraction() const; | ||
| 125 | |||
| 126 | bool setInitialDefrostTimeFraction(double initialDefrostTimeFraction); | ||
| 127 | |||
| 128 | void resetInitialDefrostTimeFraction(); | ||
| 129 | |||
| 130 | boost::optional<double> rateofDefrostTimeFractionIncrease() const; | ||
| 131 | |||
| 132 | bool setRateofDefrostTimeFractionIncrease(double rateofDefrostTimeFractionIncrease); | ||
| 133 | |||
| 134 | void resetRateofDefrostTimeFractionIncrease(); | ||
| 135 | |||
| 136 | bool economizerLockout() const; | ||
| 137 | |||
| 138 | bool setEconomizerLockout(bool economizerLockout); | ||
| 139 | |||
| 140 | boost::optional<Curve> sensibleEffectivenessofHeatingAirFlowCurve() const; | ||
| 141 | bool setSensibleEffectivenessofHeatingAirFlowCurve(const Curve& sensibleEffectivenessofHeatingAirFlowCurve); | ||
| 142 | void resetSensibleEffectivenessofHeatingAirFlowCurve(); | ||
| 143 | |||
| 144 | boost::optional<Curve> latentEffectivenessofHeatingAirFlowCurve() const; | ||
| 145 | bool setLatentEffectivenessofHeatingAirFlowCurve(const Curve& latentEffectivenessofHeatingAirFlowCurve); | ||
| 146 | void resetLatentEffectivenessofHeatingAirFlowCurve(); | ||
| 147 | |||
| 148 | boost::optional<Curve> sensibleEffectivenessofCoolingAirFlowCurve() const; | ||
| 149 | bool setSensibleEffectivenessofCoolingAirFlowCurve(const Curve& sensibleEffectivenessofCoolingAirFlowCurve); | ||
| 150 | void resetSensibleEffectivenessofCoolingAirFlowCurve(); | ||
| 151 | |||
| 152 | boost::optional<Curve> latentEffectivenessofCoolingAirFlowCurve() const; | ||
| 153 | bool setLatentEffectivenessofCoolingAirFlowCurve(const Curve& latentEffectivenessofCoolingAirFlowCurve); | ||
| 154 | void resetLatentEffectivenessofCoolingAirFlowCurve(); | ||
| 155 | |||
| 156 | /** @name Other */ | ||
| 157 | //@{ | ||
| 158 | |||
| 159 | boost::optional<double> autosizedNominalSupplyAirFlowRate() const; | ||
| 160 | |||
| 161 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 162 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 163 | |||
| 164 | // Helper that creates defaulted Optional Curves (TableLookups) to match the pre E+ 24.1.0 effectiveness defaults | ||
| 165 | bool assignHistoricalEffectivenessCurves(); | ||
| 166 | |||
| 167 | //@} | ||
| 168 | |||
| 169 | protected: | ||
| 170 | /// @cond | ||
| 171 | using ImplType = detail::HeatExchangerAirToAirSensibleAndLatent_Impl; | ||
| 172 | |||
| 173 | explicit HeatExchangerAirToAirSensibleAndLatent(std::shared_ptr<detail::HeatExchangerAirToAirSensibleAndLatent_Impl> impl); | ||
| 174 | |||
| 175 | friend class detail::HeatExchangerAirToAirSensibleAndLatent_Impl; | ||
| 176 | friend class Model; | ||
| 177 | friend class IdfObject; | ||
| 178 | friend class openstudio::detail::IdfObject_Impl; | ||
| 179 | |||
| 180 | /// @endcond | ||
| 181 | |||
| 182 | private: | ||
| 183 | − | REGISTER_LOGGER("openstudio.model.HeatExchangerAirToAirSensibleAndLatent"); | |
| 184 | }; | ||
| 185 | |||
| 186 | /** \relates HeatExchangerAirToAirSensibleAndLatent*/ | ||
| 187 | using OptionalHeatExchangerAirToAirSensibleAndLatent = boost::optional<HeatExchangerAirToAirSensibleAndLatent>; | ||
| 188 | |||
| 189 | /** \relates HeatExchangerAirToAirSensibleAndLatent*/ | ||
| 190 | using HeatExchangerAirToAirSensibleAndLatentVector = std::vector<HeatExchangerAirToAirSensibleAndLatent>; | ||
| 191 | |||
| 192 | } // namespace model | ||
| 193 | } // namespace openstudio | ||
| 194 | |||
| 195 | #endif // MODEL_HEATEXCHANGERAIRTOAIRSENSIBLEANDLATENT_HPP | ||
| 196 |