src/model/MaterialPropertyPhaseChangeHysteresis.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_MATERIALPROPERTYPHASECHANGEHYSTERESIS_HPP | ||
| 7 | #define MODEL_MATERIALPROPERTYPHASECHANGEHYSTERESIS_HPP | ||
| 8 | |||
| 9 | #include <vector> | ||
| 10 | #include "ModelAPI.hpp" | ||
| 11 | #include "ModelObject.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Material; | ||
| 17 | class StandardOpaqueMaterial; | ||
| 18 | class MasslessOpaqueMaterial; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class MaterialPropertyPhaseChangeHysteresis_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** MaterialPropertyPhaseChangeHysteresis is a ModelObject that wraps the OpenStudio IDD object 'OS:MaterialProperty:PhaseChangeHysteresis'. */ | ||
| 27 | class MODEL_API MaterialPropertyPhaseChangeHysteresis : public ModelObject | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit MaterialPropertyPhaseChangeHysteresis(StandardOpaqueMaterial& material); | ||
| 34 | |||
| 35 | explicit MaterialPropertyPhaseChangeHysteresis(MasslessOpaqueMaterial& material); | ||
| 36 | |||
| 37 | 31 | virtual ~MaterialPropertyPhaseChangeHysteresis() override = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | |||
| 41 | static IddObjectType iddObjectType(); | ||
| 42 | |||
| 43 | /** @name Getters */ | ||
| 44 | //@{ | ||
| 45 | |||
| 46 | std::string materialName() const; | ||
| 47 | |||
| 48 | Material material() const; | ||
| 49 | |||
| 50 | double latentHeatduringtheEntirePhaseChangeProcess() const; | ||
| 51 | |||
| 52 | double liquidStateThermalConductivity() const; | ||
| 53 | |||
| 54 | double liquidStateDensity() const; | ||
| 55 | |||
| 56 | double liquidStateSpecificHeat() const; | ||
| 57 | |||
| 58 | double highTemperatureDifferenceofMeltingCurve() const; | ||
| 59 | |||
| 60 | double peakMeltingTemperature() const; | ||
| 61 | |||
| 62 | double lowTemperatureDifferenceofMeltingCurve() const; | ||
| 63 | |||
| 64 | double solidStateThermalConductivity() const; | ||
| 65 | |||
| 66 | double solidStateDensity() const; | ||
| 67 | |||
| 68 | double solidStateSpecificHeat() const; | ||
| 69 | |||
| 70 | double highTemperatureDifferenceofFreezingCurve() const; | ||
| 71 | |||
| 72 | double peakFreezingTemperature() const; | ||
| 73 | |||
| 74 | double lowTemperatureDifferenceofFreezingCurve() const; | ||
| 75 | |||
| 76 | //@} | ||
| 77 | /** @name Setters */ | ||
| 78 | //@{ | ||
| 79 | |||
| 80 | bool setLatentHeatduringtheEntirePhaseChangeProcess(double latentHeatduringtheEntirePhaseChangeProcess); | ||
| 81 | |||
| 82 | bool setLiquidStateThermalConductivity(double liquidStateThermalConductivity); | ||
| 83 | |||
| 84 | bool setLiquidStateDensity(double liquidStateDensity); | ||
| 85 | |||
| 86 | bool setLiquidStateSpecificHeat(double liquidStateSpecificHeat); | ||
| 87 | |||
| 88 | bool setHighTemperatureDifferenceofMeltingCurve(double highTemperatureDifferenceofMeltingCurve); | ||
| 89 | |||
| 90 | bool setPeakMeltingTemperature(double peakMeltingTemperature); | ||
| 91 | |||
| 92 | bool setLowTemperatureDifferenceofMeltingCurve(double lowTemperatureDifferenceofMeltingCurve); | ||
| 93 | |||
| 94 | bool setSolidStateThermalConductivity(double solidStateThermalConductivity); | ||
| 95 | |||
| 96 | bool setSolidStateDensity(double solidStateDensity); | ||
| 97 | |||
| 98 | bool setSolidStateSpecificHeat(double solidStateSpecificHeat); | ||
| 99 | |||
| 100 | bool setHighTemperatureDifferenceofFreezingCurve(double highTemperatureDifferenceofFreezingCurve); | ||
| 101 | |||
| 102 | bool setPeakFreezingTemperature(double peakFreezingTemperature); | ||
| 103 | |||
| 104 | bool setLowTemperatureDifferenceofFreezingCurve(double lowTemperatureDifferenceofFreezingCurve); | ||
| 105 | |||
| 106 | //@} | ||
| 107 | /** @name Other */ | ||
| 108 | //@{ | ||
| 109 | |||
| 110 | //@} | ||
| 111 | protected: | ||
| 112 | /// @cond | ||
| 113 | using ImplType = detail::MaterialPropertyPhaseChangeHysteresis_Impl; | ||
| 114 | |||
| 115 | explicit MaterialPropertyPhaseChangeHysteresis(std::shared_ptr<detail::MaterialPropertyPhaseChangeHysteresis_Impl> impl); | ||
| 116 | |||
| 117 | friend class detail::MaterialPropertyPhaseChangeHysteresis_Impl; | ||
| 118 | friend class Model; | ||
| 119 | friend class IdfObject; | ||
| 120 | friend class openstudio::detail::IdfObject_Impl; | ||
| 121 | /// @endcond | ||
| 122 | private: | ||
| 123 | − | REGISTER_LOGGER("openstudio.model.MaterialPropertyPhaseChangeHysteresis"); | |
| 124 | }; | ||
| 125 | |||
| 126 | /** \relates MaterialPropertyPhaseChangeHysteresis*/ | ||
| 127 | using OptionalMaterialPropertyPhaseChangeHysteresis = boost::optional<MaterialPropertyPhaseChangeHysteresis>; | ||
| 128 | |||
| 129 | /** \relates MaterialPropertyPhaseChangeHysteresis*/ | ||
| 130 | using MaterialPropertyPhaseChangeHysteresisVector = std::vector<MaterialPropertyPhaseChangeHysteresis>; | ||
| 131 | |||
| 132 | } // namespace model | ||
| 133 | } // namespace openstudio | ||
| 134 | |||
| 135 | #endif // MODEL_MATERIALPROPERTYPHASECHANGEHYSTERESIS_HPP | ||
| 136 |