src/model/FoundationKivaSettings.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_FOUNDATIONKIVASETTINGS_HPP | ||
| 7 | #define MODEL_FOUNDATIONKIVASETTINGS_HPP | ||
| 8 | |||
| 9 | #include <vector> | ||
| 10 | #include "ModelAPI.hpp" | ||
| 11 | #include "ModelObject.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class FoundationKivaSettings_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** FoundationKivaSettings is a ModelObject that wraps the OpenStudio IDD object 'OS:Foundation:Kiva:Settings'. */ | ||
| 23 | class MODEL_API FoundationKivaSettings : public ModelObject | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | 25 | virtual ~FoundationKivaSettings() override = default; | |
| 30 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 31 | 3 | FoundationKivaSettings(const FoundationKivaSettings& other) = default; | |
| 32 | 6 | FoundationKivaSettings(FoundationKivaSettings&& other) = default; | |
| 33 | ✗ | FoundationKivaSettings& operator=(const FoundationKivaSettings&) = default; | |
| 34 | ✗ | FoundationKivaSettings& operator=(FoundationKivaSettings&&) = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | |||
| 38 | static IddObjectType iddObjectType(); | ||
| 39 | |||
| 40 | /** @name Getters */ | ||
| 41 | //@{ | ||
| 42 | |||
| 43 | double soilConductivity() const; | ||
| 44 | |||
| 45 | bool isSoilConductivityDefaulted() const; | ||
| 46 | |||
| 47 | double soilDensity() const; | ||
| 48 | |||
| 49 | bool isSoilDensityDefaulted() const; | ||
| 50 | |||
| 51 | double soilSpecificHeat() const; | ||
| 52 | |||
| 53 | bool isSoilSpecificHeatDefaulted() const; | ||
| 54 | |||
| 55 | double groundSolarAbsorptivity() const; | ||
| 56 | |||
| 57 | bool isGroundSolarAbsorptivityDefaulted() const; | ||
| 58 | |||
| 59 | double groundThermalAbsorptivity() const; | ||
| 60 | |||
| 61 | bool isGroundThermalAbsorptivityDefaulted() const; | ||
| 62 | |||
| 63 | double groundSurfaceRoughness() const; | ||
| 64 | |||
| 65 | bool isGroundSurfaceRoughnessDefaulted() const; | ||
| 66 | |||
| 67 | double farFieldWidth() const; | ||
| 68 | |||
| 69 | bool isFarFieldWidthDefaulted() const; | ||
| 70 | |||
| 71 | std::string deepGroundBoundaryCondition() const; | ||
| 72 | |||
| 73 | bool isDeepGroundBoundaryConditionAutoselected(); | ||
| 74 | |||
| 75 | boost::optional<double> deepGroundDepth(); | ||
| 76 | |||
| 77 | bool isDeepGroundDepthAutocalculated(); | ||
| 78 | |||
| 79 | double minimumCellDimension() const; | ||
| 80 | |||
| 81 | bool isMinimumCellDimensionDefaulted() const; | ||
| 82 | |||
| 83 | double maximumCellGrowthCoefficient() const; | ||
| 84 | |||
| 85 | bool isMaximumCellGrowthCoefficientDefaulted() const; | ||
| 86 | |||
| 87 | std::string simulationTimestep() const; | ||
| 88 | |||
| 89 | bool isSimulationTimestepDefaulted() const; | ||
| 90 | |||
| 91 | //@} | ||
| 92 | /** @name Setters */ | ||
| 93 | //@{ | ||
| 94 | |||
| 95 | bool setSoilConductivity(double soilConductivity); | ||
| 96 | |||
| 97 | void resetSoilConductivity(); | ||
| 98 | |||
| 99 | bool setSoilDensity(double soilDensity); | ||
| 100 | |||
| 101 | void resetSoilDensity(); | ||
| 102 | |||
| 103 | bool setSoilSpecificHeat(double soilSpecificHeat); | ||
| 104 | |||
| 105 | void resetSoilSpecificHeat(); | ||
| 106 | |||
| 107 | bool setGroundSolarAbsorptivity(double groundSolarAbsorptivity); | ||
| 108 | |||
| 109 | void resetGroundSolarAbsorptivity(); | ||
| 110 | |||
| 111 | bool setGroundThermalAbsorptivity(double groundThermalAbsorptivity); | ||
| 112 | |||
| 113 | void resetGroundThermalAbsorptivity(); | ||
| 114 | |||
| 115 | bool setGroundSurfaceRoughness(double groundSurfaceRoughness); | ||
| 116 | |||
| 117 | void resetGroundSurfaceRoughness(); | ||
| 118 | |||
| 119 | bool setFarFieldWidth(double farFieldWidth); | ||
| 120 | |||
| 121 | void resetFarFieldWidth(); | ||
| 122 | |||
| 123 | bool setDeepGroundBoundaryCondition(const std::string& deepGroundBoundaryCondition); | ||
| 124 | |||
| 125 | void resetDeepGroundBoundaryCondition(); | ||
| 126 | |||
| 127 | bool setDeepGroundDepth(double deepGroundDepth); | ||
| 128 | |||
| 129 | void autocalculateDeepGroundDepth(); | ||
| 130 | |||
| 131 | bool setMinimumCellDimension(double minimumCellDimension); | ||
| 132 | |||
| 133 | void resetMinimumCellDimension(); | ||
| 134 | |||
| 135 | bool setMaximumCellGrowthCoefficient(double maximumCellGrowthCoefficient); | ||
| 136 | |||
| 137 | void resetMaximumCellGrowthCoefficient(); | ||
| 138 | |||
| 139 | bool setSimulationTimestep(const std::string& simulationTimestep); | ||
| 140 | |||
| 141 | void resetSimulationTimestep(); | ||
| 142 | |||
| 143 | //@} | ||
| 144 | /** @name Other */ | ||
| 145 | //@{ | ||
| 146 | |||
| 147 | //@} | ||
| 148 | protected: | ||
| 149 | explicit FoundationKivaSettings(Model& model); | ||
| 150 | |||
| 151 | /// @cond | ||
| 152 | using ImplType = detail::FoundationKivaSettings_Impl; | ||
| 153 | |||
| 154 | friend class Model; | ||
| 155 | friend class openstudio::IdfObject; | ||
| 156 | friend class detail::FoundationKivaSettings_Impl; | ||
| 157 | |||
| 158 | explicit FoundationKivaSettings(std::shared_ptr<detail::FoundationKivaSettings_Impl> impl); | ||
| 159 | |||
| 160 | /// @endcond | ||
| 161 | private: | ||
| 162 | REGISTER_LOGGER("openstudio.model.FoundationKivaSettings"); | ||
| 163 | }; | ||
| 164 | |||
| 165 | /** \relates FoundationKivaSettings*/ | ||
| 166 | using OptionalFoundationKivaSettings = boost::optional<FoundationKivaSettings>; | ||
| 167 | |||
| 168 | /** \relates FoundationKivaSettings*/ | ||
| 169 | using FoundationKivaSettingsVector = std::vector<FoundationKivaSettings>; | ||
| 170 | |||
| 171 | } // namespace model | ||
| 172 | } // namespace openstudio | ||
| 173 | |||
| 174 | #endif // MODEL_FOUNDATIONKIVASETTINGS_HPP | ||
| 175 |