src/model/CoilHeatingGasMultiStageStageData.cpp
| 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 | #include "CoilHeatingGasMultiStageStageData.hpp" | ||
| 7 | #include "CoilHeatingGasMultiStageStageData_Impl.hpp" | ||
| 8 | #include "../model/CoilHeatingGasMultiStage.hpp" | ||
| 9 | #include "../model/CoilHeatingGasMultiStage_Impl.hpp" | ||
| 10 | #include "../model/Model.hpp" | ||
| 11 | #include "../model/Model_Impl.hpp" | ||
| 12 | #include <utilities/idd/OS_Coil_Heating_Gas_MultiStage_StageData_FieldEnums.hxx> | ||
| 13 | #include <utilities/idd/IddEnums.hxx> | ||
| 14 | #include "../utilities/units/Unit.hpp" | ||
| 15 | #include "../utilities/core/Assert.hpp" | ||
| 16 | |||
| 17 | #include "../utilities/core/DeprecatedHelpers.hpp" // For deprecation | ||
| 18 | |||
| 19 | namespace openstudio { | ||
| 20 | namespace model { | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | 16 | CoilHeatingGasMultiStageStageData_Impl::CoilHeatingGasMultiStageStageData_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle) | |
| 25 | 16 | : ModelObject_Impl(idfObject, model, keepHandle) { | |
| 26 |
4/6✓ Branch 1 taken 16 times.
✓ Branch 4 taken 16 times.
✓ Branch 7 taken 16 times.
✗ Branch 10 not taken.
✓ Branch 11 taken 16 times.
✗ Branch 13 not taken.
|
16 | OS_ASSERT(idfObject.iddObject().type() == CoilHeatingGasMultiStageStageData::iddObjectType()); |
| 27 | 16 | } | |
| 28 | |||
| 29 | 1 | CoilHeatingGasMultiStageStageData_Impl::CoilHeatingGasMultiStageStageData_Impl(const openstudio::detail::WorkspaceObject_Impl& other, | |
| 30 | 1 | Model_Impl* model, bool keepHandle) | |
| 31 | 1 | : ModelObject_Impl(other, model, keepHandle) { | |
| 32 |
4/6✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
✓ Branch 7 taken 1 time.
✗ Branch 10 not taken.
✓ Branch 11 taken 1 time.
✗ Branch 13 not taken.
|
1 | OS_ASSERT(other.iddObject().type() == CoilHeatingGasMultiStageStageData::iddObjectType()); |
| 33 | 1 | } | |
| 34 | |||
| 35 | 10 | CoilHeatingGasMultiStageStageData_Impl::CoilHeatingGasMultiStageStageData_Impl(const CoilHeatingGasMultiStageStageData_Impl& other, | |
| 36 | 10 | Model_Impl* model, bool keepHandle) | |
| 37 | 10 | : ModelObject_Impl(other, model, keepHandle) {} | |
| 38 | |||
| 39 | ✗ | const std::vector<std::string>& CoilHeatingGasMultiStageStageData_Impl::outputVariableNames() const { | |
| 40 | ✗ | static const std::vector<std::string> result; | |
| 41 | ✗ | return result; | |
| 42 | } | ||
| 43 | |||
| 44 | ✗ | IddObjectType CoilHeatingGasMultiStageStageData_Impl::iddObjectType() const { | |
| 45 | ✗ | return CoilHeatingGasMultiStageStageData::iddObjectType(); | |
| 46 | } | ||
| 47 | |||
| 48 | 2 | double CoilHeatingGasMultiStageStageData_Impl::gasBurnerEfficiency() const { | |
| 49 |
1/1✓ Branch 1 taken 2 times.
|
2 | boost::optional<double> value = getDouble(OS_Coil_Heating_Gas_MultiStage_StageDataFields::GasBurnerEfficiency, true); |
| 50 |
1/3✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
✗ Branch 4 not taken.
|
2 | OS_ASSERT(value); |
| 51 |
1/1✓ Branch 1 taken 2 times.
|
4 | return value.get(); |
| 52 | } | ||
| 53 | |||
| 54 | 4 | boost::optional<double> CoilHeatingGasMultiStageStageData_Impl::nominalCapacity() const { | |
| 55 | 4 | return getDouble(OS_Coil_Heating_Gas_MultiStage_StageDataFields::NominalCapacity, true); | |
| 56 | } | ||
| 57 | |||
| 58 | 2 | bool CoilHeatingGasMultiStageStageData_Impl::isNominalCapacityAutosized() const { | |
| 59 | 2 | bool result = false; | |
| 60 |
1/1✓ Branch 1 taken 2 times.
|
2 | boost::optional<std::string> value = getString(OS_Coil_Heating_Gas_MultiStage_StageDataFields::NominalCapacity, true); |
| 61 |
1/2✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
|
2 | if (value) { |
| 62 |
3/3✓ Branch 1 taken 2 times.
✓ Branch 4 taken 2 times.
✓ Branch 7 taken 2 times.
|
4 | result = openstudio::istringEqual(value.get(), "autosize"); |
| 63 | } | ||
| 64 | 2 | return result; | |
| 65 | 2 | } | |
| 66 | |||
| 67 | 2 | double CoilHeatingGasMultiStageStageData_Impl::onCycleParasiticElectricLoad() const { | |
| 68 |
1/1✓ Branch 1 taken 2 times.
|
2 | boost::optional<double> value = getDouble(OS_Coil_Heating_Gas_MultiStage_StageDataFields::OnCycleParasiticElectricLoad, true); |
| 69 |
1/3✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
✗ Branch 4 not taken.
|
2 | OS_ASSERT(value); |
| 70 |
1/1✓ Branch 1 taken 2 times.
|
4 | return value.get(); |
| 71 | } | ||
| 72 | |||
| 73 | 17 | bool CoilHeatingGasMultiStageStageData_Impl::setGasBurnerEfficiency(double gasBurnerEfficiency) { | |
| 74 | 17 | bool result = setDouble(OS_Coil_Heating_Gas_MultiStage_StageDataFields::GasBurnerEfficiency, gasBurnerEfficiency); | |
| 75 | 17 | return result; | |
| 76 | } | ||
| 77 | |||
| 78 | 2 | bool CoilHeatingGasMultiStageStageData_Impl::setNominalCapacity(double nominalCapacity) { | |
| 79 | 2 | bool result = setDouble(OS_Coil_Heating_Gas_MultiStage_StageDataFields::NominalCapacity, nominalCapacity); | |
| 80 | 2 | return result; | |
| 81 | } | ||
| 82 | |||
| 83 | 15 | void CoilHeatingGasMultiStageStageData_Impl::autosizeNominalCapacity() { | |
| 84 |
2/2✓ Branch 1 taken 15 times.
✓ Branch 4 taken 15 times.
|
30 | bool result = setString(OS_Coil_Heating_Gas_MultiStage_StageDataFields::NominalCapacity, "autosize"); |
| 85 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 15 times.
|
15 | OS_ASSERT(result); |
| 86 | 15 | } | |
| 87 | |||
| 88 | 17 | bool CoilHeatingGasMultiStageStageData_Impl::setOnCycleParasiticElectricLoad(double onCycleParasiticElectricLoad) { | |
| 89 | 17 | bool result = setDouble(OS_Coil_Heating_Gas_MultiStage_StageDataFields::OnCycleParasiticElectricLoad, onCycleParasiticElectricLoad); | |
| 90 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 17 times.
|
17 | OS_ASSERT(result); |
| 91 | 17 | return result; | |
| 92 | } | ||
| 93 | |||
| 94 | ✗ | std::vector<IdfObject> CoilHeatingGasMultiStageStageData_Impl::remove() { | |
| 95 | ✗ | if (auto _coil = parentCoil()) { | |
| 96 | ✗ | _coil->removeStage(getObject<CoilHeatingGasMultiStageStageData>()); | |
| 97 | ✗ | } | |
| 98 | ✗ | return ModelObject_Impl::remove(); | |
| 99 | } | ||
| 100 | |||
| 101 | 27 | boost::optional<CoilHeatingGasMultiStage> CoilHeatingGasMultiStageStageData_Impl::parentCoil() const { | |
| 102 |
3/3✓ Branch 1 taken 27 times.
✓ Branch 4 taken 27 times.
✓ Branch 7 taken 27 times.
|
27 | auto coils = getObject<ModelObject>().getModelObjectSources<CoilHeatingGasMultiStage>(CoilHeatingGasMultiStage::iddObjectType()); |
| 103 | 27 | auto count = coils.size(); | |
| 104 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 27 times.
|
27 | if (count == 1) { |
| 105 | ✗ | return coils[0]; | |
| 106 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 27 times.
|
27 | } else if (count > 1) { |
| 107 | ✗ | LOG(Error, briefDescription() << " is referenced by more than one CoilHeatingGasMultiStage, returning the first"); | |
| 108 | ✗ | return coils[0]; | |
| 109 | } | ||
| 110 | 27 | return boost::none; | |
| 111 | 27 | } | |
| 112 | |||
| 113 | ✗ | boost::optional<std::tuple<int, CoilHeatingGasMultiStage>> CoilHeatingGasMultiStageStageData_Impl::stageIndexAndParentCoil() const { | |
| 114 | |||
| 115 | ✗ | boost::optional<std::tuple<int, CoilHeatingGasMultiStage>> result; | |
| 116 | |||
| 117 | ✗ | if (auto _coil = parentCoil()) { | |
| 118 | ✗ | result = std::make_tuple(_coil->stageIndex(getObject<CoilHeatingGasMultiStageStageData>()).get(), _coil.get()); | |
| 119 | } else { | ||
| 120 | ✗ | LOG(Warn, name().get() + " was not found inside a CoilHeatingGasMultiStage in the model, cannot retrieve the autosized value."); | |
| 121 | ✗ | } | |
| 122 | |||
| 123 | ✗ | return result; | |
| 124 | ✗ | } | |
| 125 | |||
| 126 | ✗ | boost::optional<double> CoilHeatingGasMultiStageStageData_Impl::autosizedNominalCapacity() const { | |
| 127 | ✗ | auto indexAndNameOpt = stageIndexAndParentCoil(); | |
| 128 | ✗ | boost::optional<double> result; | |
| 129 | ✗ | if (!indexAndNameOpt) { | |
| 130 | ✗ | return result; | |
| 131 | } | ||
| 132 | ✗ | auto [index, parentCoil] = indexAndNameOpt.get(); | |
| 133 | ✗ | const std::string sqlField = "Design Size Stage " + std::to_string(index) + " Nominal Capacity"; | |
| 134 | |||
| 135 | ✗ | return parentCoil.getImpl<CoilHeatingGasMultiStage_Impl>()->getAutosizedValue(sqlField, "W", "Coil:Heating:Gas:MultiStage"); | |
| 136 | ✗ | } | |
| 137 | |||
| 138 | ✗ | void CoilHeatingGasMultiStageStageData_Impl::autosize() { | |
| 139 | ✗ | autosizeNominalCapacity(); | |
| 140 | ✗ | } | |
| 141 | |||
| 142 | ✗ | void CoilHeatingGasMultiStageStageData_Impl::applySizingValues() { | |
| 143 | ✗ | boost::optional<double> val; | |
| 144 | ✗ | val = autosizedNominalCapacity(); | |
| 145 | ✗ | if (val) { | |
| 146 | ✗ | setNominalCapacity(val.get()); | |
| 147 | } | ||
| 148 | ✗ | } | |
| 149 | |||
| 150 | } // namespace detail | ||
| 151 | |||
| 152 | 15 | CoilHeatingGasMultiStageStageData::CoilHeatingGasMultiStageStageData(const Model& model) | |
| 153 | 15 | : ModelObject(CoilHeatingGasMultiStageStageData::iddObjectType(), model) { | |
| 154 |
1/3✗ Branch 2 not taken.
✓ Branch 3 taken 15 times.
✗ Branch 5 not taken.
|
15 | OS_ASSERT(getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()); |
| 155 | |||
| 156 |
1/1✓ Branch 1 taken 15 times.
|
15 | setGasBurnerEfficiency(0.80); |
| 157 |
1/1✓ Branch 1 taken 15 times.
|
15 | autosizeNominalCapacity(); |
| 158 |
1/1✓ Branch 1 taken 15 times.
|
15 | setOnCycleParasiticElectricLoad(0.0); |
| 159 | 15 | } | |
| 160 | |||
| 161 | 7769 | IddObjectType CoilHeatingGasMultiStageStageData::iddObjectType() { | |
| 162 |
1/1✓ Branch 1 taken 7769 times.
|
7769 | return {IddObjectType::OS_Coil_Heating_Gas_MultiStage_StageData}; |
| 163 | } | ||
| 164 | |||
| 165 | 2 | double CoilHeatingGasMultiStageStageData::gasBurnerEfficiency() const { | |
| 166 |
1/1✓ Branch 3 taken 2 times.
|
2 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->gasBurnerEfficiency(); |
| 167 | } | ||
| 168 | |||
| 169 | 4 | boost::optional<double> CoilHeatingGasMultiStageStageData::nominalCapacity() const { | |
| 170 |
1/1✓ Branch 3 taken 4 times.
|
4 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->nominalCapacity(); |
| 171 | } | ||
| 172 | |||
| 173 | 2 | bool CoilHeatingGasMultiStageStageData::isNominalCapacityAutosized() const { | |
| 174 |
1/1✓ Branch 3 taken 2 times.
|
2 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->isNominalCapacityAutosized(); |
| 175 | } | ||
| 176 | |||
| 177 | // DEPRECATED | ||
| 178 | ✗ | double CoilHeatingGasMultiStageStageData::parasiticElectricLoad() const { | |
| 179 | ✗ | DEPRECATED_AT_MSG(3, 7, 0, "Use onCycleParasiticElectricLoad instead."); | |
| 180 | ✗ | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->onCycleParasiticElectricLoad(); | |
| 181 | } | ||
| 182 | |||
| 183 | 2 | double CoilHeatingGasMultiStageStageData::onCycleParasiticElectricLoad() const { | |
| 184 |
1/1✓ Branch 3 taken 2 times.
|
2 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->onCycleParasiticElectricLoad(); |
| 185 | } | ||
| 186 | |||
| 187 | 17 | bool CoilHeatingGasMultiStageStageData::setGasBurnerEfficiency(double gasBurnerEfficiency) { | |
| 188 |
1/1✓ Branch 3 taken 17 times.
|
17 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->setGasBurnerEfficiency(gasBurnerEfficiency); |
| 189 | } | ||
| 190 | |||
| 191 | 2 | bool CoilHeatingGasMultiStageStageData::setNominalCapacity(double nominalCapacity) { | |
| 192 |
1/1✓ Branch 3 taken 2 times.
|
2 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->setNominalCapacity(nominalCapacity); |
| 193 | } | ||
| 194 | |||
| 195 | 15 | void CoilHeatingGasMultiStageStageData::autosizeNominalCapacity() { | |
| 196 |
1/1✓ Branch 3 taken 15 times.
|
15 | getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->autosizeNominalCapacity(); |
| 197 | 15 | } | |
| 198 | |||
| 199 | // DEPRECATED | ||
| 200 | 2 | bool CoilHeatingGasMultiStageStageData::setParasiticElectricLoad(double parasiticElectricLoad) { | |
| 201 |
5/5✓ Branch 1 taken 2 times.
✓ Branch 4 taken 2 times.
✓ Branch 7 taken 2 times.
✓ Branch 10 taken 2 times.
✓ Branch 13 taken 2 times.
|
8 | DEPRECATED_AT_MSG(3, 7, 0, "Use setOnCycleParasiticElectricLoad instead."); |
| 202 |
1/1✓ Branch 3 taken 2 times.
|
2 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->setOnCycleParasiticElectricLoad(parasiticElectricLoad); |
| 203 | } | ||
| 204 | |||
| 205 | 15 | bool CoilHeatingGasMultiStageStageData::setOnCycleParasiticElectricLoad(double onCycleParasiticElectricLoad) { | |
| 206 |
1/1✓ Branch 3 taken 15 times.
|
15 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->setOnCycleParasiticElectricLoad(onCycleParasiticElectricLoad); |
| 207 | } | ||
| 208 | |||
| 209 | /// @cond | ||
| 210 | 100 | CoilHeatingGasMultiStageStageData::CoilHeatingGasMultiStageStageData(std::shared_ptr<detail::CoilHeatingGasMultiStageStageData_Impl> impl) | |
| 211 |
1/1✓ Branch 3 taken 100 times.
|
100 | : ModelObject(std::move(impl)) {} |
| 212 | /// @endcond | ||
| 213 | |||
| 214 | ✗ | boost::optional<double> CoilHeatingGasMultiStageStageData::autosizedNominalCapacity() const { | |
| 215 | ✗ | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->autosizedNominalCapacity(); | |
| 216 | } | ||
| 217 | |||
| 218 | ✗ | void CoilHeatingGasMultiStageStageData::autosize() { | |
| 219 | ✗ | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->autosize(); | |
| 220 | } | ||
| 221 | |||
| 222 | ✗ | void CoilHeatingGasMultiStageStageData::applySizingValues() { | |
| 223 | ✗ | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->applySizingValues(); | |
| 224 | } | ||
| 225 | |||
| 226 | 27 | boost::optional<CoilHeatingGasMultiStage> CoilHeatingGasMultiStageStageData::parentCoil() const { | |
| 227 |
1/1✓ Branch 3 taken 27 times.
|
27 | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->parentCoil(); |
| 228 | } | ||
| 229 | |||
| 230 | ✗ | boost::optional<std::tuple<int, CoilHeatingGasMultiStage>> CoilHeatingGasMultiStageStageData::stageIndexAndParentCoil() const { | |
| 231 | ✗ | return getImpl<detail::CoilHeatingGasMultiStageStageData_Impl>()->stageIndexAndParentCoil(); | |
| 232 | } | ||
| 233 | |||
| 234 | } // namespace model | ||
| 235 | } // namespace openstudio | ||
| 236 |