src/model/EvaporativeCoolerDirectResearchSpecial.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_EVAPORATIVECOOLERDIRECTRESEARCHSPECIAL_HPP | ||
| 7 | #define MODEL_EVAPORATIVECOOLERDIRECTRESEARCHSPECIAL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | #include "StraightComponent.hpp" | ||
| 12 | #include "Connection.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | namespace model { | ||
| 16 | |||
| 17 | class Schedule; | ||
| 18 | class Curve; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | class EvaporativeCoolerDirectResearchSpecial_Impl; | ||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** EvaporativeCoolerDirectResearchSpecial is a StraightComponent that wraps the | ||
| 25 | * IDD object named "OS:EvaporativeCooler:Direct:ResearchSpecial". */ | ||
| 26 | class MODEL_API EvaporativeCoolerDirectResearchSpecial : public StraightComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | /** Constructs a new EvaporativeCoolerDirectResearchSpecial object and places it inside the | ||
| 33 | * model. The object is fully initialized with all companion objects. | ||
| 34 | */ | ||
| 35 | explicit EvaporativeCoolerDirectResearchSpecial(const Model& model, Schedule& schedule); | ||
| 36 | |||
| 37 | 233 | virtual ~EvaporativeCoolerDirectResearchSpecial() override = default; | |
| 38 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 39 | ✗ | EvaporativeCoolerDirectResearchSpecial(const EvaporativeCoolerDirectResearchSpecial& other) = default; | |
| 40 | 6 | EvaporativeCoolerDirectResearchSpecial(EvaporativeCoolerDirectResearchSpecial&& other) = default; | |
| 41 | ✗ | EvaporativeCoolerDirectResearchSpecial& operator=(const EvaporativeCoolerDirectResearchSpecial&) = default; | |
| 42 | ✗ | EvaporativeCoolerDirectResearchSpecial& operator=(EvaporativeCoolerDirectResearchSpecial&&) = default; | |
| 43 | |||
| 44 | //@} | ||
| 45 | |||
| 46 | static IddObjectType iddObjectType(); | ||
| 47 | |||
| 48 | /** @name Getters and Setters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | /** Returns the Schedule referred to by the Availability Schedule field. **/ | ||
| 52 | Schedule availabilitySchedule() const; | ||
| 53 | |||
| 54 | /** \deprecated */ | ||
| 55 | Schedule availableSchedule() const; | ||
| 56 | |||
| 57 | /** Sets the Schedule referred to by the AvailabilitySchedule field. **/ | ||
| 58 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 59 | |||
| 60 | /** \deprecated */ | ||
| 61 | bool setAvailableSchedule(Schedule& schedule); | ||
| 62 | |||
| 63 | /** Returns the value of the CoolerDesignEffectiveness field. **/ | ||
| 64 | double coolerDesignEffectiveness() const; | ||
| 65 | |||
| 66 | /** Deprecated: In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooler Design Effectiveness" **/ | ||
| 67 | double coolerEffectiveness() const; | ||
| 68 | |||
| 69 | /** Sets the value of the CoolerDesignEffectiveness field. **/ | ||
| 70 | bool setCoolerDesignEffectiveness(double value); | ||
| 71 | |||
| 72 | /** Deprecated: In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooler Design Effectiveness" **/ | ||
| 73 | bool setCoolerEffectiveness(double value); | ||
| 74 | |||
| 75 | /** Returns the value of the RecirculatingWaterPumpPowerConsumption field. **/ | ||
| 76 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Recirculating Water Pump Design Power" **/ | ||
| 77 | boost::optional<double> recirculatingWaterPumpPowerConsumption() const; | ||
| 78 | |||
| 79 | /** Sets the value of the RecirculatingWaterPumpPowerConsumption field. **/ | ||
| 80 | bool setRecirculatingWaterPumpPowerConsumption(double value); | ||
| 81 | |||
| 82 | void autosizeRecirculatingWaterPumpPowerConsumption(); | ||
| 83 | |||
| 84 | bool isRecirculatingWaterPumpPowerConsumptionAutosized() const; | ||
| 85 | |||
| 86 | /** Returns the value of the PrimaryAirDesignFlowRate field. **/ | ||
| 87 | boost::optional<double> primaryAirDesignFlowRate() const; | ||
| 88 | |||
| 89 | /** Sets the value of the PrimaryAirDesignFlowRate field. **/ | ||
| 90 | bool setPrimaryAirDesignFlowRate(double value); | ||
| 91 | |||
| 92 | void autosizePrimaryAirDesignFlowRate(); | ||
| 93 | |||
| 94 | bool isPrimaryAirDesignFlowRateAutosized() const; | ||
| 95 | |||
| 96 | /** Returns the Node referred to by the SensorNodeName field. **/ | ||
| 97 | boost::optional<Node> sensorNode() const; | ||
| 98 | |||
| 99 | /** Sets the Node referred to by the SensorNodeName field. **/ | ||
| 100 | bool setSensorNode(const Node& node); | ||
| 101 | |||
| 102 | /** Returns the value of the DriftLossFraction field. **/ | ||
| 103 | double driftLossFraction() const; | ||
| 104 | |||
| 105 | /** Sets the value of the DriftLossFraction field. **/ | ||
| 106 | bool setDriftLossFraction(double value); | ||
| 107 | |||
| 108 | /** Returns the value of the BlowdownConcentrationRatio field. **/ | ||
| 109 | double blowdownConcentrationRatio() const; | ||
| 110 | |||
| 111 | /** Sets the value of the BlowdownConcentrationRatio field. **/ | ||
| 112 | bool setBlowdownConcentrationRatio(double value); | ||
| 113 | |||
| 114 | boost::optional<Curve> effectivenessFlowRatioModifierCurve() const; | ||
| 115 | |||
| 116 | bool setEffectivenessFlowRatioModifierCurve(const Curve& curve); | ||
| 117 | |||
| 118 | void resetEffectivenessFlowRatioModifierCurve(); | ||
| 119 | |||
| 120 | double waterPumpPowerSizingFactor() const; | ||
| 121 | |||
| 122 | bool setWaterPumpPowerSizingFactor(double waterPumpPowerSizingFactor); | ||
| 123 | |||
| 124 | boost::optional<Curve> waterPumpPowerModifierCurve() const; | ||
| 125 | |||
| 126 | bool setWaterPumpPowerModifierCurve(const Curve& curve); | ||
| 127 | |||
| 128 | void resetWaterPumpPowerModifierCurve(); | ||
| 129 | |||
| 130 | /** Sets the minimum and maximum operation temperatures **/ | ||
| 131 | |||
| 132 | /** Returns the value of the EvaporativeOperationMinimumDrybulbTemperature field. **/ | ||
| 133 | double evaporativeOperationMinimumDrybulbTemperature() const; | ||
| 134 | /** Sets the value of the EvaporativeOperationMinimumDrybulbTemperature field. **/ | ||
| 135 | bool setEvaporativeOperationMinimumDrybulbTemperature(double evaporativeOperationMinimumDrybulbTemperature); | ||
| 136 | |||
| 137 | /** Returns the value of the EvaporativeOperationMaximumLimitWetbulbTemperature field. **/ | ||
| 138 | double evaporativeOperationMaximumLimitWetbulbTemperature() const; | ||
| 139 | /** Sets the value of the EvaporativeOperationMaximumLimitWetbulbTemperature field. **/ | ||
| 140 | bool setEvaporativeOperationMaximumLimitWetbulbTemperature(double evaporativeOperationMaximumLimitWetbulbTemperature); | ||
| 141 | |||
| 142 | /** Returns the value of the EvaporativeOperationMaximumLimitDrybulbTemperature field. **/ | ||
| 143 | double evaporativeOperationMaximumLimitDrybulbTemperature() const; | ||
| 144 | /** Sets the value of the EvaporativeOperationMaximumLimitDrybulbTemperature field. **/ | ||
| 145 | bool setEvaporativeOperationMaximumLimitDrybulbTemperature(double evaporativeOperationMaximumLimitDrybulbTemperature); | ||
| 146 | |||
| 147 | boost::optional<double> autosizedRecirculatingWaterPumpPowerConsumption() const; | ||
| 148 | |||
| 149 | boost::optional<double> autosizedPrimaryAirDesignFlowRate() const; | ||
| 150 | |||
| 151 | //@} | ||
| 152 | protected: | ||
| 153 | friend class Model; | ||
| 154 | friend class openstudio::IdfObject; | ||
| 155 | |||
| 156 | /// @cond | ||
| 157 | using ImplType = detail::EvaporativeCoolerDirectResearchSpecial_Impl; | ||
| 158 | |||
| 159 | explicit EvaporativeCoolerDirectResearchSpecial(std::shared_ptr<detail::EvaporativeCoolerDirectResearchSpecial_Impl> impl); | ||
| 160 | |||
| 161 | private: | ||
| 162 | − | REGISTER_LOGGER("openstudio.model.EvaporativeCoolerDirectResearchSpecial"); | |
| 163 | /// @endcond | ||
| 164 | }; | ||
| 165 | |||
| 166 | /** \relates EvaporativeCoolerDirectResearchSpecial */ | ||
| 167 | using OptionalEvaporativeCoolerDirectResearchSpecial = boost::optional<EvaporativeCoolerDirectResearchSpecial>; | ||
| 168 | |||
| 169 | /** \relates EvaporativeCoolerDirectResearchSpecial */ | ||
| 170 | using EvaporativeCoolerDirectResearchSpecialVector = std::vector<EvaporativeCoolerDirectResearchSpecial>; | ||
| 171 | |||
| 172 | } // namespace model | ||
| 173 | } // namespace openstudio | ||
| 174 | |||
| 175 | #endif // MODEL_EVAPORATIVECOOLERDIRECTRESEARCHSPECIAL_HPP | ||
| 176 |