src/model/ZoneHVACLowTempRadiantConstFlow.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_ZONEHVACLOWTEMPRADIANTCONSTFLOW_HPP | ||
| 7 | #define MODEL_ZONEHVACLOWTEMPRADIANTCONSTFLOW_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Surface.hpp" | ||
| 11 | #include "Surface_Impl.hpp" | ||
| 12 | #include "ZoneHVACComponent.hpp" | ||
| 13 | #include "../utilities/core/Deprecated.hpp" | ||
| 14 | |||
| 15 | namespace openstudio { | ||
| 16 | |||
| 17 | namespace model { | ||
| 18 | |||
| 19 | class Schedule; | ||
| 20 | class HVACComponent; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class ZoneHVACLowTempRadiantConstFlow_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** ZoneHVACLowTempRadiantConstFlow is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:LowTemperatureRadiant:ConstantFlow'. */ | ||
| 29 | class MODEL_API ZoneHVACLowTempRadiantConstFlow : public ZoneHVACComponent | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | ZoneHVACLowTempRadiantConstFlow(const Model& model, Schedule& availabilitySchedule, HVACComponent& heatingCoil, HVACComponent& coolingCoil, | ||
| 36 | double hydronicTubingLength); | ||
| 37 | |||
| 38 | // Ctor with hydronicTubingLength autosized | ||
| 39 | ZoneHVACLowTempRadiantConstFlow(const Model& model, Schedule& availabilitySchedule, HVACComponent& heatingCoil, HVACComponent& coolingCoil); | ||
| 40 | |||
| 41 | 18 | virtual ~ZoneHVACLowTempRadiantConstFlow() override = default; | |
| 42 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 43 | 1 | ZoneHVACLowTempRadiantConstFlow(const ZoneHVACLowTempRadiantConstFlow& other) = default; | |
| 44 | 4 | ZoneHVACLowTempRadiantConstFlow(ZoneHVACLowTempRadiantConstFlow&& other) = default; | |
| 45 | ✗ | ZoneHVACLowTempRadiantConstFlow& operator=(const ZoneHVACLowTempRadiantConstFlow&) = default; | |
| 46 | ✗ | ZoneHVACLowTempRadiantConstFlow& operator=(ZoneHVACLowTempRadiantConstFlow&&) = default; | |
| 47 | |||
| 48 | //@} | ||
| 49 | |||
| 50 | static IddObjectType iddObjectType(); | ||
| 51 | |||
| 52 | static std::vector<std::string> radiantSurfaceTypeValues(); | ||
| 53 | |||
| 54 | static std::vector<std::string> temperatureControlTypeValues(); | ||
| 55 | |||
| 56 | /** @name Getters */ | ||
| 57 | //@{ | ||
| 58 | |||
| 59 | Schedule availabilitySchedule() const; | ||
| 60 | |||
| 61 | boost::optional<std::string> radiantSurfaceType() const; | ||
| 62 | |||
| 63 | std::vector<Surface> surfaces() const; | ||
| 64 | |||
| 65 | std::string fluidtoRadiantSurfaceHeatTransferModel() const; | ||
| 66 | |||
| 67 | bool isFluidtoRadiantSurfaceHeatTransferModelDefaulted() const; | ||
| 68 | |||
| 69 | double hydronicTubingInsideDiameter() const; | ||
| 70 | |||
| 71 | bool isHydronicTubingInsideDiameterDefaulted() const; | ||
| 72 | |||
| 73 | double hydronicTubingOutsideDiameter() const; | ||
| 74 | |||
| 75 | bool isHydronicTubingOutsideDiameterDefaulted() const; | ||
| 76 | |||
| 77 | boost::optional<double> hydronicTubingLength() const; | ||
| 78 | |||
| 79 | bool isHydronicTubingLengthAutosized() const; | ||
| 80 | |||
| 81 | double hydronicTubingConductivity() const; | ||
| 82 | |||
| 83 | bool isHydronicTubingConductivityDefaulted() const; | ||
| 84 | |||
| 85 | std::string temperatureControlType() const; | ||
| 86 | |||
| 87 | bool isTemperatureControlTypeDefaulted() const; | ||
| 88 | |||
| 89 | double runningMeanOutdoorDryBulbTemperatureWeightingFactor() const; | ||
| 90 | |||
| 91 | bool isRunningMeanOutdoorDryBulbTemperatureWeightingFactorDefaulted() const; | ||
| 92 | |||
| 93 | HVACComponent heatingCoil() const; | ||
| 94 | |||
| 95 | HVACComponent coolingCoil() const; | ||
| 96 | |||
| 97 | boost::optional<double> ratedFlowRate() const; | ||
| 98 | |||
| 99 | bool isRatedFlowRateAutosized() const; | ||
| 100 | |||
| 101 | boost::optional<Schedule> pumpFlowRateSchedule() const; | ||
| 102 | |||
| 103 | double ratedPumpHead() const; | ||
| 104 | |||
| 105 | bool isRatedPumpHeadDefaulted() const; | ||
| 106 | |||
| 107 | boost::optional<double> ratedPowerConsumption() const; | ||
| 108 | |||
| 109 | double motorEfficiency() const; | ||
| 110 | |||
| 111 | bool isMotorEfficiencyDefaulted() const; | ||
| 112 | |||
| 113 | double fractionofMotorInefficienciestoFluidStream() const; | ||
| 114 | |||
| 115 | bool isFractionofMotorInefficienciestoFluidStreamDefaulted() const; | ||
| 116 | |||
| 117 | std::string numberofCircuits() const; | ||
| 118 | |||
| 119 | double circuitLength() const; | ||
| 120 | |||
| 121 | boost::optional<Schedule> changeoverDelayTimePeriodSchedule() const; | ||
| 122 | |||
| 123 | //@} | ||
| 124 | /** @name Setters */ | ||
| 125 | //@{ | ||
| 126 | |||
| 127 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 128 | |||
| 129 | bool setRadiantSurfaceType(const std::string& radiantSurfaceType); | ||
| 130 | |||
| 131 | void resetRadiantSurfaceType(); | ||
| 132 | |||
| 133 | bool setFluidtoRadiantSurfaceHeatTransferModel(const std::string& fluidtoRadiantSurfaceHeatTransferModel); | ||
| 134 | |||
| 135 | void resetFluidtoRadiantSurfaceHeatTransferModel(); | ||
| 136 | |||
| 137 | bool setHydronicTubingInsideDiameter(double hydronicTubingInsideDiameter); | ||
| 138 | |||
| 139 | void resetHydronicTubingInsideDiameter(); | ||
| 140 | |||
| 141 | bool setHydronicTubingOutsideDiameter(double hydronicTubingOutsideDiameter); | ||
| 142 | |||
| 143 | void resetHydronicTubingOutsideDiameter(); | ||
| 144 | |||
| 145 | bool setHydronicTubingLength(double hydronicTubingLength); | ||
| 146 | |||
| 147 | // Will forward to autosizeHydronicTubingLength() | ||
| 148 | OS_DEPRECATED(3, 0, 0) void resetHydronicTubingLength(); // Shouldn't have existed to begin with. | ||
| 149 | |||
| 150 | void autosizeHydronicTubingLength(); | ||
| 151 | |||
| 152 | bool setHydronicTubingConductivity(double hydronicTubingConductivity); | ||
| 153 | |||
| 154 | void resetHydronicTubingConductivity(); | ||
| 155 | |||
| 156 | bool setTemperatureControlType(const std::string& temperatureControlType); | ||
| 157 | |||
| 158 | void resetTemperatureControlType(); | ||
| 159 | |||
| 160 | bool setRunningMeanOutdoorDryBulbTemperatureWeightingFactor(double runningMeanOutdoorDryBulbTemperatureWeightingFactor); | ||
| 161 | |||
| 162 | void resetRunningMeanOutdoorDryBulbTemperatureWeightingFactor(); | ||
| 163 | |||
| 164 | bool setHeatingCoil(HVACComponent& heatingCoil); | ||
| 165 | |||
| 166 | bool setCoolingCoil(HVACComponent& coolingCoil); | ||
| 167 | |||
| 168 | bool setRatedFlowRate(double ratedFlowRate); | ||
| 169 | |||
| 170 | // Will forward to autosizeRatedFlowRate() | ||
| 171 | OS_DEPRECATED(3, 0, 0) void resetRatedFlowRate(); | ||
| 172 | |||
| 173 | void autosizeRatedFlowRate(); | ||
| 174 | |||
| 175 | bool setPumpFlowRateSchedule(Schedule& schedule); | ||
| 176 | |||
| 177 | void resetPumpFlowRateSchedule(); | ||
| 178 | |||
| 179 | bool setRatedPumpHead(double ratedPumpHead); | ||
| 180 | |||
| 181 | void resetRatedPumpHead(); | ||
| 182 | |||
| 183 | bool setRatedPowerConsumption(double ratedPowerConsumption); | ||
| 184 | |||
| 185 | void resetRatedPowerConsumption(); | ||
| 186 | |||
| 187 | bool setMotorEfficiency(double motorEfficiency); | ||
| 188 | |||
| 189 | void resetMotorEfficiency(); | ||
| 190 | |||
| 191 | bool setFractionofMotorInefficienciestoFluidStream(double fractionofMotorInefficienciestoFluidStream); | ||
| 192 | |||
| 193 | void resetFractionofMotorInefficienciestoFluidStream(); | ||
| 194 | |||
| 195 | bool setNumberofCircuits(const std::string& numberofCircuits); | ||
| 196 | |||
| 197 | bool setCircuitLength(double circuitLength); | ||
| 198 | |||
| 199 | bool setChangeoverDelayTimePeriodSchedule(Schedule& schedule); | ||
| 200 | |||
| 201 | void resetChangeoverDelayTimePeriodSchedule(); | ||
| 202 | |||
| 203 | boost::optional<ThermalZone> thermalZone() const override; | ||
| 204 | |||
| 205 | bool addToThermalZone(ThermalZone& thermalZone); | ||
| 206 | |||
| 207 | void removeFromThermalZone(); | ||
| 208 | |||
| 209 | //@} | ||
| 210 | /** @name Other */ | ||
| 211 | //@{ | ||
| 212 | |||
| 213 | boost::optional<double> autosizedHydronicTubingLength() const; | ||
| 214 | |||
| 215 | boost::optional<double> autosizedRatedFlowRate() const; | ||
| 216 | |||
| 217 | //@} | ||
| 218 | protected: | ||
| 219 | /// @cond | ||
| 220 | using ImplType = detail::ZoneHVACLowTempRadiantConstFlow_Impl; | ||
| 221 | |||
| 222 | explicit ZoneHVACLowTempRadiantConstFlow(std::shared_ptr<detail::ZoneHVACLowTempRadiantConstFlow_Impl> impl); | ||
| 223 | |||
| 224 | friend class detail::ZoneHVACLowTempRadiantConstFlow_Impl; | ||
| 225 | friend class Model; | ||
| 226 | friend class IdfObject; | ||
| 227 | friend class openstudio::detail::IdfObject_Impl; | ||
| 228 | /// @endcond | ||
| 229 | private: | ||
| 230 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACLowTempRadiantConstFlow"); | |
| 231 | }; | ||
| 232 | |||
| 233 | /** \relates ZoneHVACLowTempRadiantConstFlow*/ | ||
| 234 | using OptionalZoneHVACLowTempRadiantConstFlow = boost::optional<ZoneHVACLowTempRadiantConstFlow>; | ||
| 235 | |||
| 236 | /** \relates ZoneHVACLowTempRadiantConstFlow*/ | ||
| 237 | using ZoneHVACLowTempRadiantConstFlowVector = std::vector<ZoneHVACLowTempRadiantConstFlow>; | ||
| 238 | |||
| 239 | } // namespace model | ||
| 240 | } // namespace openstudio | ||
| 241 | |||
| 242 | #endif // MODEL_ZONEHVACLOWTEMPRADIANTCONSTFLOW_HPP | ||
| 243 |