src/model/CoilHeatingGas.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_COILHEATINGGAS_HPP | ||
| 7 | #define MODEL_COILHEATINGGAS_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | #include "StraightComponent.hpp" | ||
| 12 | #include "Connection.hpp" | ||
| 13 | #include "../utilities/core/Deprecated.hpp" | ||
| 14 | |||
| 15 | namespace openstudio { | ||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Curve; | ||
| 19 | class AirflowNetworkEquivlentDuct; | ||
| 20 | class Schedule; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | class CoilHeatingGas_Impl; | ||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** CoilHeatingGas is an interface to the IDD object named "OS:Coil:Heating:Gas" | ||
| 27 | * | ||
| 28 | * The purpose of this class is to simplify the construction and manipulation | ||
| 29 | * OS:Coil:Heating:Gas objects in energyplus. | ||
| 30 | * | ||
| 31 | * As of EnergyPlus Version 8.6 this object maps to Coil:Heating:Fuel. | ||
| 32 | */ | ||
| 33 | class MODEL_API CoilHeatingGas : public StraightComponent | ||
| 34 | { | ||
| 35 | |||
| 36 | public: | ||
| 37 | /** @name Constructors and Destructors */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | /** Constructs a new CoilHeatingGas object and places it inside the | ||
| 41 | * model. The object is fully initialized with all companion objects. | ||
| 42 | * | ||
| 43 | * Sets GasBurnerEffeciency to .8 | ||
| 44 | * Sets GasFields to AutoSize | ||
| 45 | * Sets ParasiticElectricLoad to 0 | ||
| 46 | * Sets ParasiticGasLoad to 0 | ||
| 47 | */ | ||
| 48 | explicit CoilHeatingGas(const Model& model, Schedule& schedule); | ||
| 49 | |||
| 50 | explicit CoilHeatingGas(const Model& model); | ||
| 51 | |||
| 52 | 252 | virtual ~CoilHeatingGas() override = default; | |
| 53 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 54 | ✗ | CoilHeatingGas(const CoilHeatingGas& other) = default; | |
| 55 | 5 | CoilHeatingGas(CoilHeatingGas&& other) = default; | |
| 56 | ✗ | CoilHeatingGas& operator=(const CoilHeatingGas&) = default; | |
| 57 | ✗ | CoilHeatingGas& operator=(CoilHeatingGas&&) = default; | |
| 58 | |||
| 59 | //@} | ||
| 60 | |||
| 61 | static IddObjectType iddObjectType(); | ||
| 62 | |||
| 63 | /** @name Getters and Setters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | /** Returns the Schedule referred to by the Availability Schedule field. **/ | ||
| 67 | Schedule availabilitySchedule() const; | ||
| 68 | |||
| 69 | /** \deprecated */ | ||
| 70 | Schedule availableSchedule() const; | ||
| 71 | |||
| 72 | /** Sets the Schedule referred to by the Availability Schedule field. **/ | ||
| 73 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 74 | |||
| 75 | /** \deprecated */ | ||
| 76 | bool setAvailableSchedule(Schedule& schedule); | ||
| 77 | |||
| 78 | /** Returns a list of valid fuel types. **/ | ||
| 79 | static std::vector<std::string> validFuelTypeValues(); | ||
| 80 | |||
| 81 | /** Gets the coil fuel type **/ | ||
| 82 | std::string fuelType() const; | ||
| 83 | |||
| 84 | /** Sets the fuel type. **/ | ||
| 85 | bool setFuelType(const std::string& fuelType); | ||
| 86 | |||
| 87 | /** Resets the fuel type to its default. **/ | ||
| 88 | void resetFuelType(); | ||
| 89 | |||
| 90 | /** Returns the value of the GasBurnerEfficiency field. **/ | ||
| 91 | double gasBurnerEfficiency() const; | ||
| 92 | |||
| 93 | /** Sets the value of the GasBurnerEfficiency field. **/ | ||
| 94 | bool setGasBurnerEfficiency(double value); | ||
| 95 | |||
| 96 | /** Returns the value of the ParasiticElectricLoad field. **/ | ||
| 97 | OS_DEPRECATED(3, 7, 0) double parasiticElectricLoad() const; | ||
| 98 | |||
| 99 | /** Returns the value of the OnCycleParasiticElectricLoad field. **/ | ||
| 100 | double onCycleParasiticElectricLoad() const; | ||
| 101 | |||
| 102 | /** Sets the value of the ParasiticElectricLoad field. **/ | ||
| 103 | OS_DEPRECATED(3, 7, 0) bool setParasiticElectricLoad(double value); | ||
| 104 | |||
| 105 | /** Sets the value of the OnCycleParasiticElectricLoad field. **/ | ||
| 106 | bool setOnCycleParasiticElectricLoad(double value); | ||
| 107 | |||
| 108 | /** Returns the value of the ParasiticGasLoad field. **/ | ||
| 109 | OS_DEPRECATED(3, 7, 0) double parasiticGasLoad() const; | ||
| 110 | |||
| 111 | /** Returns the value of the OffCycleParasiticGasLoad field. **/ | ||
| 112 | double offCycleParasiticGasLoad() const; | ||
| 113 | |||
| 114 | /** Sets the value of the ParasiticGasLoad field. **/ | ||
| 115 | OS_DEPRECATED(3, 7, 0) bool setParasiticGasLoad(double value); | ||
| 116 | |||
| 117 | /** Sets the value of the OffCycleParasiticGasLoad field. **/ | ||
| 118 | bool setOffCycleParasiticGasLoad(double value); | ||
| 119 | |||
| 120 | boost::optional<double> nominalCapacity() const; | ||
| 121 | |||
| 122 | bool isNominalCapacityAutosized() const; | ||
| 123 | |||
| 124 | bool setNominalCapacity(double nominalCapacity); | ||
| 125 | |||
| 126 | void resetNominalCapacity(); | ||
| 127 | |||
| 128 | void autosizeNominalCapacity(); | ||
| 129 | |||
| 130 | boost::optional<Curve> partLoadFractionCorrelationCurve() const; | ||
| 131 | |||
| 132 | bool setPartLoadFractionCorrelationCurve(const Curve& curve); | ||
| 133 | |||
| 134 | void resetPartLoadFractionCorrelationCurve(); | ||
| 135 | |||
| 136 | /** Creates a new equivalent duct object if an object is not already attached. */ | ||
| 137 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 138 | |||
| 139 | /** Returns the attached equivalent duct object, if any. */ | ||
| 140 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 141 | |||
| 142 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 143 | //@} | ||
| 144 | protected: | ||
| 145 | friend class Model; | ||
| 146 | |||
| 147 | friend class openstudio::IdfObject; | ||
| 148 | |||
| 149 | /// @cond | ||
| 150 | |||
| 151 | using ImplType = detail::CoilHeatingGas_Impl; | ||
| 152 | |||
| 153 | explicit CoilHeatingGas(std::shared_ptr<detail::CoilHeatingGas_Impl> impl); | ||
| 154 | |||
| 155 | private: | ||
| 156 | − | REGISTER_LOGGER("openstudio.model.CoilHeatingGas"); | |
| 157 | |||
| 158 | /// @endcond | ||
| 159 | }; | ||
| 160 | |||
| 161 | /** \relates CoilHeatingGas */ | ||
| 162 | using OptionalCoilHeatingGas = boost::optional<CoilHeatingGas>; | ||
| 163 | |||
| 164 | /** \relates CoilHeatingGas */ | ||
| 165 | using CoilHeatingGasVector = std::vector<CoilHeatingGas>; | ||
| 166 | |||
| 167 | } // namespace model | ||
| 168 | } // namespace openstudio | ||
| 169 | |||
| 170 | #endif // MODEL_COILHEATINGGAS_HPP | ||
| 171 |