src/model/BoilerHotWater_Impl.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_BOILERHOTWATER_IMPL_HPP | ||
| 7 | #define MODEL_BOILERHOTWATER_IMPL_HPP | ||
| 8 | |||
| 9 | #include "StraightComponent_Impl.hpp" | ||
| 10 | |||
| 11 | namespace openstudio { | ||
| 12 | namespace model { | ||
| 13 | |||
| 14 | class Curve; | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | /** BoilerHotWater_Impl is a StraightComponent_Impl that is the implementation class for BoilerHotWater.*/ | ||
| 19 | class MODEL_API BoilerHotWater_Impl : public StraightComponent_Impl | ||
| 20 | { | ||
| 21 | |||
| 22 | public: | ||
| 23 | /** @name Constructors and Destructors */ | ||
| 24 | //@{ | ||
| 25 | |||
| 26 | BoilerHotWater_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | BoilerHotWater_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | BoilerHotWater_Impl(const BoilerHotWater_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | 61 | virtual ~BoilerHotWater_Impl() override = default; | |
| 33 | |||
| 34 | //@} | ||
| 35 | /** @name Virtual Methods */ | ||
| 36 | //@{ | ||
| 37 | |||
| 38 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 39 | |||
| 40 | virtual IddObjectType iddObjectType() const override; | ||
| 41 | |||
| 42 | virtual std::vector<ModelObject> children() const override; | ||
| 43 | |||
| 44 | virtual unsigned inletPort() const override; | ||
| 45 | |||
| 46 | virtual unsigned outletPort() const override; | ||
| 47 | |||
| 48 | virtual void autosize() override; | ||
| 49 | |||
| 50 | virtual void applySizingValues() override; | ||
| 51 | |||
| 52 | virtual bool addToNode(Node& node) override; | ||
| 53 | |||
| 54 | virtual ModelObject clone(Model model) const override; | ||
| 55 | |||
| 56 | virtual ComponentType componentType() const override; | ||
| 57 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 58 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 59 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 60 | |||
| 61 | //@} | ||
| 62 | /** @name Getters */ | ||
| 63 | //@{ | ||
| 64 | |||
| 65 | std::string fuelType() const; | ||
| 66 | |||
| 67 | boost::optional<double> nominalCapacity() const; | ||
| 68 | |||
| 69 | bool isNominalCapacityAutosized() const; | ||
| 70 | |||
| 71 | double nominalThermalEfficiency() const; | ||
| 72 | |||
| 73 | boost::optional<std::string> efficiencyCurveTemperatureEvaluationVariable() const; | ||
| 74 | |||
| 75 | boost::optional<Curve> normalizedBoilerEfficiencyCurve() const; | ||
| 76 | |||
| 77 | boost::optional<double> designWaterFlowRate() const; | ||
| 78 | |||
| 79 | bool isDesignWaterFlowRateAutosized() const; | ||
| 80 | |||
| 81 | double minimumPartLoadRatio() const; | ||
| 82 | |||
| 83 | bool isMinimumPartLoadRatioDefaulted() const; | ||
| 84 | |||
| 85 | double maximumPartLoadRatio() const; | ||
| 86 | |||
| 87 | bool isMaximumPartLoadRatioDefaulted() const; | ||
| 88 | |||
| 89 | double optimumPartLoadRatio() const; | ||
| 90 | |||
| 91 | bool isOptimumPartLoadRatioDefaulted() const; | ||
| 92 | |||
| 93 | double waterOutletUpperTemperatureLimit() const; | ||
| 94 | |||
| 95 | bool isWaterOutletUpperTemperatureLimitDefaulted() const; | ||
| 96 | |||
| 97 | std::string boilerFlowMode() const; | ||
| 98 | |||
| 99 | bool isBoilerFlowModeDefaulted() const; | ||
| 100 | |||
| 101 | double onCycleParasiticElectricLoad() const; | ||
| 102 | |||
| 103 | double sizingFactor() const; | ||
| 104 | |||
| 105 | bool isSizingFactorDefaulted() const; | ||
| 106 | |||
| 107 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 108 | |||
| 109 | boost::optional<double> autosizedDesignWaterFlowRate() const; | ||
| 110 | |||
| 111 | std::string endUseSubcategory() const; | ||
| 112 | |||
| 113 | double offCycleParasiticFuelLoad() const; | ||
| 114 | |||
| 115 | //@} | ||
| 116 | /** @name Setters */ | ||
| 117 | //@{ | ||
| 118 | |||
| 119 | bool setFuelType(const std::string& fuelType); | ||
| 120 | |||
| 121 | bool setNominalCapacity(boost::optional<double> nominalCapacity); | ||
| 122 | |||
| 123 | void resetNominalCapacity(); | ||
| 124 | |||
| 125 | void autosizeNominalCapacity(); | ||
| 126 | |||
| 127 | bool setNominalThermalEfficiency(double nominalThermalEfficiency); | ||
| 128 | |||
| 129 | bool setEfficiencyCurveTemperatureEvaluationVariable(boost::optional<std::string> efficiencyCurveTemperatureEvaluationVariable); | ||
| 130 | |||
| 131 | void resetEfficiencyCurveTemperatureEvaluationVariable(); | ||
| 132 | |||
| 133 | bool setNormalizedBoilerEfficiencyCurve(const boost::optional<Curve>& normalizedBoilerEfficiencyCurve); | ||
| 134 | |||
| 135 | void resetNormalizedBoilerEfficiencyCurve(); | ||
| 136 | |||
| 137 | bool setDesignWaterFlowRate(boost::optional<double> designWaterFlowRate); | ||
| 138 | |||
| 139 | void resetDesignWaterFlowRate(); | ||
| 140 | |||
| 141 | void autosizeDesignWaterFlowRate(); | ||
| 142 | |||
| 143 | bool setMinimumPartLoadRatio(double minimumPartLoadRatio); | ||
| 144 | |||
| 145 | void resetMinimumPartLoadRatio(); | ||
| 146 | |||
| 147 | bool setMaximumPartLoadRatio(double maximumPartLoadRatio); | ||
| 148 | |||
| 149 | void resetMaximumPartLoadRatio(); | ||
| 150 | |||
| 151 | bool setOptimumPartLoadRatio(double optimumPartLoadRatio); | ||
| 152 | |||
| 153 | void resetOptimumPartLoadRatio(); | ||
| 154 | |||
| 155 | bool setWaterOutletUpperTemperatureLimit(double waterOutletUpperTemperatureLimit); | ||
| 156 | |||
| 157 | void resetWaterOutletUpperTemperatureLimit(); | ||
| 158 | |||
| 159 | bool setBoilerFlowMode(const std::string& boilerFlowMode); | ||
| 160 | |||
| 161 | void resetBoilerFlowMode(); | ||
| 162 | |||
| 163 | bool setOnCycleParasiticElectricLoad(double onCycleParasiticElectricLoad); | ||
| 164 | |||
| 165 | bool setSizingFactor(double sizingFactor); | ||
| 166 | |||
| 167 | void resetSizingFactor(); | ||
| 168 | |||
| 169 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 170 | |||
| 171 | bool setOffCycleParasiticFuelLoad(double offCycleParasiticFuelLoad); | ||
| 172 | |||
| 173 | //@} | ||
| 174 | private: | ||
| 175 | REGISTER_LOGGER("openstudio.model.BoilerHotWater"); | ||
| 176 | |||
| 177 | boost::optional<ModelObject> normalizedBoilerEfficiencyCurveAsModelObject() const; | ||
| 178 | |||
| 179 | bool setNormalizedBoilerEfficiencyCurveAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 180 | }; | ||
| 181 | |||
| 182 | } // namespace detail | ||
| 183 | |||
| 184 | } // namespace model | ||
| 185 | } // namespace openstudio | ||
| 186 | |||
| 187 | #endif // MODEL_BOILERHOTWATER_IMPL_HPP | ||
| 188 |