src/model/CoilHeatingDesuperheater.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_COILHEATINGDESUPERHEATER_HPP | ||
| 7 | #define MODEL_COILHEATINGDESUPERHEATER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | #include "StraightComponent.hpp" | ||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Schedule; | ||
| 19 | class ModelObject; | ||
| 20 | class AirflowNetworkEquivalentDuct; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class CoilHeatingDesuperheater_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** CoilHeatingDesuperheater is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Heating:Desuperheater'. | ||
| 29 | |||
| 30 | This coil can be used in air loop simulations but can’t be used by certain compound objects | ||
| 31 | (e.g., AirLoopHVACUnitaryHeatPumpAirToAir, AirLoopHVACUnitaryHeatPumpWaterToAir, or DehumidifierDesiccantNoFans) | ||
| 32 | or any air distribution equipment (e.g., AirTerminalSingleDuctConstantVolumeReheat, AirTerminalSingleDuctVAVReheat, | ||
| 33 | or AirTerminalSingleDuctSeriesPIUReheat). | ||
| 34 | */ | ||
| 35 | class MODEL_API CoilHeatingDesuperheater : public StraightComponent | ||
| 36 | { | ||
| 37 | public: | ||
| 38 | /** @name Constructors and Destructors */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | explicit CoilHeatingDesuperheater(const Model& model); | ||
| 42 | |||
| 43 | 57 | virtual ~CoilHeatingDesuperheater() override = default; | |
| 44 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 45 | ✗ | CoilHeatingDesuperheater(const CoilHeatingDesuperheater& other) = default; | |
| 46 | 1 | CoilHeatingDesuperheater(CoilHeatingDesuperheater&& other) = default; | |
| 47 | ✗ | CoilHeatingDesuperheater& operator=(const CoilHeatingDesuperheater&) = default; | |
| 48 | ✗ | CoilHeatingDesuperheater& operator=(CoilHeatingDesuperheater&&) = default; | |
| 49 | |||
| 50 | //@} | ||
| 51 | |||
| 52 | static IddObjectType iddObjectType(); | ||
| 53 | |||
| 54 | /** @name Getters */ | ||
| 55 | //@{ | ||
| 56 | |||
| 57 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 58 | |||
| 59 | double heatReclaimRecoveryEfficiency() const; | ||
| 60 | |||
| 61 | bool isHeatReclaimRecoveryEfficiencyDefaulted() const; | ||
| 62 | |||
| 63 | boost::optional<ModelObject> heatingSource() const; | ||
| 64 | |||
| 65 | OS_DEPRECATED(3, 7, 0) double parasiticElectricLoad() const; | ||
| 66 | |||
| 67 | double onCycleParasiticElectricLoad() const; | ||
| 68 | |||
| 69 | OS_DEPRECATED(3, 7, 0) bool isParasiticElectricLoadDefaulted() const; | ||
| 70 | |||
| 71 | bool isOnCycleParasiticElectricLoadDefaulted() const; | ||
| 72 | |||
| 73 | //@} | ||
| 74 | /** @name Setters */ | ||
| 75 | //@{ | ||
| 76 | |||
| 77 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 78 | |||
| 79 | void resetAvailabilitySchedule(); | ||
| 80 | |||
| 81 | bool setHeatReclaimRecoveryEfficiency(double heatReclaimRecoveryEfficiency); | ||
| 82 | |||
| 83 | void resetHeatReclaimRecoveryEfficiency(); | ||
| 84 | |||
| 85 | /** \fn bool setHeatingSource(const ModelObject& heatingSource) | ||
| 86 | \brief Sets the heating source from which the desuperheater heating coil recovers energy. | ||
| 87 | \param[in] heatingSource The heating source. | ||
| 88 | |||
| 89 | Valid inputs: \n | ||
| 90 | \ref CoilCoolingDXSingleSpeed \n | ||
| 91 | \ref CoilCoolingDXTwoSpeed \n | ||
| 92 | \ref RefrigerationCompressorRack \n | ||
| 93 | \ref RefrigerationCondenserAirCooled \n | ||
| 94 | \ref RefrigerationCondenserEvaporativeCooled \n | ||
| 95 | \ref RefrigerationCondenserWaterCooled \n | ||
| 96 | */ | ||
| 97 | bool setHeatingSource(const ModelObject& modelObject); | ||
| 98 | |||
| 99 | void resetHeatingSource(); | ||
| 100 | |||
| 101 | OS_DEPRECATED(3, 7, 0) bool setParasiticElectricLoad(double parasiticElectricLoad); | ||
| 102 | |||
| 103 | bool setOnCycleParasiticElectricLoad(double onCyclearasiticElectricLoad); | ||
| 104 | |||
| 105 | OS_DEPRECATED(3, 7, 0) void resetParasiticElectricLoad(); | ||
| 106 | |||
| 107 | void resetOnCycleParasiticElectricLoad(); | ||
| 108 | |||
| 109 | //@} | ||
| 110 | /** @name Other */ | ||
| 111 | //@{ | ||
| 112 | |||
| 113 | /** Creates a new equivalent duct object if an object is not already attached. */ | ||
| 114 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 115 | |||
| 116 | /** Returns the attached equivalent duct object, if any. */ | ||
| 117 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 118 | |||
| 119 | //@} | ||
| 120 | protected: | ||
| 121 | /// @cond | ||
| 122 | using ImplType = detail::CoilHeatingDesuperheater_Impl; | ||
| 123 | |||
| 124 | explicit CoilHeatingDesuperheater(std::shared_ptr<detail::CoilHeatingDesuperheater_Impl> impl); | ||
| 125 | |||
| 126 | friend class detail::CoilHeatingDesuperheater_Impl; | ||
| 127 | friend class Model; | ||
| 128 | friend class IdfObject; | ||
| 129 | friend class openstudio::detail::IdfObject_Impl; | ||
| 130 | /// @endcond | ||
| 131 | private: | ||
| 132 | − | REGISTER_LOGGER("openstudio.model.CoilHeatingDesuperheater"); | |
| 133 | }; | ||
| 134 | |||
| 135 | /** \relates CoilHeatingDesuperheater*/ | ||
| 136 | using OptionalCoilHeatingDesuperheater = boost::optional<CoilHeatingDesuperheater>; | ||
| 137 | |||
| 138 | /** \relates CoilHeatingDesuperheater*/ | ||
| 139 | using CoilHeatingDesuperheaterVector = std::vector<CoilHeatingDesuperheater>; | ||
| 140 | |||
| 141 | } // namespace model | ||
| 142 | } // namespace openstudio | ||
| 143 | |||
| 144 | #endif // MODEL_COILHEATINGDESUPERHEATER_HPP | ||
| 145 |