src/model/AirflowNetworkDuct.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_AIRFLOWNETWORKDUCT_HPP | ||
| 7 | #define MODEL_AIRFLOWNETWORKDUCT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "AirflowNetworkComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class AirflowNetworkDuct_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** AirflowNetworkDuct is a ModelObject that wraps the OpenStudio IDD object 'OS:AirflowNetwork:Duct'. */ | ||
| 23 | class MODEL_API AirflowNetworkDuct : public AirflowNetworkComponent | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | explicit AirflowNetworkDuct(const Model& model); | ||
| 30 | |||
| 31 | 1 | virtual ~AirflowNetworkDuct() override = default; | |
| 32 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 33 | ✗ | AirflowNetworkDuct(const AirflowNetworkDuct& other) = default; | |
| 34 | ✗ | AirflowNetworkDuct(AirflowNetworkDuct&& other) = default; | |
| 35 | ✗ | AirflowNetworkDuct& operator=(const AirflowNetworkDuct&) = default; | |
| 36 | ✗ | AirflowNetworkDuct& operator=(AirflowNetworkDuct&&) = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | /** @name Getters */ | ||
| 43 | //@{ | ||
| 44 | |||
| 45 | double ductLength() const; | ||
| 46 | |||
| 47 | double hydraulicDiameter() const; | ||
| 48 | |||
| 49 | double crossSectionArea() const; | ||
| 50 | |||
| 51 | double surfaceRoughness() const; | ||
| 52 | |||
| 53 | bool isSurfaceRoughnessDefaulted() const; | ||
| 54 | |||
| 55 | double coefficientforLocalDynamicLossDuetoFitting() const; | ||
| 56 | |||
| 57 | bool isCoefficientforLocalDynamicLossDuetoFittingDefaulted() const; | ||
| 58 | |||
| 59 | double ductWallHeatTransmittanceCoefficient() const; | ||
| 60 | |||
| 61 | bool isDuctWallHeatTransmittanceCoefficientDefaulted() const; | ||
| 62 | |||
| 63 | double insideConvectionCoefficient() const; | ||
| 64 | |||
| 65 | bool isInsideConvectionCoefficientDefaulted() const; | ||
| 66 | |||
| 67 | double outsideConvectionCoefficient() const; | ||
| 68 | |||
| 69 | bool isOutsideConvectionCoefficientDefaulted() const; | ||
| 70 | |||
| 71 | double overallMoistureTransmittanceCoefficientfromAirtoAir() const; | ||
| 72 | |||
| 73 | bool isOverallMoistureTransmittanceCoefficientfromAirtoAirDefaulted() const; | ||
| 74 | |||
| 75 | //@} | ||
| 76 | /** @name Setters */ | ||
| 77 | //@{ | ||
| 78 | |||
| 79 | bool setDuctLength(double ductLength); | ||
| 80 | |||
| 81 | bool setHydraulicDiameter(double hydraulicDiameter); | ||
| 82 | |||
| 83 | bool setCrossSectionArea(double crossSectionArea); | ||
| 84 | |||
| 85 | bool setSurfaceRoughness(double surfaceRoughness); | ||
| 86 | |||
| 87 | void resetSurfaceRoughness(); | ||
| 88 | |||
| 89 | bool setCoefficientforLocalDynamicLossDuetoFitting(double coefficientforLocalDynamicLossDuetoFitting); | ||
| 90 | |||
| 91 | void resetCoefficientforLocalDynamicLossDuetoFitting(); | ||
| 92 | |||
| 93 | bool setDuctWallHeatTransmittanceCoefficient(double coefficient); | ||
| 94 | |||
| 95 | void resetDuctWallHeatTransmittanceCoefficient(); | ||
| 96 | |||
| 97 | bool setInsideConvectionCoefficient(double coefficient); | ||
| 98 | |||
| 99 | void resetInsideConvectionCoefficient(); | ||
| 100 | |||
| 101 | bool setOutsideConvectionCoefficient(double coefficient); | ||
| 102 | |||
| 103 | void resetOutsideConvectionCoefficient(); | ||
| 104 | |||
| 105 | bool setOverallMoistureTransmittanceCoefficientfromAirtoAir(double overallMoistureTransmittanceCoefficientfromAirtoAir); | ||
| 106 | |||
| 107 | void resetOverallMoistureTransmittanceCoefficientfromAirtoAir(); | ||
| 108 | |||
| 109 | //@} | ||
| 110 | /** @name Other */ | ||
| 111 | //@{ | ||
| 112 | |||
| 113 | //@} | ||
| 114 | protected: | ||
| 115 | /// @cond | ||
| 116 | using ImplType = detail::AirflowNetworkDuct_Impl; | ||
| 117 | |||
| 118 | explicit AirflowNetworkDuct(std::shared_ptr<detail::AirflowNetworkDuct_Impl> impl); | ||
| 119 | |||
| 120 | friend class detail::AirflowNetworkDuct_Impl; | ||
| 121 | friend class Model; | ||
| 122 | friend class IdfObject; | ||
| 123 | friend class openstudio::detail::IdfObject_Impl; | ||
| 124 | /// @endcond | ||
| 125 | private: | ||
| 126 | REGISTER_LOGGER("openstudio.model.AirflowNetworkDuct"); | ||
| 127 | }; | ||
| 128 | |||
| 129 | /** \relates AirflowNetworkDuct*/ | ||
| 130 | using OptionalAirflowNetworkDuct = boost::optional<AirflowNetworkDuct>; | ||
| 131 | |||
| 132 | /** \relates AirflowNetworkDuct*/ | ||
| 133 | using AirflowNetworkDuctVector = std::vector<AirflowNetworkDuct>; | ||
| 134 | |||
| 135 | } // namespace model | ||
| 136 | } // namespace openstudio | ||
| 137 | |||
| 138 | #endif // MODEL_AIRFLOWNETWORKDUCT_HPP | ||
| 139 |