src/model/ZoneHVACEvaporativeCoolerUnit.hpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /*********************************************************************************************************************** | ||
| 2 | * OpenStudio(R), Copyright (c) 2008-2023, Alliance for Energy Innovation, LLC, and other contributors. All rights reserved. | ||
| 3 | * | ||
| 4 | * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the | ||
| 5 | * following conditions are met: | ||
| 6 | * | ||
| 7 | * (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following | ||
| 8 | * disclaimer. | ||
| 9 | * | ||
| 10 | * (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following | ||
| 11 | * disclaimer in the documentation and/or other materials provided with the distribution. | ||
| 12 | * | ||
| 13 | * (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products | ||
| 14 | * derived from this software without specific prior written permission from the respective party. | ||
| 15 | * | ||
| 16 | * (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative works | ||
| 17 | * may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without specific prior | ||
| 18 | * written permission from Alliance for Energy Innovation, LLC. | ||
| 19 | * | ||
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, | ||
| 21 | * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| 22 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED | ||
| 23 | * STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
| 24 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF | ||
| 25 | * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
| 26 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF | ||
| 27 | * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| 28 | ***********************************************************************************************************************/ | ||
| 29 | |||
| 30 | #ifndef MODEL_ZONEHVACEVAPORATIVECOOLERUNIT_HPP | ||
| 31 | #define MODEL_ZONEHVACEVAPORATIVECOOLERUNIT_HPP | ||
| 32 | |||
| 33 | #include <model/ModelAPI.hpp> | ||
| 34 | #include "ZoneHVACComponent.hpp" | ||
| 35 | |||
| 36 | namespace openstudio { | ||
| 37 | |||
| 38 | namespace model { | ||
| 39 | |||
| 40 | class Schedule; | ||
| 41 | class HVACComponent; | ||
| 42 | |||
| 43 | namespace detail { | ||
| 44 | |||
| 45 | class ZoneHVACEvaporativeCoolerUnit_Impl; | ||
| 46 | |||
| 47 | } // namespace detail | ||
| 48 | |||
| 49 | /** ZoneHVACEvaporativeCoolerUnit is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:EvaporativeCoolerUnit'. */ | ||
| 50 | class MODEL_API ZoneHVACEvaporativeCoolerUnit : public ZoneHVACComponent | ||
| 51 | { | ||
| 52 | public: | ||
| 53 | /** @name Constructors and Destructors */ | ||
| 54 | //@{ | ||
| 55 | |||
| 56 | explicit ZoneHVACEvaporativeCoolerUnit(const Model& model); | ||
| 57 | |||
| 58 | explicit ZoneHVACEvaporativeCoolerUnit(const Model& model, Schedule& availabilitySchedule, HVACComponent& supplyAirFan, | ||
| 59 | HVACComponent& firstEvaporativeCooler); | ||
| 60 | |||
| 61 | 31 | virtual ~ZoneHVACEvaporativeCoolerUnit() = default; | |
| 62 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 63 | ✗ | ZoneHVACEvaporativeCoolerUnit(const ZoneHVACEvaporativeCoolerUnit& other) = default; | |
| 64 | 1 | ZoneHVACEvaporativeCoolerUnit(ZoneHVACEvaporativeCoolerUnit&& other) = default; | |
| 65 | ✗ | ZoneHVACEvaporativeCoolerUnit& operator=(const ZoneHVACEvaporativeCoolerUnit&) = default; | |
| 66 | ✗ | ZoneHVACEvaporativeCoolerUnit& operator=(ZoneHVACEvaporativeCoolerUnit&&) = default; | |
| 67 | |||
| 68 | //@} | ||
| 69 | |||
| 70 | static IddObjectType iddObjectType(); | ||
| 71 | |||
| 72 | static std::vector<std::string> fanPlacementValues(); | ||
| 73 | |||
| 74 | static std::vector<std::string> coolerUnitControlMethodValues(); | ||
| 75 | |||
| 76 | /** @name Getters */ | ||
| 77 | //@{ | ||
| 78 | |||
| 79 | Schedule availabilitySchedule() const; | ||
| 80 | |||
| 81 | HVACComponent supplyAirFan() const; | ||
| 82 | |||
| 83 | boost::optional<double> designSupplyAirFlowRate() const; | ||
| 84 | |||
| 85 | bool isDesignSupplyAirFlowRateAutosized() const; | ||
| 86 | |||
| 87 | std::string fanPlacement() const; | ||
| 88 | |||
| 89 | std::string coolerUnitControlMethod() const; | ||
| 90 | |||
| 91 | double throttlingRangeTemperatureDifference() const; | ||
| 92 | |||
| 93 | double coolingLoadControlThresholdHeatTransferRate() const; | ||
| 94 | |||
| 95 | HVACComponent firstEvaporativeCooler() const; | ||
| 96 | |||
| 97 | boost::optional<HVACComponent> secondEvaporativeCooler() const; | ||
| 98 | |||
| 99 | double shutOffRelativeHumidity() const; | ||
| 100 | |||
| 101 | //@} | ||
| 102 | /** @name Setters */ | ||
| 103 | //@{ | ||
| 104 | |||
| 105 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 106 | |||
| 107 | bool setSupplyAirFan(const HVACComponent& hvacComponent); | ||
| 108 | |||
| 109 | bool setDesignSupplyAirFlowRate(double designSupplyAirFlowRate); | ||
| 110 | |||
| 111 | void autosizeDesignSupplyAirFlowRate(); | ||
| 112 | |||
| 113 | bool setFanPlacement(const std::string& fanPlacement); | ||
| 114 | |||
| 115 | bool setCoolerUnitControlMethod(const std::string& coolerUnitControlMethod); | ||
| 116 | |||
| 117 | bool setThrottlingRangeTemperatureDifference(double throttlingRangeTemperatureDifference); | ||
| 118 | |||
| 119 | bool setCoolingLoadControlThresholdHeatTransferRate(double coolingLoadControlThresholdHeatTransferRate); | ||
| 120 | |||
| 121 | bool setFirstEvaporativeCooler(const HVACComponent& hvacComponent); | ||
| 122 | |||
| 123 | bool setSecondEvaporativeCooler(const HVACComponent& hvacComponent); | ||
| 124 | |||
| 125 | void resetSecondEvaporativeCooler(); | ||
| 126 | |||
| 127 | bool setShutOffRelativeHumidity(double shutOffRelativeHumidity); | ||
| 128 | |||
| 129 | //@} | ||
| 130 | /** @name Other */ | ||
| 131 | //@{ | ||
| 132 | |||
| 133 | boost::optional<double> autosizedDesignSupplyAirFlowRate(); | ||
| 134 | |||
| 135 | //@} | ||
| 136 | protected: | ||
| 137 | /// @cond | ||
| 138 | using ImplType = detail::ZoneHVACEvaporativeCoolerUnit_Impl; | ||
| 139 | |||
| 140 | explicit ZoneHVACEvaporativeCoolerUnit(std::shared_ptr<detail::ZoneHVACEvaporativeCoolerUnit_Impl> impl); | ||
| 141 | |||
| 142 | friend class detail::ZoneHVACEvaporativeCoolerUnit_Impl; | ||
| 143 | friend class Model; | ||
| 144 | friend class IdfObject; | ||
| 145 | friend class openstudio::detail::IdfObject_Impl; | ||
| 146 | /// @endcond | ||
| 147 | private: | ||
| 148 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACEvaporativeCoolerUnit"); | |
| 149 | }; | ||
| 150 | |||
| 151 | /** \relates ZoneHVACEvaporativeCoolerUnit*/ | ||
| 152 | using OptionalZoneHVACEvaporativeCoolerUnit = boost::optional<ZoneHVACEvaporativeCoolerUnit>; | ||
| 153 | |||
| 154 | /** \relates ZoneHVACEvaporativeCoolerUnit*/ | ||
| 155 | using ZoneHVACEvaporativeCoolerUnitVector = std::vector<ZoneHVACEvaporativeCoolerUnit>; | ||
| 156 | |||
| 157 | } // namespace model | ||
| 158 | } // namespace openstudio | ||
| 159 | |||
| 160 | #endif // MODEL_ZONEHVACEVAPORATIVECOOLERUNIT_HPP | ||
| 161 |