src/model/HeatExchangerFluidToFluid_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_HEATEXCHANGERFLUIDTOFLUID_IMPL_HPP | ||
| 7 | #define MODEL_HEATEXCHANGERFLUIDTOFLUID_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "WaterToWaterComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class Node; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | /** HeatExchangerFluidToFluid_Impl is a WaterToWaterComponent_Impl that is the implementation class for HeatExchangerFluidToFluid.*/ | ||
| 22 | class MODEL_API HeatExchangerFluidToFluid_Impl : public WaterToWaterComponent_Impl | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | HeatExchangerFluidToFluid_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | HeatExchangerFluidToFluid_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | HeatExchangerFluidToFluid_Impl(const HeatExchangerFluidToFluid_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | 10 | virtual ~HeatExchangerFluidToFluid_Impl() override = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | /** @name Virtual Methods */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 41 | |||
| 42 | virtual IddObjectType iddObjectType() const override; | ||
| 43 | |||
| 44 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 45 | |||
| 46 | virtual unsigned supplyInletPort() const override; | ||
| 47 | |||
| 48 | virtual unsigned supplyOutletPort() const override; | ||
| 49 | |||
| 50 | virtual unsigned demandInletPort() const override; | ||
| 51 | |||
| 52 | virtual unsigned demandOutletPort() const override; | ||
| 53 | |||
| 54 | virtual void autosize() override; | ||
| 55 | |||
| 56 | virtual void applySizingValues() override; | ||
| 57 | |||
| 58 | virtual ComponentType componentType() const override; | ||
| 59 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 60 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 61 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 62 | |||
| 63 | //@} | ||
| 64 | /** @name Getters */ | ||
| 65 | //@{ | ||
| 66 | |||
| 67 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 68 | |||
| 69 | boost::optional<double> loopDemandSideDesignFlowRate() const; | ||
| 70 | |||
| 71 | bool isLoopDemandSideDesignFlowRateAutosized() const; | ||
| 72 | |||
| 73 | boost::optional<double> loopSupplySideDesignFlowRate() const; | ||
| 74 | |||
| 75 | bool isLoopSupplySideDesignFlowRateAutosized() const; | ||
| 76 | |||
| 77 | std::string heatExchangeModelType() const; | ||
| 78 | |||
| 79 | bool isHeatExchangeModelTypeDefaulted() const; | ||
| 80 | |||
| 81 | boost::optional<double> heatExchangerUFactorTimesAreaValue() const; | ||
| 82 | |||
| 83 | bool isHeatExchangerUFactorTimesAreaValueAutosized() const; | ||
| 84 | |||
| 85 | std::string controlType() const; | ||
| 86 | |||
| 87 | bool isControlTypeDefaulted() const; | ||
| 88 | |||
| 89 | double minimumTemperatureDifferencetoActivateHeatExchanger() const; | ||
| 90 | |||
| 91 | bool isMinimumTemperatureDifferencetoActivateHeatExchangerDefaulted() const; | ||
| 92 | |||
| 93 | std::string heatTransferMeteringEndUseType() const; | ||
| 94 | |||
| 95 | bool isHeatTransferMeteringEndUseTypeDefaulted() const; | ||
| 96 | |||
| 97 | boost::optional<Node> componentOverrideLoopSupplySideInletNode() const; | ||
| 98 | |||
| 99 | boost::optional<Node> componentOverrideLoopDemandSideInletNode() const; | ||
| 100 | |||
| 101 | std::string componentOverrideCoolingControlTemperatureMode() const; | ||
| 102 | |||
| 103 | bool isComponentOverrideCoolingControlTemperatureModeDefaulted() const; | ||
| 104 | |||
| 105 | double sizingFactor() const; | ||
| 106 | |||
| 107 | bool isSizingFactorDefaulted() const; | ||
| 108 | |||
| 109 | boost::optional<double> operationMinimumTemperatureLimit() const; | ||
| 110 | |||
| 111 | boost::optional<double> operationMaximumTemperatureLimit() const; | ||
| 112 | |||
| 113 | boost::optional<double> autosizedLoopDemandSideDesignFlowRate() const; | ||
| 114 | |||
| 115 | boost::optional<double> autosizedLoopSupplySideDesignFlowRate() const; | ||
| 116 | |||
| 117 | boost::optional<double> autosizedHeatExchangerUFactorTimesAreaValue() const; | ||
| 118 | |||
| 119 | //@} | ||
| 120 | /** @name Setters */ | ||
| 121 | //@{ | ||
| 122 | |||
| 123 | // TODO: Check argument type. From object lists, some candidates are: Schedule. | ||
| 124 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 125 | |||
| 126 | void resetAvailabilitySchedule(); | ||
| 127 | |||
| 128 | bool setLoopDemandSideDesignFlowRate(boost::optional<double> loopDemandSideDesignFlowRate); | ||
| 129 | |||
| 130 | void autosizeLoopDemandSideDesignFlowRate(); | ||
| 131 | |||
| 132 | bool setLoopSupplySideDesignFlowRate(boost::optional<double> loopSupplySideDesignFlowRate); | ||
| 133 | |||
| 134 | void autosizeLoopSupplySideDesignFlowRate(); | ||
| 135 | |||
| 136 | bool setHeatExchangeModelType(const std::string& heatExchangeModelType); | ||
| 137 | |||
| 138 | void resetHeatExchangeModelType(); | ||
| 139 | |||
| 140 | bool setHeatExchangerUFactorTimesAreaValue(boost::optional<double> heatExchangerUFactorTimesAreaValue); | ||
| 141 | |||
| 142 | void autosizeHeatExchangerUFactorTimesAreaValue(); | ||
| 143 | |||
| 144 | bool setControlType(const std::string& controlType); | ||
| 145 | |||
| 146 | void resetControlType(); | ||
| 147 | |||
| 148 | bool setMinimumTemperatureDifferencetoActivateHeatExchanger(double minimumTemperatureDifferencetoActivateHeatExchanger); | ||
| 149 | |||
| 150 | void resetMinimumTemperatureDifferencetoActivateHeatExchanger(); | ||
| 151 | |||
| 152 | bool setHeatTransferMeteringEndUseType(const std::string& heatTransferMeteringEndUseType); | ||
| 153 | |||
| 154 | void resetHeatTransferMeteringEndUseType(); | ||
| 155 | |||
| 156 | bool setComponentOverrideLoopSupplySideInletNode(const boost::optional<Node>& node); | ||
| 157 | |||
| 158 | void resetComponentOverrideLoopSupplySideInletNode(); | ||
| 159 | |||
| 160 | bool setComponentOverrideLoopDemandSideInletNode(const boost::optional<Node>& node); | ||
| 161 | |||
| 162 | void resetComponentOverrideLoopDemandSideInletNode(); | ||
| 163 | |||
| 164 | bool setComponentOverrideCoolingControlTemperatureMode(const std::string& componentOverrideCoolingControlTemperatureMode); | ||
| 165 | |||
| 166 | void resetComponentOverrideCoolingControlTemperatureMode(); | ||
| 167 | |||
| 168 | bool setSizingFactor(double sizingFactor); | ||
| 169 | |||
| 170 | void resetSizingFactor(); | ||
| 171 | |||
| 172 | bool setOperationMinimumTemperatureLimit(boost::optional<double> operationMinimumTemperatureLimit); | ||
| 173 | |||
| 174 | void resetOperationMinimumTemperatureLimit(); | ||
| 175 | |||
| 176 | bool setOperationMaximumTemperatureLimit(boost::optional<double> operationMaximumTemperatureLimit); | ||
| 177 | |||
| 178 | void resetOperationMaximumTemperatureLimit(); | ||
| 179 | |||
| 180 | //@} | ||
| 181 | /** @name Other */ | ||
| 182 | //@{ | ||
| 183 | |||
| 184 | //@} | ||
| 185 | protected: | ||
| 186 | private: | ||
| 187 | − | REGISTER_LOGGER("openstudio.model.HeatExchangerFluidToFluid"); | |
| 188 | }; | ||
| 189 | |||
| 190 | } // namespace detail | ||
| 191 | |||
| 192 | } // namespace model | ||
| 193 | } // namespace openstudio | ||
| 194 | |||
| 195 | #endif // MODEL_HEATEXCHANGERFLUIDTOFLUID_IMPL_HPP | ||
| 196 |