src/model/SimulationControl_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_SIMULATIONCONTROL_IMPL_HPP | ||
| 7 | #define MODEL_SIMULATIONCONTROL_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ParentObject_Impl.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class ConvergenceLimits; | ||
| 16 | class HeatBalanceAlgorithm; | ||
| 17 | class InsideSurfaceConvectionAlgorithm; | ||
| 18 | class OutsideSurfaceConvectionAlgorithm; | ||
| 19 | class RunPeriod; | ||
| 20 | class ShadowCalculation; | ||
| 21 | class SizingParameters; | ||
| 22 | class Timestep; | ||
| 23 | class ZoneAirContaminantBalance; | ||
| 24 | class ZoneAirHeatBalanceAlgorithm; | ||
| 25 | class ZoneAirMassFlowConservation; | ||
| 26 | class ZoneCapacitanceMultiplierResearchSpecial; | ||
| 27 | |||
| 28 | namespace detail { | ||
| 29 | |||
| 30 | class MODEL_API SimulationControl_Impl : public ParentObject_Impl | ||
| 31 | { | ||
| 32 | |||
| 33 | public: | ||
| 34 | /** @name Constructors and Destructors */ | ||
| 35 | //@{ | ||
| 36 | |||
| 37 | // constructor | ||
| 38 | SimulationControl_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 39 | |||
| 40 | // construct from workspace | ||
| 41 | SimulationControl_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 42 | |||
| 43 | // copy constructor | ||
| 44 | SimulationControl_Impl(const SimulationControl_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 45 | |||
| 46 | // virtual destructor | ||
| 47 | 1417 | virtual ~SimulationControl_Impl() override = default; | |
| 48 | |||
| 49 | //@} | ||
| 50 | /** @name Getters */ | ||
| 51 | //@{ | ||
| 52 | |||
| 53 | // return the parent object in the hierarchy | ||
| 54 | virtual boost::optional<ParentObject> parent() const override; | ||
| 55 | |||
| 56 | // return any children objects in the hierarchy | ||
| 57 | virtual std::vector<ModelObject> children() const override; | ||
| 58 | |||
| 59 | /// get a vector of allowable children types | ||
| 60 | virtual std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 61 | |||
| 62 | // Get all output variable names that could be associated with this object. | ||
| 63 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 64 | |||
| 65 | virtual IddObjectType iddObjectType() const override; | ||
| 66 | |||
| 67 | /** @name Getters */ | ||
| 68 | //@{ | ||
| 69 | |||
| 70 | bool doZoneSizingCalculation() const; | ||
| 71 | |||
| 72 | bool isDoZoneSizingCalculationDefaulted() const; | ||
| 73 | |||
| 74 | bool doSystemSizingCalculation() const; | ||
| 75 | |||
| 76 | bool isDoSystemSizingCalculationDefaulted() const; | ||
| 77 | |||
| 78 | bool doPlantSizingCalculation() const; | ||
| 79 | |||
| 80 | bool isDoPlantSizingCalculationDefaulted() const; | ||
| 81 | |||
| 82 | bool runSimulationforSizingPeriods() const; | ||
| 83 | |||
| 84 | bool isRunSimulationforSizingPeriodsDefaulted() const; | ||
| 85 | |||
| 86 | bool runSimulationforWeatherFileRunPeriods() const; | ||
| 87 | |||
| 88 | bool isRunSimulationforWeatherFileRunPeriodsDefaulted() const; | ||
| 89 | |||
| 90 | double loadsConvergenceToleranceValue() const; | ||
| 91 | |||
| 92 | bool isLoadsConvergenceToleranceValueDefaulted() const; | ||
| 93 | |||
| 94 | double temperatureConvergenceToleranceValue() const; | ||
| 95 | |||
| 96 | bool isTemperatureConvergenceToleranceValueDefaulted() const; | ||
| 97 | |||
| 98 | std::string solarDistribution() const; | ||
| 99 | |||
| 100 | bool isSolarDistributionDefaulted() const; | ||
| 101 | |||
| 102 | int maximumNumberofWarmupDays() const; | ||
| 103 | |||
| 104 | bool isMaximumNumberofWarmupDaysDefaulted() const; | ||
| 105 | |||
| 106 | int minimumNumberofWarmupDays() const; | ||
| 107 | |||
| 108 | bool isMinimumNumberofWarmupDaysDefaulted() const; | ||
| 109 | |||
| 110 | bool doHVACSizingSimulationforSizingPeriods() const; | ||
| 111 | bool isDoHVACSizingSimulationforSizingPeriodsDefaulted() const; | ||
| 112 | |||
| 113 | int maximumNumberofHVACSizingSimulationPasses() const; | ||
| 114 | bool isMaximumNumberofHVACSizingSimulationPassesDefaulted() const; | ||
| 115 | |||
| 116 | //@} | ||
| 117 | /** @name Setters */ | ||
| 118 | //@{ | ||
| 119 | |||
| 120 | bool setDoZoneSizingCalculation(bool doZoneSizingCalculation); | ||
| 121 | |||
| 122 | void resetDoZoneSizingCalculation(); | ||
| 123 | |||
| 124 | bool setDoSystemSizingCalculation(bool doSystemSizingCalculation); | ||
| 125 | |||
| 126 | void resetDoSystemSizingCalculation(); | ||
| 127 | |||
| 128 | bool setDoPlantSizingCalculation(bool doPlantSizingCalculation); | ||
| 129 | |||
| 130 | void resetDoPlantSizingCalculation(); | ||
| 131 | |||
| 132 | bool setRunSimulationforSizingPeriods(bool runSimulationforSizingPeriods); | ||
| 133 | |||
| 134 | void resetRunSimulationforSizingPeriods(); | ||
| 135 | |||
| 136 | bool setRunSimulationforWeatherFileRunPeriods(bool runSimulationforWeatherFileRunPeriods); | ||
| 137 | |||
| 138 | void resetRunSimulationforWeatherFileRunPeriods(); | ||
| 139 | |||
| 140 | bool setLoadsConvergenceToleranceValue(double loadsConvergenceToleranceValue); | ||
| 141 | |||
| 142 | void resetLoadsConvergenceToleranceValue(); | ||
| 143 | |||
| 144 | bool setTemperatureConvergenceToleranceValue(double temperatureConvergenceToleranceValue); | ||
| 145 | |||
| 146 | void resetTemperatureConvergenceToleranceValue(); | ||
| 147 | |||
| 148 | bool setSolarDistribution(const std::string& solarDistribution); | ||
| 149 | |||
| 150 | void resetSolarDistribution(); | ||
| 151 | |||
| 152 | bool setMaximumNumberofWarmupDays(int maximumNumberofWarmupDays); | ||
| 153 | |||
| 154 | void resetMaximumNumberofWarmupDays(); | ||
| 155 | |||
| 156 | bool setMinimumNumberofWarmupDays(int minimumNumberofWarmupDays); | ||
| 157 | |||
| 158 | void resetMinimumNumberofWarmupDays(); | ||
| 159 | |||
| 160 | bool setDoHVACSizingSimulationforSizingPeriods(bool doHVACSizingSimulationforSizingPeriods); | ||
| 161 | void resetDoHVACSizingSimulationforSizingPeriods(); | ||
| 162 | |||
| 163 | bool setMaximumNumberofHVACSizingSimulationPasses(int maximumNumberofHVACSizingSimulationPasses); | ||
| 164 | void resetMaximumNumberofHVACSizingSimulationPasses(); | ||
| 165 | |||
| 166 | //@} | ||
| 167 | |||
| 168 | boost::optional<ConvergenceLimits> convergenceLimits() const; | ||
| 169 | |||
| 170 | boost::optional<HeatBalanceAlgorithm> heatBalanceAlgorithm() const; | ||
| 171 | |||
| 172 | boost::optional<InsideSurfaceConvectionAlgorithm> insideSurfaceConvectionAlgorithm() const; | ||
| 173 | |||
| 174 | boost::optional<OutsideSurfaceConvectionAlgorithm> outsideSurfaceConvectionAlgorithm() const; | ||
| 175 | |||
| 176 | std::vector<RunPeriod> runPeriods() const; | ||
| 177 | |||
| 178 | boost::optional<ShadowCalculation> shadowCalculation() const; | ||
| 179 | |||
| 180 | boost::optional<SizingParameters> sizingParameters() const; | ||
| 181 | |||
| 182 | boost::optional<Timestep> timestep() const; | ||
| 183 | |||
| 184 | boost::optional<ZoneAirContaminantBalance> zoneAirContaminantBalance() const; | ||
| 185 | |||
| 186 | boost::optional<ZoneAirHeatBalanceAlgorithm> zoneAirHeatBalanceAlgorithm() const; | ||
| 187 | |||
| 188 | boost::optional<ZoneAirMassFlowConservation> zoneAirMassFlowConservation() const; | ||
| 189 | |||
| 190 | boost::optional<ZoneCapacitanceMultiplierResearchSpecial> zoneCapacitanceMultiplierResearchSpecial() const; | ||
| 191 | |||
| 192 | /** Returns the SqlFile environment period strings that correspond to sizing periods. */ | ||
| 193 | std::vector<std::string> sizingEnvironmentPeriods() const; | ||
| 194 | |||
| 195 | /** Returns the SqlFile environment period strings that correspond to single-year annual | ||
| 196 | * simulations. */ | ||
| 197 | std::vector<std::string> annualSimulationEnvironmentPeriods() const; | ||
| 198 | |||
| 199 | /** Returns the SqlFile environment period strings that correspond to partial-year, | ||
| 200 | * non-sizing simulations. */ | ||
| 201 | std::vector<std::string> partialYearEnvironmentPeriods() const; | ||
| 202 | |||
| 203 | /** Returns the SqlFile environment period strings that correspond to non-sizing simulations | ||
| 204 | * with repeated run periods. (Multi-year, or repeated partial years.) */ | ||
| 205 | std::vector<std::string> repeatedIntervalEnvironmentPeriods() const; | ||
| 206 | |||
| 207 | //@} | ||
| 208 | private: | ||
| 209 | − | REGISTER_LOGGER("openstudio.model.SimulationControl"); | |
| 210 | |||
| 211 | std::vector<std::string> solarDistributionValues() const; | ||
| 212 | }; | ||
| 213 | |||
| 214 | } // namespace detail | ||
| 215 | |||
| 216 | } // namespace model | ||
| 217 | } // namespace openstudio | ||
| 218 | |||
| 219 | #endif // MODEL_SIMULATIONCONTROL_IMPL_HPP | ||
| 220 |