src/model/ZoneHVACLowTempRadiantVarFlow.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_ZONEHVACLOWTEMPRADIANTVARFLOW_HPP | ||
| 7 | #define MODEL_ZONEHVACLOWTEMPRADIANTVARFLOW_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Surface.hpp" | ||
| 11 | #include "Surface_Impl.hpp" | ||
| 12 | #include "ZoneHVACComponent.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Schedule; | ||
| 19 | class HVACComponent; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | class ZoneHVACLowTempRadiantVarFlow_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** ZoneHVACLowTempRadiantVarFlow is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:LowTemperatureRadiant:VariableFlow'. */ | ||
| 28 | class MODEL_API ZoneHVACLowTempRadiantVarFlow : public ZoneHVACComponent | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | explicit ZoneHVACLowTempRadiantVarFlow(const Model& model, Schedule& availabilitySchedule, HVACComponent& heatingCoil, | ||
| 35 | HVACComponent& coolingCoil); | ||
| 36 | |||
| 37 | // This constructor defaults the availabilitySchedule to alwaysOnDiscrete, and **does not set any heating nor cooling coil** | ||
| 38 | explicit ZoneHVACLowTempRadiantVarFlow(const Model& model); | ||
| 39 | |||
| 40 | 56 | virtual ~ZoneHVACLowTempRadiantVarFlow() override = default; | |
| 41 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 42 | 2 | ZoneHVACLowTempRadiantVarFlow(const ZoneHVACLowTempRadiantVarFlow& other) = default; | |
| 43 | 14 | ZoneHVACLowTempRadiantVarFlow(ZoneHVACLowTempRadiantVarFlow&& other) = default; | |
| 44 | ✗ | ZoneHVACLowTempRadiantVarFlow& operator=(const ZoneHVACLowTempRadiantVarFlow&) = default; | |
| 45 | ✗ | ZoneHVACLowTempRadiantVarFlow& operator=(ZoneHVACLowTempRadiantVarFlow&&) = default; | |
| 46 | |||
| 47 | //@} | ||
| 48 | |||
| 49 | static IddObjectType iddObjectType(); | ||
| 50 | |||
| 51 | static std::vector<std::string> radiantSurfaceTypeValues(); | ||
| 52 | |||
| 53 | static std::vector<std::string> temperatureControlTypeValues(); | ||
| 54 | |||
| 55 | /** @name Getters */ | ||
| 56 | //@{ | ||
| 57 | |||
| 58 | Schedule availabilitySchedule() const; | ||
| 59 | |||
| 60 | boost::optional<HVACComponent> heatingCoil() const; | ||
| 61 | |||
| 62 | boost::optional<HVACComponent> coolingCoil() const; | ||
| 63 | |||
| 64 | boost::optional<std::string> radiantSurfaceType() const; | ||
| 65 | |||
| 66 | std::vector<Surface> surfaces() const; | ||
| 67 | |||
| 68 | std::string fluidtoRadiantSurfaceHeatTransferModel() const; | ||
| 69 | |||
| 70 | bool isFluidtoRadiantSurfaceHeatTransferModelDefaulted() const; | ||
| 71 | |||
| 72 | double hydronicTubingInsideDiameter() const; | ||
| 73 | |||
| 74 | bool isHydronicTubingInsideDiameterDefaulted() const; | ||
| 75 | |||
| 76 | double hydronicTubingOutsideDiameter() const; | ||
| 77 | |||
| 78 | bool isHydronicTubingOutsideDiameterDefaulted() const; | ||
| 79 | |||
| 80 | boost::optional<double> hydronicTubingLength() const; | ||
| 81 | |||
| 82 | bool isHydronicTubingLengthDefaulted() const; | ||
| 83 | |||
| 84 | bool isHydronicTubingLengthAutosized() const; | ||
| 85 | |||
| 86 | double hydronicTubingConductivity() const; | ||
| 87 | |||
| 88 | bool isHydronicTubingConductivityDefaulted() const; | ||
| 89 | |||
| 90 | std::string temperatureControlType() const; | ||
| 91 | |||
| 92 | bool isTemperatureControlTypeDefaulted() const; | ||
| 93 | |||
| 94 | std::string setpointControlType() const; | ||
| 95 | |||
| 96 | bool isSetpointControlTypeDefaulted() const; | ||
| 97 | |||
| 98 | std::string numberofCircuits() const; | ||
| 99 | |||
| 100 | double circuitLength() const; | ||
| 101 | |||
| 102 | boost::optional<Schedule> changeoverDelayTimePeriodSchedule() const; | ||
| 103 | |||
| 104 | //@} | ||
| 105 | /** @name Setters */ | ||
| 106 | //@{ | ||
| 107 | |||
| 108 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 109 | |||
| 110 | bool setRadiantSurfaceType(const std::string& radiantSurfaceType); | ||
| 111 | |||
| 112 | void resetRadiantSurfaceType(); | ||
| 113 | |||
| 114 | bool setFluidtoRadiantSurfaceHeatTransferModel(const std::string& fluidtoRadiantSurfaceHeatTransferModel); | ||
| 115 | |||
| 116 | void resetFluidtoRadiantSurfaceHeatTransferModel(); | ||
| 117 | |||
| 118 | bool setHeatingCoil(HVACComponent& heatingCoil); | ||
| 119 | void resetHeatingCoil(); | ||
| 120 | |||
| 121 | bool setCoolingCoil(HVACComponent& coolingCoil); | ||
| 122 | void resetCoolingCoil(); | ||
| 123 | |||
| 124 | bool setHydronicTubingInsideDiameter(double hydronicTubingInsideDiameter); | ||
| 125 | |||
| 126 | void resetHydronicTubingInsideDiameter(); | ||
| 127 | |||
| 128 | bool setHydronicTubingOutsideDiameter(double hydronicTubingOutsideDiameter); | ||
| 129 | |||
| 130 | void resetHydronicTubingOutsideDiameter(); | ||
| 131 | |||
| 132 | bool setHydronicTubingLength(double hydronicTubingLength); | ||
| 133 | |||
| 134 | void resetHydronicTubingLength(); | ||
| 135 | |||
| 136 | void autosizeHydronicTubingLength(); | ||
| 137 | |||
| 138 | bool setHydronicTubingConductivity(double hydronicTubingConductivity); | ||
| 139 | |||
| 140 | void resetHydronicTubingConductivity(); | ||
| 141 | |||
| 142 | bool setTemperatureControlType(const std::string& temperatureControlType); | ||
| 143 | |||
| 144 | void resetTemperatureControlType(); | ||
| 145 | |||
| 146 | bool setSetpointControlType(const std::string& setpointControlType); | ||
| 147 | |||
| 148 | void resetSetpointControlType(); | ||
| 149 | |||
| 150 | bool setNumberofCircuits(const std::string& numberofCircuits); | ||
| 151 | |||
| 152 | bool setCircuitLength(double circuitLength); | ||
| 153 | |||
| 154 | bool setChangeoverDelayTimePeriodSchedule(Schedule& schedule); | ||
| 155 | |||
| 156 | void resetChangeoverDelayTimePeriodSchedule(); | ||
| 157 | |||
| 158 | boost::optional<ThermalZone> thermalZone() const override; | ||
| 159 | |||
| 160 | bool addToThermalZone(ThermalZone& thermalZone); | ||
| 161 | |||
| 162 | void removeFromThermalZone(); | ||
| 163 | |||
| 164 | //@} | ||
| 165 | /** @name Other */ | ||
| 166 | //@{ | ||
| 167 | |||
| 168 | boost::optional<double> autosizedHydronicTubingLength() const; | ||
| 169 | |||
| 170 | //@} | ||
| 171 | protected: | ||
| 172 | /// @cond | ||
| 173 | using ImplType = detail::ZoneHVACLowTempRadiantVarFlow_Impl; | ||
| 174 | |||
| 175 | explicit ZoneHVACLowTempRadiantVarFlow(std::shared_ptr<detail::ZoneHVACLowTempRadiantVarFlow_Impl> impl); | ||
| 176 | |||
| 177 | friend class detail::ZoneHVACLowTempRadiantVarFlow_Impl; | ||
| 178 | friend class Model; | ||
| 179 | friend class IdfObject; | ||
| 180 | friend class openstudio::detail::IdfObject_Impl; | ||
| 181 | /// @endcond | ||
| 182 | private: | ||
| 183 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACLowTempRadiantVarFlow"); | |
| 184 | }; | ||
| 185 | |||
| 186 | /** \relates ZoneHVACLowTempRadiantVarFlow*/ | ||
| 187 | using OptionalZoneHVACLowTempRadiantVarFlow = boost::optional<ZoneHVACLowTempRadiantVarFlow>; | ||
| 188 | |||
| 189 | /** \relates ZoneHVACLowTempRadiantVarFlow*/ | ||
| 190 | using ZoneHVACLowTempRadiantVarFlowVector = std::vector<ZoneHVACLowTempRadiantVarFlow>; | ||
| 191 | |||
| 192 | } // namespace model | ||
| 193 | } // namespace openstudio | ||
| 194 | |||
| 195 | #endif // MODEL_ZONEHVACLOWTEMPRADIANTVARFLOW_HPP | ||
| 196 |