src/model/MasslessOpaqueMaterial_Impl.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_MASSLESSOPAQUEMATERIAL_IMPL_HPP | ||
| 7 | #define MODEL_MASSLESSOPAQUEMATERIAL_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "OpaqueMaterial_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | namespace detail { | ||
| 16 | |||
| 17 | /** MasslessOpaqueMaterial_Impl is a OpaqueMaterial_Impl that is the implementation class for MasslessOpaqueMaterial.*/ | ||
| 18 | class MODEL_API MasslessOpaqueMaterial_Impl : public OpaqueMaterial_Impl | ||
| 19 | { | ||
| 20 | |||
| 21 | public: | ||
| 22 | /** @name Constructors and Destructors */ | ||
| 23 | //@{ | ||
| 24 | |||
| 25 | MasslessOpaqueMaterial_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 26 | |||
| 27 | MasslessOpaqueMaterial_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | MasslessOpaqueMaterial_Impl(const MasslessOpaqueMaterial_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | 503 | virtual ~MasslessOpaqueMaterial_Impl() override = default; | |
| 32 | |||
| 33 | //@} | ||
| 34 | |||
| 35 | /** @name Virtual Methods */ | ||
| 36 | //@{ | ||
| 37 | |||
| 38 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 39 | |||
| 40 | virtual IddObjectType iddObjectType() const override; | ||
| 41 | |||
| 42 | //@} | ||
| 43 | /** @name Getters */ | ||
| 44 | //@{ | ||
| 45 | |||
| 46 | // return any children objects in the hierarchy | ||
| 47 | virtual std::vector<ModelObject> children() const override; | ||
| 48 | |||
| 49 | std::string roughness() const; | ||
| 50 | |||
| 51 | /** The conductivity of the material in W/m*K. */ | ||
| 52 | virtual double thermalConductivity() const override; | ||
| 53 | |||
| 54 | /** The conductance of the material in W/m^2*K. */ | ||
| 55 | virtual double thermalConductance() const override; | ||
| 56 | |||
| 57 | /** The resistivity of the material in m*K/W. */ | ||
| 58 | virtual double thermalResistivity() const override; | ||
| 59 | |||
| 60 | /** The resistance of the material in m^2*K/W. */ | ||
| 61 | virtual double thermalResistance() const override; | ||
| 62 | |||
| 63 | virtual double thermalAbsorptance() const override; | ||
| 64 | |||
| 65 | virtual boost::optional<double> thermalReflectance() const override; | ||
| 66 | |||
| 67 | virtual double solarAbsorptance() const override; | ||
| 68 | |||
| 69 | virtual boost::optional<double> solarReflectance() const override; | ||
| 70 | |||
| 71 | virtual double visibleAbsorptance() const override; | ||
| 72 | |||
| 73 | virtual boost::optional<double> visibleReflectance() const override; | ||
| 74 | |||
| 75 | bool isThermalAbsorptanceDefaulted() const; | ||
| 76 | |||
| 77 | bool isSolarAbsorptanceDefaulted() const; | ||
| 78 | |||
| 79 | bool isVisibleAbsorptanceDefaulted() const; | ||
| 80 | |||
| 81 | double thermalAbsorptanceInsideFace() const; | ||
| 82 | |||
| 83 | bool isThermalAbsorptanceInsideFaceDefaulted() const; | ||
| 84 | |||
| 85 | double solarAbsorptanceInsideFace() const; | ||
| 86 | |||
| 87 | bool isSolarAbsorptanceInsideFaceDefaulted() const; | ||
| 88 | |||
| 89 | double visibleAbsorptanceInsideFace() const; | ||
| 90 | |||
| 91 | bool isVisibleAbsorptanceInsideFaceDefaulted() const; | ||
| 92 | |||
| 93 | //@} | ||
| 94 | /** @name Setters */ | ||
| 95 | //@{ | ||
| 96 | |||
| 97 | bool setRoughness(const std::string& roughness); | ||
| 98 | |||
| 99 | /** Set thickness to value (m). */ | ||
| 100 | virtual bool setThickness(double value) override; | ||
| 101 | |||
| 102 | /** Sets the conductivity of the material in W/m*K, if possible. */ | ||
| 103 | virtual bool setThermalConductivity(double value) override; | ||
| 104 | |||
| 105 | /** Sets the conductance of the material in W/m^2*K, if possible. */ | ||
| 106 | virtual bool setThermalConductance(double value) override; | ||
| 107 | |||
| 108 | /** Sets the resistivity of the material in m*K/W, if possible. */ | ||
| 109 | virtual bool setThermalResistivity(double value) override; | ||
| 110 | |||
| 111 | /** Sets the resistance of the material in m^2*K/W, if possible. */ | ||
| 112 | virtual bool setThermalResistance(double thermalResistance) override; | ||
| 113 | |||
| 114 | virtual bool setThermalAbsorptance(boost::optional<double> value); | ||
| 115 | |||
| 116 | virtual bool setThermalReflectance(boost::optional<double> value) override; | ||
| 117 | |||
| 118 | virtual bool setSolarAbsorptance(boost::optional<double> value) override; | ||
| 119 | |||
| 120 | virtual bool setSolarReflectance(boost::optional<double> value) override; | ||
| 121 | |||
| 122 | virtual bool setVisibleAbsorptance(boost::optional<double> value) override; | ||
| 123 | |||
| 124 | virtual bool setVisibleReflectance(boost::optional<double> value) override; | ||
| 125 | |||
| 126 | bool setThermalAbsorptance(double thermalAbsorptance) override; | ||
| 127 | |||
| 128 | void resetThermalAbsorptance(); | ||
| 129 | |||
| 130 | bool setSolarAbsorptance(double solarAbsorptance); | ||
| 131 | |||
| 132 | void resetSolarAbsorptance(); | ||
| 133 | |||
| 134 | bool setVisibleAbsorptance(double visibleAbsorptance); | ||
| 135 | |||
| 136 | void resetVisibleAbsorptance(); | ||
| 137 | |||
| 138 | bool setThermalAbsorptanceInsideFace(double thermalAbsorptanceInsideFace); | ||
| 139 | |||
| 140 | void resetThermalAbsorptanceInsideFace(); | ||
| 141 | |||
| 142 | bool setSolarAbsorptanceInsideFace(double solarAbsorptanceInsideFace); | ||
| 143 | |||
| 144 | void resetSolarAbsorptanceInsideFace(); | ||
| 145 | |||
| 146 | bool setVisibleAbsorptanceInsideFace(double visibleAbsorptanceInsideFace); | ||
| 147 | |||
| 148 | void resetVisibleAbsorptanceInsideFace(); | ||
| 149 | |||
| 150 | // if material property moisture penetration depth settings already exists, do nothing and return nil; creates the material property moisture penetration depth settings if it does not already exist and return it; | ||
| 151 | boost::optional<MaterialPropertyMoisturePenetrationDepthSettings> | ||
| 152 | createMaterialPropertyMoisturePenetrationDepthSettings(double waterVaporDiffusionResistanceFactor, double moistureEquationCoefficientA, | ||
| 153 | double moistureEquationCoefficientB, double moistureEquationCoefficientC, | ||
| 154 | double moistureEquationCoefficientD, double coatingLayerThickness, | ||
| 155 | double coatingLayerWaterVaporDiffusionResistanceFactor); | ||
| 156 | |||
| 157 | // returns the material property moisture penetration depth settings if set | ||
| 158 | boost::optional<MaterialPropertyMoisturePenetrationDepthSettings> materialPropertyMoisturePenetrationDepthSettings() const; | ||
| 159 | |||
| 160 | // resets the material property moisture penetration depth settings | ||
| 161 | void resetMaterialPropertyMoisturePenetrationDepthSettings(); | ||
| 162 | |||
| 163 | // if material property phase change already exists, do nothing and return nil; creates the material property phase change if it does not already exist and return it; | ||
| 164 | boost::optional<MaterialPropertyPhaseChange> createMaterialPropertyPhaseChange(); | ||
| 165 | boost::optional<MaterialPropertyPhaseChange> createMaterialPropertyPhaseChange(const std::vector<TemperatureEnthalpy>& temperatureEnthalpys); | ||
| 166 | |||
| 167 | // returns the material property phase change if set | ||
| 168 | boost::optional<MaterialPropertyPhaseChange> materialPropertyPhaseChange() const; | ||
| 169 | |||
| 170 | // resets the material property phase change | ||
| 171 | void resetMaterialPropertyPhaseChange(); | ||
| 172 | |||
| 173 | // if material property phase change hysteresis already exists, do nothing and return nil; creates the material property phase change hysteresis if it does not already exist and return it | ||
| 174 | boost::optional<MaterialPropertyPhaseChangeHysteresis> createMaterialPropertyPhaseChangeHysteresis(); | ||
| 175 | |||
| 176 | // returns the material property phase change hysteresis if set | ||
| 177 | boost::optional<MaterialPropertyPhaseChangeHysteresis> materialPropertyPhaseChangeHysteresis() const; | ||
| 178 | |||
| 179 | // resets the material property phase change hysteresis | ||
| 180 | void resetMaterialPropertyPhaseChangeHysteresis(); | ||
| 181 | |||
| 182 | //@} | ||
| 183 | /** @name Other */ | ||
| 184 | //@{ | ||
| 185 | |||
| 186 | //@} | ||
| 187 | protected: | ||
| 188 | private: | ||
| 189 | − | REGISTER_LOGGER("openstudio.model.MasslessOpaqueMaterial"); | |
| 190 | |||
| 191 | std::vector<std::string> roughnessValues() const; | ||
| 192 | }; | ||
| 193 | |||
| 194 | } // namespace detail | ||
| 195 | |||
| 196 | } // namespace model | ||
| 197 | } // namespace openstudio | ||
| 198 | |||
| 199 | #endif // MODEL_MASSLESSOPAQUEMATERIAL_IMPL_HPP | ||
| 200 |