 |
OpenStudio:model |
#include <SimulationControl.hpp>
Inheritance diagram for openstudio::model::SimulationControl:Public Member Functions | |
| std::vector< std::string > | annualSimulationEnvironmentPeriods () const |
| Returns the SqlFile environment period strings that correspond to single-year annual simulations. More... | |
| boost::optional < ConvergenceLimits > | convergenceLimits () const |
| Returns child ConvergenceLimits if it exists. More... | |
| boost::optional < HeatBalanceAlgorithm > | heatBalanceAlgorithm () const |
| Returns child HeatBalanceAlgorithm if it exists. More... | |
| boost::optional < InsideSurfaceConvectionAlgorithm > | insideSurfaceConvectionAlgorithm () const |
| Returns child InsideSurfaceConvectionAlgorithm if it exists. More... | |
| boost::optional < OutsideSurfaceConvectionAlgorithm > | outsideSurfaceConvectionAlgorithm () const |
| Returns child OutsideSurfaceConvectionAlgorithm if it exists. More... | |
| std::vector< std::string > | partialYearEnvironmentPeriods () const |
| Returns the SqlFile environment period strings that correspond to partial-year, non-sizing simulations. More... | |
| std::vector< std::string > | repeatedIntervalEnvironmentPeriods () const |
| Returns the SqlFile environment period strings that correspond to non-sizing simulations with repeated run periods. More... | |
| std::vector< RunPeriod > | runPeriods () const |
| Returns all children of type RunPeriod. More... | |
| boost::optional < ShadowCalculation > | shadowCalculation () const |
| Returns child ShadowCalculation if it exists. More... | |
| std::vector< std::string > | sizingEnvironmentPeriods () const |
| Returns the SqlFile environment period strings that correspond to sizing periods. More... | |
| boost::optional< SizingParameters > | sizingParameters () const |
| Returns the SizingParameters object if it exists. More... | |
| boost::optional< Timestep > | timestep () const |
| Returns child Timestep if it exists. More... | |
| boost::optional < ZoneAirContaminantBalance > | zoneAirContaminantBalance () const |
| Returns child ZoneAirContaminantBalance if it exists. More... | |
| boost::optional < ZoneAirHeatBalanceAlgorithm > | zoneAirHeatBalanceAlgorithm () const |
| Returns child ZoneAirHeatBalanceAlgorithm if it exists. More... | |
| boost::optional < ZoneAirMassFlowConservation > | zoneAirMassFlowConservation () const |
| Returns child ZoneAirMassFlowConservation object if it exists. More... | |
| boost::optional < ZoneCapacitanceMultiplierResearchSpecial > | zoneCapacitanceMultiplierResearchSpecial () const |
| Returns child ZoneCapacitanceMultiplierResearchSpecial if it exists. More... | |
| virtual | ~SimulationControl () |
Getters | |
| bool | doZoneSizingCalculation () const |
| bool | isDoZoneSizingCalculationDefaulted () const |
| bool | doSystemSizingCalculation () const |
| bool | isDoSystemSizingCalculationDefaulted () const |
| bool | doPlantSizingCalculation () const |
| bool | isDoPlantSizingCalculationDefaulted () const |
| bool | runSimulationforSizingPeriods () const |
| bool | isRunSimulationforSizingPeriodsDefaulted () const |
| bool | runSimulationforWeatherFileRunPeriods () const |
| bool | isRunSimulationforWeatherFileRunPeriodsDefaulted () const |
| double | loadsConvergenceToleranceValue () const |
| bool | isLoadsConvergenceToleranceValueDefaulted () const |
| double | temperatureConvergenceToleranceValue () const |
| bool | isTemperatureConvergenceToleranceValueDefaulted () const |
| std::string | solarDistribution () const |
| bool | isSolarDistributionDefaulted () const |
| int | maximumNumberofWarmupDays () const |
| bool | isMaximumNumberofWarmupDaysDefaulted () const |
| int | minimumNumberofWarmupDays () const |
| bool | isMinimumNumberofWarmupDaysDefaulted () const |
| bool | doHVACSizingSimulationforSizingPeriods () const |
| bool | isDoHVACSizingSimulationforSizingPeriodsDefaulted () const |
| int | maximumNumberofHVACSizingSimulationPasses () const |
| bool | isMaximumNumberofHVACSizingSimulationPassesDefaulted () const |
Setters | |
| bool | setDoZoneSizingCalculation (bool doZoneSizingCalculation) |
| void | setDoZoneSizingCalculationNoFail (bool doZoneSizingCalculation) |
| void | resetDoZoneSizingCalculation () |
| bool | setDoSystemSizingCalculation (bool doSystemSizingCalculation) |
| void | setDoSystemSizingCalculationNoFail (bool doSystemSizingCalculation) |
| void | resetDoSystemSizingCalculation () |
| bool | setDoPlantSizingCalculation (bool doPlantSizingCalculation) |
| void | setDoPlantSizingCalculationNoFail (bool doPlantSizingCalculation) |
| void | resetDoPlantSizingCalculation () |
| bool | setRunSimulationforSizingPeriods (bool runSimulationforSizingPeriods) |
| void | setRunSimulationforSizingPeriodsNoFail (bool runSimulationforSizingPeriods) |
| void | resetRunSimulationforSizingPeriods () |
| bool | setRunSimulationforWeatherFileRunPeriods (bool runSimulationforWeatherFileRunPeriods) |
| void | setRunSimulationforWeatherFileRunPeriodsNoFail (bool runSimulationforWeatherFileRunPeriods) |
| void | resetRunSimulationforWeatherFileRunPeriods () |
| bool | setLoadsConvergenceToleranceValue (double loadsConvergenceToleranceValue) |
| void | resetLoadsConvergenceToleranceValue () |
| bool | setTemperatureConvergenceToleranceValue (double temperatureConvergenceToleranceValue) |
| void | resetTemperatureConvergenceToleranceValue () |
| bool | setSolarDistribution (std::string solarDistribution) |
| void | resetSolarDistribution () |
| bool | setMaximumNumberofWarmupDays (int maximumNumberofWarmupDays) |
| void | resetMaximumNumberofWarmupDays () |
| bool | setMinimumNumberofWarmupDays (int minimumNumberofWarmupDays) |
| void | resetMinimumNumberofWarmupDays () |
| bool | setDoHVACSizingSimulationforSizingPeriods (bool doHVACSizingSimulationforSizingPeriods) |
| void | setDoHVACSizingSimulationforSizingPeriodsNoFail (bool doHVACSizingSimulationforSizingPeriods) |
| void | resetDoHVACSizingSimulationforSizingPeriods () |
| bool | setMaximumNumberofHVACSizingSimulationPasses (int maximumNumberofHVACSizingSimulationPasses) |
| void | resetMaximumNumberofHVACSizingSimulationPasses () |
| Public Member Functions inherited from openstudio::model::ParentObject | |
| std::vector< IddObjectType > | allowableChildTypes () const |
| Returns a vector of allowable children types. More... | |
| std::vector< ModelObject > | children () const |
| Return direct child objects in the Model. More... | |
| virtual | ~ParentObject () |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject () |
| ModelObject | clone () const |
| Creates a deep copy of this object, placing it in this object's model(). More... | |
| ModelObject | clone (Model model) const |
| Creates a deep copy of this object, placing it in model. More... | |
| Component | createComponent () const |
| Method for creating sharable Model snippets. More... | |
| Model | model () const |
| Returns the Model that contains this object. More... | |
| boost::optional< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () const |
| Get the resources directly used by this ModelObject. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectSources () const |
| Get all objects of type T that point to this object. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
| Get all objects of type T that point to this object. More... | |
| template<typename T > | |
| boost::optional< T > | getModelObjectTarget (unsigned index) const |
| Get the object of type T pointed to by this object from field index. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectTargets () const |
| Get all objects of type T to which this object points. More... | |
| const std::vector< std::string > & | outputVariableNames () const |
| Get all output variables names that could be associated with this object. More... | |
| std::vector< OutputVariable > | outputVariables () const |
| Get all output variables associated with this object, must run simulation to generate data. More... | |
| boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
| Get data associated with this output variable and this object. More... | |
| std::vector< LifeCycleCost > | lifeCycleCosts () const |
| Returns the list of all LifeCycleCosts that refer to this object. More... | |
| std::vector< IdfObject > | removeLifeCycleCosts () |
| Removes all LifeCycleCosts that refer to this object. More... | |
| IddObjectType | iddObjectType () const |
| This is a virtual function that will tell you the type of iddObject you are dealing with. More... | |
| AdditionalProperties | additionalProperties () const |
| Returns this object's additional properties, constructing a new object if necessary. More... | |
| bool | hasAdditionalProperties () const |
| Returns true if this object has additional properties. More... | |
| std::vector< IdfObject > | removeAdditionalProperties () |
| Removes all additional properties that refer to this object. More... | |
| boost::optional< std::string > | cadObjectId () const |
| bool | setCADObjectId (const std::string &cadObjectId) |
| boost::optional< std::string > | gbXMLId () const |
| bool | setGBXMLId (const std::string &gbXMLId) |
| boost::optional< std::string > | displayName () const |
| bool | setDisplayName (const std::string &displayName) |
| bool | setParent (ParentObject &newParent) |
| set the parent, child may have to call non-const methods on the parent More... | |
| bool | operator< (const ModelObject &right) const |
| bool | operator== (const ModelObject &other) const |
| equality test More... | |
| bool | operator!= (const ModelObject &other) const |
| inequality test More... | |
| std::vector< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
| Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
| boost::optional< double > | getAutosizedValue (std::string valueName, std::string unitString) const |
| Gets the autosized component value from the sql file. More... | |
| virtual std::vector < EMSActuatorNames > | emsActuatorNames () const |
| Return the names of the available ems actuators. More... | |
| virtual std::vector< std::string > | emsInternalVariableNames () const |
| Return the names of the available ems internal variables. More... | |
| boost::optional< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
Static Methods | |
| static IddObjectType | iddObjectType () |
| static std::vector< std::string > | validSolarDistributionValues () |
Protected Member Functions | |
Constructors and Destructors | |
| SimulationControl (const Model &model) | |
| Constructs a new SimulationControl object in the model. More... | |
| Protected Member Functions inherited from openstudio::model::ParentObject | |
| ParentObject (IddObjectType type, const Model &model) | |
| Constructs a new ParentObject object in the model. More... | |
| Protected Member Functions inherited from openstudio::model::ModelObject | |
| ModelObject (IddObjectType type, const Model &model, bool fastName=false) | |
| ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl) | |
Related Functions | |
(Note that these are not member functions.) | |
| typedef boost::optional < SimulationControl > | OptionalSimulationControl |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
| Protected Types inherited from openstudio::model::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
SimulationControl derives from ParentObject and is an interface to the OpenStudio IDD object named "SimulationControl".
SimulationControl defines what types of sizing simulations are performed for an EnergyPlus simulation, it also controls whether or not to report results from sizing and weather file simulations. SimulationControl parents several other ModelObject types that configure simulation parameters for EnergyPlus. SimulationControl does not have a public constructor because it is a unique ModelObject. To get the SimulationControl object for a Model or create one if it does not yet exist use model.getUniqueObject<SimulationControl>(). To get the SimulationControl object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<SimulationControl>().
|
inlinevirtual |
|
explicitprotected |
Constructs a new SimulationControl object in the model.
| std::vector<std::string> openstudio::model::SimulationControl::annualSimulationEnvironmentPeriods | ( | ) | const |
Returns the SqlFile environment period strings that correspond to single-year annual simulations.
| boost::optional<ConvergenceLimits> openstudio::model::SimulationControl::convergenceLimits | ( | ) | const |
Returns child ConvergenceLimits if it exists.
| bool openstudio::model::SimulationControl::doHVACSizingSimulationforSizingPeriods | ( | ) | const |
| bool openstudio::model::SimulationControl::doPlantSizingCalculation | ( | ) | const |
| bool openstudio::model::SimulationControl::doSystemSizingCalculation | ( | ) | const |
| bool openstudio::model::SimulationControl::doZoneSizingCalculation | ( | ) | const |
| boost::optional<HeatBalanceAlgorithm> openstudio::model::SimulationControl::heatBalanceAlgorithm | ( | ) | const |
Returns child HeatBalanceAlgorithm if it exists.
|
static |
| boost::optional<InsideSurfaceConvectionAlgorithm> openstudio::model::SimulationControl::insideSurfaceConvectionAlgorithm | ( | ) | const |
Returns child InsideSurfaceConvectionAlgorithm if it exists.
| bool openstudio::model::SimulationControl::isDoHVACSizingSimulationforSizingPeriodsDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isDoPlantSizingCalculationDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isDoSystemSizingCalculationDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isDoZoneSizingCalculationDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isLoadsConvergenceToleranceValueDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isMaximumNumberofHVACSizingSimulationPassesDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isMaximumNumberofWarmupDaysDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isMinimumNumberofWarmupDaysDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isRunSimulationforSizingPeriodsDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isRunSimulationforWeatherFileRunPeriodsDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isSolarDistributionDefaulted | ( | ) | const |
| bool openstudio::model::SimulationControl::isTemperatureConvergenceToleranceValueDefaulted | ( | ) | const |
| double openstudio::model::SimulationControl::loadsConvergenceToleranceValue | ( | ) | const |
| int openstudio::model::SimulationControl::maximumNumberofHVACSizingSimulationPasses | ( | ) | const |
| int openstudio::model::SimulationControl::maximumNumberofWarmupDays | ( | ) | const |
| int openstudio::model::SimulationControl::minimumNumberofWarmupDays | ( | ) | const |
| boost::optional<OutsideSurfaceConvectionAlgorithm> openstudio::model::SimulationControl::outsideSurfaceConvectionAlgorithm | ( | ) | const |
Returns child OutsideSurfaceConvectionAlgorithm if it exists.
| std::vector<std::string> openstudio::model::SimulationControl::partialYearEnvironmentPeriods | ( | ) | const |
Returns the SqlFile environment period strings that correspond to partial-year, non-sizing simulations.
| std::vector<std::string> openstudio::model::SimulationControl::repeatedIntervalEnvironmentPeriods | ( | ) | const |
Returns the SqlFile environment period strings that correspond to non-sizing simulations with repeated run periods.
(Multi-year, or repeated partial years.)
| void openstudio::model::SimulationControl::resetDoHVACSizingSimulationforSizingPeriods | ( | ) |
| void openstudio::model::SimulationControl::resetDoPlantSizingCalculation | ( | ) |
| void openstudio::model::SimulationControl::resetDoSystemSizingCalculation | ( | ) |
| void openstudio::model::SimulationControl::resetDoZoneSizingCalculation | ( | ) |
| void openstudio::model::SimulationControl::resetLoadsConvergenceToleranceValue | ( | ) |
| void openstudio::model::SimulationControl::resetMaximumNumberofHVACSizingSimulationPasses | ( | ) |
| void openstudio::model::SimulationControl::resetMaximumNumberofWarmupDays | ( | ) |
| void openstudio::model::SimulationControl::resetMinimumNumberofWarmupDays | ( | ) |
| void openstudio::model::SimulationControl::resetRunSimulationforSizingPeriods | ( | ) |
| void openstudio::model::SimulationControl::resetRunSimulationforWeatherFileRunPeriods | ( | ) |
| void openstudio::model::SimulationControl::resetSolarDistribution | ( | ) |
| void openstudio::model::SimulationControl::resetTemperatureConvergenceToleranceValue | ( | ) |
| std::vector<RunPeriod> openstudio::model::SimulationControl::runPeriods | ( | ) | const |
Returns all children of type RunPeriod.
| bool openstudio::model::SimulationControl::runSimulationforSizingPeriods | ( | ) | const |
| bool openstudio::model::SimulationControl::runSimulationforWeatherFileRunPeriods | ( | ) | const |
| bool openstudio::model::SimulationControl::setDoHVACSizingSimulationforSizingPeriods | ( | bool | doHVACSizingSimulationforSizingPeriods | ) |
| void openstudio::model::SimulationControl::setDoHVACSizingSimulationforSizingPeriodsNoFail | ( | bool | doHVACSizingSimulationforSizingPeriods | ) |
| bool openstudio::model::SimulationControl::setDoPlantSizingCalculation | ( | bool | doPlantSizingCalculation | ) |
| void openstudio::model::SimulationControl::setDoPlantSizingCalculationNoFail | ( | bool | doPlantSizingCalculation | ) |
| bool openstudio::model::SimulationControl::setDoSystemSizingCalculation | ( | bool | doSystemSizingCalculation | ) |
| void openstudio::model::SimulationControl::setDoSystemSizingCalculationNoFail | ( | bool | doSystemSizingCalculation | ) |
| bool openstudio::model::SimulationControl::setDoZoneSizingCalculation | ( | bool | doZoneSizingCalculation | ) |
| void openstudio::model::SimulationControl::setDoZoneSizingCalculationNoFail | ( | bool | doZoneSizingCalculation | ) |
| bool openstudio::model::SimulationControl::setLoadsConvergenceToleranceValue | ( | double | loadsConvergenceToleranceValue | ) |
| bool openstudio::model::SimulationControl::setMaximumNumberofHVACSizingSimulationPasses | ( | int | maximumNumberofHVACSizingSimulationPasses | ) |
| bool openstudio::model::SimulationControl::setMaximumNumberofWarmupDays | ( | int | maximumNumberofWarmupDays | ) |
| bool openstudio::model::SimulationControl::setMinimumNumberofWarmupDays | ( | int | minimumNumberofWarmupDays | ) |
| bool openstudio::model::SimulationControl::setRunSimulationforSizingPeriods | ( | bool | runSimulationforSizingPeriods | ) |
| void openstudio::model::SimulationControl::setRunSimulationforSizingPeriodsNoFail | ( | bool | runSimulationforSizingPeriods | ) |
| bool openstudio::model::SimulationControl::setRunSimulationforWeatherFileRunPeriods | ( | bool | runSimulationforWeatherFileRunPeriods | ) |
| void openstudio::model::SimulationControl::setRunSimulationforWeatherFileRunPeriodsNoFail | ( | bool | runSimulationforWeatherFileRunPeriods | ) |
| bool openstudio::model::SimulationControl::setSolarDistribution | ( | std::string | solarDistribution | ) |
| bool openstudio::model::SimulationControl::setTemperatureConvergenceToleranceValue | ( | double | temperatureConvergenceToleranceValue | ) |
| boost::optional<ShadowCalculation> openstudio::model::SimulationControl::shadowCalculation | ( | ) | const |
Returns child ShadowCalculation if it exists.
| std::vector<std::string> openstudio::model::SimulationControl::sizingEnvironmentPeriods | ( | ) | const |
Returns the SqlFile environment period strings that correspond to sizing periods.
| boost::optional<SizingParameters> openstudio::model::SimulationControl::sizingParameters | ( | ) | const |
Returns the SizingParameters object if it exists.
| std::string openstudio::model::SimulationControl::solarDistribution | ( | ) | const |
| double openstudio::model::SimulationControl::temperatureConvergenceToleranceValue | ( | ) | const |
| boost::optional<Timestep> openstudio::model::SimulationControl::timestep | ( | ) | const |
Returns child Timestep if it exists.
|
static |
| boost::optional<ZoneAirContaminantBalance> openstudio::model::SimulationControl::zoneAirContaminantBalance | ( | ) | const |
Returns child ZoneAirContaminantBalance if it exists.
| boost::optional<ZoneAirHeatBalanceAlgorithm> openstudio::model::SimulationControl::zoneAirHeatBalanceAlgorithm | ( | ) | const |
Returns child ZoneAirHeatBalanceAlgorithm if it exists.
| boost::optional<ZoneAirMassFlowConservation> openstudio::model::SimulationControl::zoneAirMassFlowConservation | ( | ) | const |
Returns child ZoneAirMassFlowConservation object if it exists.
| boost::optional<ZoneCapacitanceMultiplierResearchSpecial> openstudio::model::SimulationControl::zoneCapacitanceMultiplierResearchSpecial | ( | ) | const |
Returns child ZoneCapacitanceMultiplierResearchSpecial if it exists.
|
related |