src/model/PlantComponentTemperatureSource.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 "PlantComponentTemperatureSource.hpp" | ||
| 7 | #include "PlantComponentTemperatureSource_Impl.hpp" | ||
| 8 | |||
| 9 | #include "Schedule.hpp" | ||
| 10 | #include "Schedule_Impl.hpp" | ||
| 11 | #include "ScheduleTypeLimits.hpp" | ||
| 12 | #include "ScheduleTypeRegistry.hpp" | ||
| 13 | |||
| 14 | #include "../utilities/core/Assert.hpp" | ||
| 15 | #include "../utilities/data/DataEnums.hpp" | ||
| 16 | |||
| 17 | #include <utilities/idd/IddFactory.hxx> | ||
| 18 | #include <utilities/idd/IddEnums.hxx> | ||
| 19 | #include <utilities/idd/OS_PlantComponent_TemperatureSource_FieldEnums.hxx> | ||
| 20 | |||
| 21 | namespace openstudio { | ||
| 22 | namespace model { | ||
| 23 | |||
| 24 | namespace detail { | ||
| 25 | |||
| 26 | 1 | PlantComponentTemperatureSource_Impl::PlantComponentTemperatureSource_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle) | |
| 27 | 1 | : StraightComponent_Impl(idfObject, model, keepHandle) { | |
| 28 |
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(idfObject.iddObject().type() == PlantComponentTemperatureSource::iddObjectType()); |
| 29 | 1 | } | |
| 30 | |||
| 31 | ✗ | PlantComponentTemperatureSource_Impl::PlantComponentTemperatureSource_Impl(const openstudio::detail::WorkspaceObject_Impl& other, | |
| 32 | ✗ | Model_Impl* model, bool keepHandle) | |
| 33 | ✗ | : StraightComponent_Impl(other, model, keepHandle) { | |
| 34 | ✗ | OS_ASSERT(other.iddObject().type() == PlantComponentTemperatureSource::iddObjectType()); | |
| 35 | ✗ | } | |
| 36 | |||
| 37 | ✗ | PlantComponentTemperatureSource_Impl::PlantComponentTemperatureSource_Impl(const PlantComponentTemperatureSource_Impl& other, Model_Impl* model, | |
| 38 | ✗ | bool keepHandle) | |
| 39 | ✗ | : StraightComponent_Impl(other, model, keepHandle) {} | |
| 40 | |||
| 41 | ✗ | const std::vector<std::string>& PlantComponentTemperatureSource_Impl::outputVariableNames() const { | |
| 42 | static const std::vector<std::string> result{ | ||
| 43 | "Plant Temperature Source Component Mass Flow Rate", "Plant Temperature Source Component Inlet Temperature", | ||
| 44 | "Plant Temperature Source Component Outlet Temperature", "Plant Temperature Source Component Source Temperature", | ||
| 45 | ✗ | "Plant Temperature Source Component Heat Transfer Rate", "Plant Temperature Source Component Heat Transfer Energy"}; | |
| 46 | ✗ | return result; | |
| 47 | ✗ | } | |
| 48 | |||
| 49 | ✗ | IddObjectType PlantComponentTemperatureSource_Impl::iddObjectType() const { | |
| 50 | ✗ | return PlantComponentTemperatureSource::iddObjectType(); | |
| 51 | } | ||
| 52 | |||
| 53 | ✗ | std::vector<ScheduleTypeKey> PlantComponentTemperatureSource_Impl::getScheduleTypeKeys(const Schedule& schedule) const { | |
| 54 | // TODO: Check schedule display names. | ||
| 55 | ✗ | std::vector<ScheduleTypeKey> result; | |
| 56 | ✗ | UnsignedVector fieldIndices = getSourceIndices(schedule.handle()); | |
| 57 | ✗ | UnsignedVector::const_iterator b(fieldIndices.begin()); | |
| 58 | ✗ | UnsignedVector::const_iterator e(fieldIndices.end()); | |
| 59 | ✗ | if (std::find(b, e, OS_PlantComponent_TemperatureSourceFields::SourceTemperatureScheduleName) != e) { | |
| 60 | ✗ | result.push_back(ScheduleTypeKey("PlantComponentTemperatureSource", "Source Temperature")); | |
| 61 | } | ||
| 62 | ✗ | return result; | |
| 63 | ✗ | } | |
| 64 | |||
| 65 | ✗ | unsigned PlantComponentTemperatureSource_Impl::inletPort() const { | |
| 66 | ✗ | return OS_PlantComponent_TemperatureSourceFields::InletNode; | |
| 67 | } | ||
| 68 | |||
| 69 | ✗ | unsigned PlantComponentTemperatureSource_Impl::outletPort() const { | |
| 70 | ✗ | return OS_PlantComponent_TemperatureSourceFields::OutletNode; | |
| 71 | } | ||
| 72 | |||
| 73 | ✗ | boost::optional<double> PlantComponentTemperatureSource_Impl::designVolumeFlowRate() const { | |
| 74 | ✗ | return getDouble(OS_PlantComponent_TemperatureSourceFields::DesignVolumeFlowRate, true); | |
| 75 | } | ||
| 76 | |||
| 77 | ✗ | bool PlantComponentTemperatureSource_Impl::isDesignVolumeFlowRateAutosized() const { | |
| 78 | ✗ | bool result = false; | |
| 79 | ✗ | boost::optional<std::string> value = getString(OS_PlantComponent_TemperatureSourceFields::DesignVolumeFlowRate, true); | |
| 80 | ✗ | if (value) { | |
| 81 | ✗ | result = openstudio::istringEqual(value.get(), "autosize"); | |
| 82 | } | ||
| 83 | ✗ | return result; | |
| 84 | ✗ | } | |
| 85 | |||
| 86 | ✗ | std::string PlantComponentTemperatureSource_Impl::temperatureSpecificationType() const { | |
| 87 | ✗ | boost::optional<std::string> value = getString(OS_PlantComponent_TemperatureSourceFields::TemperatureSpecificationType, true); | |
| 88 | ✗ | OS_ASSERT(value); | |
| 89 | ✗ | return value.get(); | |
| 90 | ✗ | } | |
| 91 | |||
| 92 | ✗ | boost::optional<double> PlantComponentTemperatureSource_Impl::sourceTemperature() const { | |
| 93 | ✗ | return getDouble(OS_PlantComponent_TemperatureSourceFields::SourceTemperature, true); | |
| 94 | } | ||
| 95 | |||
| 96 | ✗ | boost::optional<Schedule> PlantComponentTemperatureSource_Impl::sourceTemperatureSchedule() const { | |
| 97 | ✗ | return getObject<ModelObject>().getModelObjectTarget<Schedule>(OS_PlantComponent_TemperatureSourceFields::SourceTemperatureScheduleName); | |
| 98 | } | ||
| 99 | |||
| 100 | ✗ | bool PlantComponentTemperatureSource_Impl::setDesignVolumeFlowRate(boost::optional<double> designVolumeFlowRate) { | |
| 101 | ✗ | bool result(false); | |
| 102 | ✗ | if (designVolumeFlowRate) { | |
| 103 | ✗ | result = setDouble(OS_PlantComponent_TemperatureSourceFields::DesignVolumeFlowRate, designVolumeFlowRate.get()); | |
| 104 | } | ||
| 105 | ✗ | return result; | |
| 106 | } | ||
| 107 | |||
| 108 | 1 | void PlantComponentTemperatureSource_Impl::autosizeDesignVolumeFlowRate() { | |
| 109 |
2/2✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
|
2 | bool result = setString(OS_PlantComponent_TemperatureSourceFields::DesignVolumeFlowRate, "autosize"); |
| 110 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 1 time.
|
1 | OS_ASSERT(result); |
| 111 | 1 | } | |
| 112 | |||
| 113 | 1 | bool PlantComponentTemperatureSource_Impl::setTemperatureSpecificationType(const std::string& temperatureSpecificationType) { | |
| 114 | 1 | bool result = setString(OS_PlantComponent_TemperatureSourceFields::TemperatureSpecificationType, temperatureSpecificationType); | |
| 115 | 1 | return result; | |
| 116 | } | ||
| 117 | |||
| 118 | 1 | bool PlantComponentTemperatureSource_Impl::setSourceTemperature(boost::optional<double> sourceTemperature) { | |
| 119 | 1 | bool result(false); | |
| 120 |
1/2✓ Branch 0 taken 1 time.
✗ Branch 1 not taken.
|
1 | if (sourceTemperature) { |
| 121 | 1 | result = setDouble(OS_PlantComponent_TemperatureSourceFields::SourceTemperature, sourceTemperature.get()); | |
| 122 | } else { | ||
| 123 | ✗ | resetSourceTemperature(); | |
| 124 | ✗ | result = true; | |
| 125 | } | ||
| 126 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 1 time.
|
1 | OS_ASSERT(result); |
| 127 | 1 | return result; | |
| 128 | } | ||
| 129 | |||
| 130 | ✗ | void PlantComponentTemperatureSource_Impl::resetSourceTemperature() { | |
| 131 | ✗ | bool result = setString(OS_PlantComponent_TemperatureSourceFields::SourceTemperature, ""); | |
| 132 | ✗ | OS_ASSERT(result); | |
| 133 | ✗ | } | |
| 134 | |||
| 135 | ✗ | bool PlantComponentTemperatureSource_Impl::setSourceTemperatureSchedule(Schedule& schedule) { | |
| 136 | ✗ | bool result = setSchedule(OS_PlantComponent_TemperatureSourceFields::SourceTemperatureScheduleName, "PlantComponentTemperatureSource", | |
| 137 | "Source Temperature", schedule); | ||
| 138 | ✗ | return result; | |
| 139 | } | ||
| 140 | |||
| 141 | ✗ | void PlantComponentTemperatureSource_Impl::resetSourceTemperatureSchedule() { | |
| 142 | ✗ | bool result = setString(OS_PlantComponent_TemperatureSourceFields::SourceTemperatureScheduleName, ""); | |
| 143 | ✗ | OS_ASSERT(result); | |
| 144 | ✗ | } | |
| 145 | |||
| 146 | ✗ | boost::optional<double> PlantComponentTemperatureSource_Impl::autosizedDesignVolumeFlowRate() const { | |
| 147 | ✗ | return getAutosizedValue("Design Size Design Fluid Flow Rate", "m3/s"); | |
| 148 | } | ||
| 149 | |||
| 150 | ✗ | void PlantComponentTemperatureSource_Impl::autosize() { | |
| 151 | ✗ | autosizeDesignVolumeFlowRate(); | |
| 152 | ✗ | } | |
| 153 | |||
| 154 | ✗ | void PlantComponentTemperatureSource_Impl::applySizingValues() { | |
| 155 | ✗ | boost::optional<double> val; | |
| 156 | ✗ | val = autosizedDesignVolumeFlowRate(); | |
| 157 | ✗ | if (val) { | |
| 158 | ✗ | setDesignVolumeFlowRate(val.get()); | |
| 159 | } | ||
| 160 | ✗ | } | |
| 161 | |||
| 162 | ✗ | std::vector<EMSActuatorNames> PlantComponentTemperatureSource_Impl::emsActuatorNames() const { | |
| 163 | ✗ | std::vector<EMSActuatorNames> actuators{{"PlantComponent:TemperatureSource", "Maximum Mass Flow Rate"}}; | |
| 164 | ✗ | return actuators; | |
| 165 | ✗ | } | |
| 166 | |||
| 167 | ✗ | std::vector<std::string> PlantComponentTemperatureSource_Impl::emsInternalVariableNames() const { | |
| 168 | ✗ | std::vector<std::string> types; | |
| 169 | ✗ | return types; | |
| 170 | } | ||
| 171 | |||
| 172 | 1 | ComponentType PlantComponentTemperatureSource_Impl::componentType() const { | |
| 173 |
1/1✓ Branch 1 taken 1 time.
|
1 | return ComponentType::Both; |
| 174 | } | ||
| 175 | |||
| 176 | ✗ | std::vector<FuelType> PlantComponentTemperatureSource_Impl::coolingFuelTypes() const { | |
| 177 | ✗ | return {FuelType::EnergyTransfer}; | |
| 178 | } | ||
| 179 | |||
| 180 | ✗ | std::vector<FuelType> PlantComponentTemperatureSource_Impl::heatingFuelTypes() const { | |
| 181 | ✗ | return {FuelType::EnergyTransfer}; | |
| 182 | } | ||
| 183 | |||
| 184 | ✗ | std::vector<AppGFuelType> PlantComponentTemperatureSource_Impl::appGHeatingFuelTypes() const { | |
| 185 | ✗ | return {AppGFuelType::Other}; | |
| 186 | } | ||
| 187 | |||
| 188 | } // namespace detail | ||
| 189 | |||
| 190 | 1 | PlantComponentTemperatureSource::PlantComponentTemperatureSource(const Model& model) | |
| 191 | 1 | : StraightComponent(PlantComponentTemperatureSource::iddObjectType(), model) { | |
| 192 |
1/3✗ Branch 2 not taken.
✓ Branch 3 taken 1 time.
✗ Branch 5 not taken.
|
1 | OS_ASSERT(getImpl<detail::PlantComponentTemperatureSource_Impl>()); |
| 193 | |||
| 194 | 1 | bool ok = true; | |
| 195 |
1/1✓ Branch 1 taken 1 time.
|
1 | autosizeDesignVolumeFlowRate(); |
| 196 |
2/2✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
|
1 | ok = setTemperatureSpecificationType("Constant"); |
| 197 |
1/3✗ Branch 0 not taken.
✓ Branch 1 taken 1 time.
✗ Branch 3 not taken.
|
1 | OS_ASSERT(ok); |
| 198 |
1/1✓ Branch 1 taken 1 time.
|
1 | setSourceTemperature(8); |
| 199 | 1 | } | |
| 200 | |||
| 201 | 7730 | IddObjectType PlantComponentTemperatureSource::iddObjectType() { | |
| 202 |
1/1✓ Branch 1 taken 7730 times.
|
7730 | return {IddObjectType::OS_PlantComponent_TemperatureSource}; |
| 203 | } | ||
| 204 | |||
| 205 | ✗ | std::vector<std::string> PlantComponentTemperatureSource::temperatureSpecificationTypeValues() { | |
| 206 | ✗ | return getIddKeyNames(IddFactory::instance().getObject(iddObjectType()).get(), | |
| 207 | ✗ | OS_PlantComponent_TemperatureSourceFields::TemperatureSpecificationType); | |
| 208 | } | ||
| 209 | |||
| 210 | ✗ | boost::optional<double> PlantComponentTemperatureSource::designVolumeFlowRate() const { | |
| 211 | ✗ | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->designVolumeFlowRate(); | |
| 212 | } | ||
| 213 | |||
| 214 | ✗ | bool PlantComponentTemperatureSource::isDesignVolumeFlowRateAutosized() const { | |
| 215 | ✗ | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->isDesignVolumeFlowRateAutosized(); | |
| 216 | } | ||
| 217 | |||
| 218 | ✗ | std::string PlantComponentTemperatureSource::temperatureSpecificationType() const { | |
| 219 | ✗ | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->temperatureSpecificationType(); | |
| 220 | } | ||
| 221 | |||
| 222 | ✗ | boost::optional<double> PlantComponentTemperatureSource::sourceTemperature() const { | |
| 223 | ✗ | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->sourceTemperature(); | |
| 224 | } | ||
| 225 | |||
| 226 | ✗ | boost::optional<Schedule> PlantComponentTemperatureSource::sourceTemperatureSchedule() const { | |
| 227 | ✗ | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->sourceTemperatureSchedule(); | |
| 228 | } | ||
| 229 | |||
| 230 | ✗ | bool PlantComponentTemperatureSource::setDesignVolumeFlowRate(double designVolumeFlowRate) { | |
| 231 | ✗ | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->setDesignVolumeFlowRate(designVolumeFlowRate); | |
| 232 | } | ||
| 233 | |||
| 234 | 1 | void PlantComponentTemperatureSource::autosizeDesignVolumeFlowRate() { | |
| 235 |
1/1✓ Branch 3 taken 1 time.
|
1 | getImpl<detail::PlantComponentTemperatureSource_Impl>()->autosizeDesignVolumeFlowRate(); |
| 236 | 1 | } | |
| 237 | |||
| 238 | 1 | bool PlantComponentTemperatureSource::setTemperatureSpecificationType(const std::string& temperatureSpecificationType) { | |
| 239 |
1/1✓ Branch 3 taken 1 time.
|
1 | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->setTemperatureSpecificationType(temperatureSpecificationType); |
| 240 | } | ||
| 241 | |||
| 242 | 1 | bool PlantComponentTemperatureSource::setSourceTemperature(double sourceTemperature) { | |
| 243 |
2/2✓ Branch 3 taken 1 time.
✓ Branch 6 taken 1 time.
|
1 | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->setSourceTemperature(sourceTemperature); |
| 244 | } | ||
| 245 | |||
| 246 | ✗ | void PlantComponentTemperatureSource::resetSourceTemperature() { | |
| 247 | ✗ | getImpl<detail::PlantComponentTemperatureSource_Impl>()->resetSourceTemperature(); | |
| 248 | ✗ | } | |
| 249 | |||
| 250 | ✗ | bool PlantComponentTemperatureSource::setSourceTemperatureSchedule(Schedule& schedule) { | |
| 251 | ✗ | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->setSourceTemperatureSchedule(schedule); | |
| 252 | } | ||
| 253 | |||
| 254 | ✗ | void PlantComponentTemperatureSource::resetSourceTemperatureSchedule() { | |
| 255 | ✗ | getImpl<detail::PlantComponentTemperatureSource_Impl>()->resetSourceTemperatureSchedule(); | |
| 256 | ✗ | } | |
| 257 | |||
| 258 | /// @cond | ||
| 259 | ✗ | PlantComponentTemperatureSource::PlantComponentTemperatureSource(std::shared_ptr<detail::PlantComponentTemperatureSource_Impl> impl) | |
| 260 | ✗ | : StraightComponent(std::move(impl)) {} | |
| 261 | /// @endcond | ||
| 262 | |||
| 263 | ✗ | boost::optional<double> PlantComponentTemperatureSource::autosizedDesignVolumeFlowRate() const { | |
| 264 | ✗ | return getImpl<detail::PlantComponentTemperatureSource_Impl>()->autosizedDesignVolumeFlowRate(); | |
| 265 | } | ||
| 266 | |||
| 267 | } // namespace model | ||
| 268 | } // namespace openstudio | ||
| 269 |