src/model/WaterUseEquipment.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 "WaterUseEquipment.hpp" | ||
| 7 | #include "WaterUseEquipment_Impl.hpp" | ||
| 8 | #include "WaterUseEquipmentDefinition.hpp" | ||
| 9 | #include "WaterUseEquipmentDefinition_Impl.hpp" | ||
| 10 | #include "Model.hpp" | ||
| 11 | #include "Model_Impl.hpp" | ||
| 12 | #include "WaterUseConnections.hpp" | ||
| 13 | #include "WaterUseConnections_Impl.hpp" | ||
| 14 | #include "Schedule.hpp" | ||
| 15 | #include "Schedule_Impl.hpp" | ||
| 16 | #include "ThermalZone.hpp" | ||
| 17 | #include "ThermalZone_Impl.hpp" | ||
| 18 | #include <utilities/idd/OS_WaterUse_Equipment_FieldEnums.hxx> | ||
| 19 | #include <utilities/idd/IddEnums.hxx> | ||
| 20 | #include "../utilities/units/Unit.hpp" | ||
| 21 | #include "../utilities/core/Assert.hpp" | ||
| 22 | |||
| 23 | namespace openstudio { | ||
| 24 | |||
| 25 | namespace model { | ||
| 26 | |||
| 27 | namespace detail { | ||
| 28 | |||
| 29 | 54 | WaterUseEquipment_Impl::WaterUseEquipment_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle) | |
| 30 | 54 | : SpaceLoadInstance_Impl(idfObject, model, keepHandle) { | |
| 31 |
4/6✓ Branch 1 taken 54 times.
✓ Branch 4 taken 54 times.
✓ Branch 7 taken 54 times.
✗ Branch 10 not taken.
✓ Branch 11 taken 54 times.
✗ Branch 13 not taken.
|
54 | OS_ASSERT(idfObject.iddObject().type() == WaterUseEquipment::iddObjectType()); |
| 32 | 54 | } | |
| 33 | |||
| 34 | 23 | WaterUseEquipment_Impl::WaterUseEquipment_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle) | |
| 35 | 23 | : SpaceLoadInstance_Impl(other, model, keepHandle) { | |
| 36 |
4/6✓ Branch 1 taken 23 times.
✓ Branch 4 taken 23 times.
✓ Branch 7 taken 23 times.
✗ Branch 10 not taken.
✓ Branch 11 taken 23 times.
✗ Branch 13 not taken.
|
23 | OS_ASSERT(other.iddObject().type() == WaterUseEquipment::iddObjectType()); |
| 37 | 23 | } | |
| 38 | |||
| 39 | 92 | WaterUseEquipment_Impl::WaterUseEquipment_Impl(const WaterUseEquipment_Impl& other, Model_Impl* model, bool keepHandle) | |
| 40 | 92 | : SpaceLoadInstance_Impl(other, model, keepHandle) {} | |
| 41 | |||
| 42 | ✗ | const std::vector<std::string>& WaterUseEquipment_Impl::outputVariableNames() const { | |
| 43 | static const std::vector<std::string> result{ | ||
| 44 | "Water Use Equipment Hot Water Mass Flow Rate", "Water Use Equipment Cold Water Mass Flow Rate", "Water Use Equipment Total Mass Flow Rate", | ||
| 45 | "Water Use Equipment Hot Water Volume Flow Rate", "Water Use Equipment Cold Water Volume Flow Rate", | ||
| 46 | "Water Use Equipment Total Volume Flow Rate", "Water Use Equipment Hot Water Volume", "Water Use Equipment Cold Water Volume", | ||
| 47 | "Water Use Equipment Total Volume", "Water Use Equipment Mains Water Volume", "Water Use Equipment Hot Water Temperature", | ||
| 48 | "Water Use Equipment Cold Water Temperature", "Water Use Equipment Target Water Temperature", "Water Use Equipment Mixed Water Temperature", | ||
| 49 | "Water Use Equipment Drain Water Temperature", "Water Use Equipment Heating Rate", "Water Use Equipment Heating Energy", | ||
| 50 | |||
| 51 | // The Key is the name of the Water Use Equipment, not the zone, | ||
| 52 | // so it's appropriate to report it here rather than the ThermalZone | ||
| 53 | // cf EnergyPlus/WaterUse.cc | ||
| 54 | "Water Use Equipment Zone Sensible Heat Gain Rate", "Water Use Equipment Zone Sensible Heat Gain Energy", | ||
| 55 | "Water Use Equipment Zone Latent Gain Rate", "Water Use Equipment Zone Latent Gain Energy", | ||
| 56 | "Water Use Equipment Zone Moisture Gain Mass Flow Rate", "Water Use Equipment Zone Moisture Gain Mass" | ||
| 57 | |||
| 58 | ✗ | }; | |
| 59 | ✗ | return result; | |
| 60 | ✗ | } | |
| 61 | |||
| 62 | ✗ | IddObjectType WaterUseEquipment_Impl::iddObjectType() const { | |
| 63 | ✗ | return WaterUseEquipment::iddObjectType(); | |
| 64 | } | ||
| 65 | |||
| 66 | ✗ | std::vector<ScheduleTypeKey> WaterUseEquipment_Impl::getScheduleTypeKeys(const Schedule& schedule) const { | |
| 67 | ✗ | std::vector<ScheduleTypeKey> result; | |
| 68 | ✗ | UnsignedVector fieldIndices = getSourceIndices(schedule.handle()); | |
| 69 | ✗ | UnsignedVector::const_iterator b(fieldIndices.begin()); | |
| 70 | ✗ | UnsignedVector::const_iterator e(fieldIndices.end()); | |
| 71 | ✗ | if (std::find(b, e, OS_WaterUse_EquipmentFields::FlowRateFractionScheduleName) != e) { | |
| 72 | ✗ | result.push_back(ScheduleTypeKey("WaterUseEquipment", "Flow Rate Fraction")); | |
| 73 | } | ||
| 74 | ✗ | return result; | |
| 75 | ✗ | } | |
| 76 | |||
| 77 | 22 | boost::optional<Schedule> WaterUseEquipment_Impl::flowRateFractionSchedule() const { | |
| 78 |
2/2✓ Branch 1 taken 22 times.
✓ Branch 4 taken 22 times.
|
22 | return getObject<ModelObject>().getModelObjectTarget<Schedule>(OS_WaterUse_EquipmentFields::FlowRateFractionScheduleName); |
| 79 | } | ||
| 80 | |||
| 81 | 52 | bool WaterUseEquipment_Impl::setFlowRateFractionSchedule(Schedule& schedule) { | |
| 82 |
3/3✓ Branch 1 taken 52 times.
✓ Branch 4 taken 52 times.
✓ Branch 7 taken 52 times.
|
208 | bool result = setSchedule(OS_WaterUse_EquipmentFields::FlowRateFractionScheduleName, "WaterUseEquipment", "Flow Rate Fraction", schedule); |
| 83 | 52 | return result; | |
| 84 | } | ||
| 85 | |||
| 86 | ✗ | void WaterUseEquipment_Impl::resetFlowRateFractionSchedule() { | |
| 87 | ✗ | bool result = setString(OS_WaterUse_EquipmentFields::FlowRateFractionScheduleName, ""); | |
| 88 | ✗ | OS_ASSERT(result); | |
| 89 | ✗ | } | |
| 90 | |||
| 91 | ✗ | boost::optional<ModelObject> WaterUseEquipment_Impl::flowRateFractionScheduleAsModelObject() const { | |
| 92 | ✗ | OptionalModelObject result; | |
| 93 | ✗ | OptionalSchedule intermediate = flowRateFractionSchedule(); | |
| 94 | ✗ | if (intermediate) { | |
| 95 | ✗ | result = *intermediate; | |
| 96 | } | ||
| 97 | ✗ | return result; | |
| 98 | ✗ | } | |
| 99 | |||
| 100 | ✗ | bool WaterUseEquipment_Impl::setFlowRateFractionScheduleAsModelObject(const boost::optional<ModelObject>& modelObject) { | |
| 101 | ✗ | if (modelObject) { | |
| 102 | ✗ | OptionalSchedule intermediate = modelObject->optionalCast<Schedule>(); | |
| 103 | ✗ | if (intermediate) { | |
| 104 | ✗ | return setFlowRateFractionSchedule(*intermediate); | |
| 105 | } else { | ||
| 106 | ✗ | return false; | |
| 107 | } | ||
| 108 | ✗ | } else { | |
| 109 | ✗ | resetFlowRateFractionSchedule(); | |
| 110 | } | ||
| 111 | ✗ | return true; | |
| 112 | } | ||
| 113 | |||
| 114 | ✗ | boost::optional<WaterUseConnections> WaterUseEquipment_Impl::waterUseConnections() const { | |
| 115 | ✗ | std::vector<WaterUseConnections> connections = model().getConcreteModelObjects<WaterUseConnections>(); | |
| 116 | |||
| 117 | ✗ | for (const auto& connection : connections) { | |
| 118 | ✗ | std::vector<WaterUseEquipment> equipment = connection.waterUseEquipment(); | |
| 119 | |||
| 120 | ✗ | for (const auto& elem : equipment) { | |
| 121 | ✗ | if (elem.handle() == handle()) { | |
| 122 | ✗ | return connection; | |
| 123 | } | ||
| 124 | } | ||
| 125 | ✗ | } | |
| 126 | |||
| 127 | ✗ | return boost::none; | |
| 128 | ✗ | } | |
| 129 | |||
| 130 | ✗ | std::vector<IdfObject> WaterUseEquipment_Impl::remove() { | |
| 131 | ✗ | if (boost::optional<WaterUseConnections> c = waterUseConnections()) { | |
| 132 | ✗ | auto e = getObject<WaterUseEquipment>(); | |
| 133 | |||
| 134 | ✗ | c->removeWaterUseEquipment(e); | |
| 135 | ✗ | } | |
| 136 | |||
| 137 | ✗ | return ModelObject_Impl::remove(); | |
| 138 | } | ||
| 139 | |||
| 140 | 22 | WaterUseEquipmentDefinition WaterUseEquipment_Impl::waterUseEquipmentDefinition() const { | |
| 141 |
2/2✓ Branch 1 taken 22 times.
✓ Branch 4 taken 22 times.
|
22 | return definition().cast<WaterUseEquipmentDefinition>(); |
| 142 | } | ||
| 143 | |||
| 144 | ✗ | bool WaterUseEquipment_Impl::setWaterUseEquipmentDefinition(const WaterUseEquipmentDefinition& definition) { | |
| 145 | ✗ | return setPointer(OS_WaterUse_EquipmentFields::WaterUseEquipmentDefinitionName, definition.handle()); | |
| 146 | } | ||
| 147 | |||
| 148 | 25 | int WaterUseEquipment_Impl::spaceIndex() const { | |
| 149 | 25 | return OS_WaterUse_EquipmentFields::SpaceName; | |
| 150 | } | ||
| 151 | |||
| 152 | 53 | int WaterUseEquipment_Impl::definitionIndex() const { | |
| 153 | 53 | return OS_WaterUse_EquipmentFields::WaterUseEquipmentDefinitionName; | |
| 154 | } | ||
| 155 | |||
| 156 | ✗ | bool WaterUseEquipment_Impl::setDefinition(const SpaceLoadDefinition& definition) { | |
| 157 | ✗ | bool result = false; | |
| 158 | ✗ | boost::optional<WaterUseEquipmentDefinition> waterUseEquipmentDefinition = definition.optionalCast<WaterUseEquipmentDefinition>(); | |
| 159 | ✗ | if (waterUseEquipmentDefinition) { | |
| 160 | ✗ | result = setWaterUseEquipmentDefinition(*waterUseEquipmentDefinition); | |
| 161 | } | ||
| 162 | ✗ | return result; | |
| 163 | ✗ | } | |
| 164 | |||
| 165 | ✗ | bool WaterUseEquipment_Impl::hardSize() { | |
| 166 | ✗ | return false; | |
| 167 | } | ||
| 168 | |||
| 169 | ✗ | bool WaterUseEquipment_Impl::hardApplySchedules() { | |
| 170 | ✗ | return false; | |
| 171 | } | ||
| 172 | |||
| 173 | ✗ | double WaterUseEquipment_Impl::multiplier() const { | |
| 174 | ✗ | return 1; | |
| 175 | } | ||
| 176 | |||
| 177 | ✗ | bool WaterUseEquipment_Impl::isMultiplierDefaulted() const { | |
| 178 | ✗ | return true; | |
| 179 | } | ||
| 180 | |||
| 181 | ✗ | bool WaterUseEquipment_Impl::isAbsolute() const { | |
| 182 | ✗ | return true; | |
| 183 | } | ||
| 184 | |||
| 185 | } // namespace detail | ||
| 186 | |||
| 187 | 31 | WaterUseEquipment::WaterUseEquipment(const WaterUseEquipmentDefinition& waterUseEquipmentDefinition) | |
| 188 | 31 | : SpaceLoadInstance(WaterUseEquipment::iddObjectType(), waterUseEquipmentDefinition) { | |
| 189 |
1/3✗ Branch 2 not taken.
✓ Branch 3 taken 31 times.
✗ Branch 5 not taken.
|
31 | OS_ASSERT(getImpl<detail::WaterUseEquipment_Impl>()); |
| 190 | |||
| 191 |
2/2✓ Branch 1 taken 31 times.
✓ Branch 4 taken 31 times.
|
31 | Schedule sch = this->model().alwaysOnDiscreteSchedule(); |
| 192 |
1/1✓ Branch 1 taken 31 times.
|
31 | bool test = this->setFlowRateFractionSchedule(sch); |
| 193 |
1/3✗ Branch 0 not taken.
✓ Branch 1 taken 31 times.
✗ Branch 3 not taken.
|
31 | OS_ASSERT(test); |
| 194 | 31 | } | |
| 195 | |||
| 196 | 9435 | IddObjectType WaterUseEquipment::iddObjectType() { | |
| 197 |
1/1✓ Branch 1 taken 9435 times.
|
9435 | return {IddObjectType::OS_WaterUse_Equipment}; |
| 198 | } | ||
| 199 | |||
| 200 | 22 | boost::optional<Schedule> WaterUseEquipment::flowRateFractionSchedule() const { | |
| 201 |
1/1✓ Branch 3 taken 22 times.
|
22 | return getImpl<detail::WaterUseEquipment_Impl>()->flowRateFractionSchedule(); |
| 202 | } | ||
| 203 | |||
| 204 | 52 | bool WaterUseEquipment::setFlowRateFractionSchedule(Schedule& flowRateFractionSchedule) { | |
| 205 |
1/1✓ Branch 3 taken 52 times.
|
52 | return getImpl<detail::WaterUseEquipment_Impl>()->setFlowRateFractionSchedule(flowRateFractionSchedule); |
| 206 | } | ||
| 207 | |||
| 208 | ✗ | void WaterUseEquipment::resetFlowRateFractionSchedule() { | |
| 209 | ✗ | getImpl<detail::WaterUseEquipment_Impl>()->resetFlowRateFractionSchedule(); | |
| 210 | ✗ | } | |
| 211 | |||
| 212 | ✗ | boost::optional<WaterUseConnections> WaterUseEquipment::waterUseConnections() const { | |
| 213 | ✗ | return getImpl<detail::WaterUseEquipment_Impl>()->waterUseConnections(); | |
| 214 | } | ||
| 215 | |||
| 216 | 22 | WaterUseEquipmentDefinition WaterUseEquipment::waterUseEquipmentDefinition() const { | |
| 217 |
1/1✓ Branch 3 taken 22 times.
|
22 | return getImpl<detail::WaterUseEquipment_Impl>()->waterUseEquipmentDefinition(); |
| 218 | } | ||
| 219 | |||
| 220 | ✗ | bool WaterUseEquipment::setWaterUseEquipmentDefinition(const WaterUseEquipmentDefinition& definition) { | |
| 221 | ✗ | return getImpl<detail::WaterUseEquipment_Impl>()->setWaterUseEquipmentDefinition(definition); | |
| 222 | } | ||
| 223 | |||
| 224 | /// @cond | ||
| 225 |
1/1✓ Branch 3 taken 100 times.
|
100 | WaterUseEquipment::WaterUseEquipment(std::shared_ptr<detail::WaterUseEquipment_Impl> impl) : SpaceLoadInstance(std::move(impl)) {} |
| 226 | /// @endcond | ||
| 227 | |||
| 228 | } // namespace model | ||
| 229 | } // namespace openstudio | ||
| 230 |