src/model/CoilCoolingDXCurveFitOperatingMode.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_COILCOOLINGDXCURVEFITOPERATINGMODE_HPP | ||
| 7 | #define MODEL_COILCOOLINGDXCURVEFITOPERATINGMODE_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "ResourceObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class CoilCoolingDXCurveFitPerformance; | ||
| 17 | class CoilCoolingDXCurveFitSpeed; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class CoilCoolingDXCurveFitOperatingMode_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** CoilCoolingDXCurveFitOperatingMode is a ResourceObject that wraps the OpenStudio IDD object 'OS:Coil:Cooling:DX:CurveFit:OperatingMode'. */ | ||
| 26 | class MODEL_API CoilCoolingDXCurveFitOperatingMode : public ResourceObject | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit CoilCoolingDXCurveFitOperatingMode(const Model& model); | ||
| 33 | |||
| 34 | 383 | virtual ~CoilCoolingDXCurveFitOperatingMode() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | 48 | CoilCoolingDXCurveFitOperatingMode(const CoilCoolingDXCurveFitOperatingMode& other) = default; | |
| 37 | 171 | CoilCoolingDXCurveFitOperatingMode(CoilCoolingDXCurveFitOperatingMode&& other) = default; | |
| 38 | ✗ | CoilCoolingDXCurveFitOperatingMode& operator=(const CoilCoolingDXCurveFitOperatingMode&) = default; | |
| 39 | ✗ | CoilCoolingDXCurveFitOperatingMode& operator=(CoilCoolingDXCurveFitOperatingMode&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | static std::vector<std::string> condenserTypeValues(); | ||
| 46 | |||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | boost::optional<double> ratedGrossTotalCoolingCapacity() const; | ||
| 51 | |||
| 52 | bool isRatedGrossTotalCoolingCapacityAutosized() const; | ||
| 53 | |||
| 54 | boost::optional<double> ratedEvaporatorAirFlowRate() const; | ||
| 55 | |||
| 56 | bool isRatedEvaporatorAirFlowRateAutosized() const; | ||
| 57 | |||
| 58 | boost::optional<double> ratedCondenserAirFlowRate() const; | ||
| 59 | |||
| 60 | bool isRatedCondenserAirFlowRateAutosized() const; | ||
| 61 | |||
| 62 | double maximumCyclingRate() const; | ||
| 63 | |||
| 64 | double ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity() const; | ||
| 65 | |||
| 66 | double latentCapacityTimeConstant() const; | ||
| 67 | |||
| 68 | double nominalTimeforCondensateRemovaltoBegin() const; | ||
| 69 | |||
| 70 | bool applyPartLoadFractiontoSpeedsGreaterthan1() const; | ||
| 71 | |||
| 72 | bool applyLatentDegradationtoSpeedsGreaterthan1() const; | ||
| 73 | |||
| 74 | std::string condenserType() const; | ||
| 75 | |||
| 76 | boost::optional<double> nominalEvaporativeCondenserPumpPower() const; | ||
| 77 | |||
| 78 | bool isNominalEvaporativeCondenserPumpPowerAutosized() const; | ||
| 79 | |||
| 80 | // Returns the nominal speed number if set, or the number of speeds if not | ||
| 81 | unsigned nominalSpeedNumber() const; | ||
| 82 | bool isNominalSpeedNumberDefaulted() const; | ||
| 83 | |||
| 84 | //@} | ||
| 85 | /** @name Setters */ | ||
| 86 | //@{ | ||
| 87 | |||
| 88 | bool setRatedGrossTotalCoolingCapacity(double ratedGrossTotalCoolingCapacity); | ||
| 89 | void autosizeRatedGrossTotalCoolingCapacity(); | ||
| 90 | |||
| 91 | bool setRatedEvaporatorAirFlowRate(double ratedEvaporatorAirFlowRate); | ||
| 92 | void autosizeRatedEvaporatorAirFlowRate(); | ||
| 93 | |||
| 94 | bool setRatedCondenserAirFlowRate(double ratedCondenserAirFlowRate); | ||
| 95 | void autosizeRatedCondenserAirFlowRate(); | ||
| 96 | |||
| 97 | bool setMaximumCyclingRate(double maximumCyclingRate); | ||
| 98 | |||
| 99 | bool | ||
| 100 | setRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity(double ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity); | ||
| 101 | |||
| 102 | bool setLatentCapacityTimeConstant(double latentCapacityTimeConstant); | ||
| 103 | |||
| 104 | bool setNominalTimeforCondensateRemovaltoBegin(double nominalTimeforCondensateRemovaltoBegin); | ||
| 105 | |||
| 106 | bool setApplyPartLoadFractiontoSpeedsGreaterthan1(bool applyPartLoadFractiontoSpeedsGreaterthan1); | ||
| 107 | |||
| 108 | bool setApplyLatentDegradationtoSpeedsGreaterthan1(bool applyLatentDegradationtoSpeedsGreaterthan1); | ||
| 109 | |||
| 110 | bool setCondenserType(const std::string& condenserType); | ||
| 111 | |||
| 112 | bool setNominalEvaporativeCondenserPumpPower(double nominalEvaporativeCondenserPumpPower); | ||
| 113 | void autosizeNominalEvaporativeCondenserPumpPower(); | ||
| 114 | |||
| 115 | bool setNominalSpeedNumber(unsigned nominalSpeedNumber); | ||
| 116 | void resetNominalSpeedNumber(); | ||
| 117 | |||
| 118 | //@} | ||
| 119 | /** @name Other */ | ||
| 120 | //@{ | ||
| 121 | |||
| 122 | boost::optional<double> autosizedRatedGrossTotalCoolingCapacity(); | ||
| 123 | |||
| 124 | boost::optional<double> autosizedRatedEvaporatorAirFlowRate(); | ||
| 125 | |||
| 126 | boost::optional<double> autosizedRatedCondenserAirFlowRate(); | ||
| 127 | |||
| 128 | boost::optional<double> autosizedNominalEvaporativeCondenserPumpPower(); | ||
| 129 | |||
| 130 | void autosize(); | ||
| 131 | |||
| 132 | void applySizingValues(); | ||
| 133 | |||
| 134 | std::vector<CoilCoolingDXCurveFitPerformance> coilCoolingDXCurveFitPerformances() const; | ||
| 135 | |||
| 136 | std::vector<CoilCoolingDXCurveFitSpeed> speeds() const; | ||
| 137 | |||
| 138 | unsigned numberOfSpeeds() const; | ||
| 139 | |||
| 140 | /* | ||
| 141 | * Get the index of a given CoilCoolingDXCurveFitSpeed (1-indexed) | ||
| 142 | */ | ||
| 143 | boost::optional<unsigned> speedIndex(const CoilCoolingDXCurveFitSpeed& speed) const; | ||
| 144 | |||
| 145 | /* | ||
| 146 | * Add a new CoilCoolingDXCurveFitSpeed at the end of the list (priority = last). | ||
| 147 | */ | ||
| 148 | bool addSpeed(const CoilCoolingDXCurveFitSpeed& speed); | ||
| 149 | |||
| 150 | /* | ||
| 151 | * Add a new CoilCoolingDXCurveFitSpeed to the list which a given index (1 to x). | ||
| 152 | * Internally calls addSpeed then setSpeedIndex, see remarks there | ||
| 153 | */ | ||
| 154 | bool addSpeed(const CoilCoolingDXCurveFitSpeed& speed, unsigned index); | ||
| 155 | |||
| 156 | /* | ||
| 157 | * You can shuffle the priority of a given CoilCoolingDXCurveFitSpeed after having added it | ||
| 158 | * If index is below 1, it's reset to 1. | ||
| 159 | * If index is greater than the number of speeds, will reset to last | ||
| 160 | */ | ||
| 161 | bool setSpeedIndex(const CoilCoolingDXCurveFitSpeed& speed, unsigned index); | ||
| 162 | |||
| 163 | /* | ||
| 164 | * Set all speeds using a list of CoilCoolingDXCurveFitSpeeds | ||
| 165 | * Internally calls addSpeed, and will return the global status, but will continue trying if there are problems | ||
| 166 | * (eg: if you make a vector larger than the number of accepted speeds, or a vector that has a speed from another model, the valid speeds will be | ||
| 167 | * added indeed, but it'll eventually return false) | ||
| 168 | */ | ||
| 169 | bool setSpeeds(const std::vector<CoilCoolingDXCurveFitSpeed>& speeds); | ||
| 170 | |||
| 171 | /* | ||
| 172 | * Removes all CoilCoolingDXCurveFitSpeeds in this object | ||
| 173 | */ | ||
| 174 | void removeAllSpeeds(); | ||
| 175 | |||
| 176 | /* | ||
| 177 | * Remove the given CoilCoolingDXCurveFitSpeed from this object's speeds | ||
| 178 | */ | ||
| 179 | bool removeSpeed(const CoilCoolingDXCurveFitSpeed& speed); | ||
| 180 | |||
| 181 | /* | ||
| 182 | * Remove the CoilCoolingDXCurveFitSpeed at the given index (1-indexed) | ||
| 183 | */ | ||
| 184 | bool removeSpeed(unsigned index); | ||
| 185 | |||
| 186 | //@} | ||
| 187 | protected: | ||
| 188 | /// @cond | ||
| 189 | using ImplType = detail::CoilCoolingDXCurveFitOperatingMode_Impl; | ||
| 190 | |||
| 191 | explicit CoilCoolingDXCurveFitOperatingMode(std::shared_ptr<detail::CoilCoolingDXCurveFitOperatingMode_Impl> impl); | ||
| 192 | |||
| 193 | friend class detail::CoilCoolingDXCurveFitOperatingMode_Impl; | ||
| 194 | friend class Model; | ||
| 195 | friend class IdfObject; | ||
| 196 | friend class openstudio::detail::IdfObject_Impl; | ||
| 197 | /// @endcond | ||
| 198 | private: | ||
| 199 | REGISTER_LOGGER("openstudio.model.CoilCoolingDXCurveFitOperatingMode"); | ||
| 200 | }; | ||
| 201 | |||
| 202 | /** \relates CoilCoolingDXCurveFitOperatingMode*/ | ||
| 203 | using OptionalCoilCoolingDXCurveFitOperatingMode = boost::optional<CoilCoolingDXCurveFitOperatingMode>; | ||
| 204 | |||
| 205 | /** \relates CoilCoolingDXCurveFitOperatingMode*/ | ||
| 206 | using CoilCoolingDXCurveFitOperatingModeVector = std::vector<CoilCoolingDXCurveFitOperatingMode>; | ||
| 207 | |||
| 208 | } // namespace model | ||
| 209 | } // namespace openstudio | ||
| 210 | |||
| 211 | #endif // MODEL_COILCOOLINGDXCURVEFITOPERATINGMODE_HPP | ||
| 212 |