openstudio::model::SimulationControl Class Reference

#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
Quantity	getLoadsConvergenceToleranceValue (bool returnIP=false) const
bool	isLoadsConvergenceToleranceValueDefaulted () const
double	temperatureConvergenceToleranceValue () const
Quantity	getTemperatureConvergenceToleranceValue (bool returnIP=false) const
bool	isTemperatureConvergenceToleranceValueDefaulted () const
std::string	solarDistribution () const
bool	isSolarDistributionDefaulted () const
int	maximumNumberofWarmupDays () const
bool	isMaximumNumberofWarmupDaysDefaulted () const
int	minimumNumberofWarmupDays () const
bool	isMinimumNumberofWarmupDaysDefaulted () const
Setters
void	setDoZoneSizingCalculation (bool doZoneSizingCalculation)
void	resetDoZoneSizingCalculation ()
void	setDoSystemSizingCalculation (bool doSystemSizingCalculation)
void	resetDoSystemSizingCalculation ()
void	setDoPlantSizingCalculation (bool doPlantSizingCalculation)
void	resetDoPlantSizingCalculation ()
void	setRunSimulationforSizingPeriods (bool runSimulationforSizingPeriods)
void	resetRunSimulationforSizingPeriods ()
void	setRunSimulationforWeatherFileRunPeriods (bool runSimulationforWeatherFileRunPeriods)
void	resetRunSimulationforWeatherFileRunPeriods ()
bool	setLoadsConvergenceToleranceValue (double loadsConvergenceToleranceValue)
bool	setLoadsConvergenceToleranceValue (const Quantity &loadsConvergenceToleranceValue)
void	resetLoadsConvergenceToleranceValue ()
bool	setTemperatureConvergenceToleranceValue (double temperatureConvergenceToleranceValue)
bool	setTemperatureConvergenceToleranceValue (const Quantity &temperatureConvergenceToleranceValue)
void	resetTemperatureConvergenceToleranceValue ()
bool	setSolarDistribution (std::string solarDistribution)
void	resetSolarDistribution ()
bool	setMaximumNumberofWarmupDays (int maximumNumberofWarmupDays)
void	resetMaximumNumberofWarmupDays ()
bool	setMinimumNumberofWarmupDays (int minimumNumberofWarmupDays)
void	resetMinimumNumberofWarmupDays ()
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...
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< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const
Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const
bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
std::vector< std::string >	canBeTarget () const
std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const
std::vector< WorkspaceObject >	getSources (IddObjectType type) const
boost::optional< WorkspaceObject >	getTarget (unsigned index) const
IdfObject	idfObject ()
IdfObject	idfObject () const
bool	initialized () const
bool	isSource () const
bool	isTarget () const
unsigned	numSources () const
bool	objectListFieldsEqual (const WorkspaceObject &other) const
bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const
bool	operator< (const WorkspaceObject &right) const
std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
std::vector < openstudio::IdfObject >	remove ()
bool	setPointer (unsigned index, const Handle &targetHandle)
std::vector< WorkspaceObject >	sources () const
std::vector< WorkspaceObject >	targets () const
Workspace	workspace () const
virtual	~WorkspaceObject ()
Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const
T	cast () const
std::vector< T >	castVector (const std::vector< U > &objects)
std::vector< std::vector < std::string > >	clearExtensibleGroups ()
IdfObject	clone (bool keepHandle=false) const
std::string	comment () const
boost::optional< std::string >	createName (bool overwrite=true)
std::vector< unsigned >	dataFields () const
bool	dataFieldsEqual (const IdfObject &other) const
std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)
std::vector< IdfExtensibleGroup >	extensibleGroups () const
boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const
boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const
IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const
std::vector< Handle >	getHandles (const std::vector< T > &objects)
boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const
OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const
boost::optional< QUrl >	getURL (unsigned index, bool returnDefault=false) const
Handle	handle () const
IddObject	iddObject () const
	IdfObject (IddObjectType type, bool fastName=false)
	IdfObject (const IddObject &, bool fastName=false)
	IdfObject (const IdfObject &other)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
bool	isDataField (unsigned index) const
bool	isEmpty (unsigned index) const
bool	isObjectListField (unsigned index) const
bool	isValid (StrictnessLevel level) const
boost::optional< unsigned >	maxExtensibleGroups () const
boost::optional< unsigned >	maxFields () const
unsigned	minExtensibleGroups () const
unsigned	minFields () const
boost::optional< std::string >	name (bool returnDefault=false) const
std::string	nameString (bool returnDefault=false) const
unsigned	numExtensibleGroups () const
unsigned	numFields () const
unsigned	numNonextensibleFields () const
std::vector< unsigned >	objectListFields () const
bool	objectListFieldsEqual (const IdfObject &other) const
bool	objectListFieldsNonConflicting (const IdfObject &other) const
bool	operator!= (const IdfObject &other) const
std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)
bool	operator== (const IdfObject &other) const
boost::optional< T >	optionalCast () const
std::vector< std::string >	popExtensibleGroup ()
std::ostream &	print (std::ostream &os) const
std::ostream &	printField (std::ostream &os, unsigned index, bool isLastField=false) const
std::ostream &	printName (std::ostream &os, bool hasFields=true) const
IdfExtensibleGroup	pushExtensibleGroup ()
IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)
std::vector< unsigned >	requiredFields () const
void	setComment (const std::string &msg)
bool	setDouble (unsigned index, double value)
bool	setFieldComment (unsigned index, const std::string &cmnt)
bool	setInt (unsigned index, int value)
boost::optional< std::string >	setName (const std::string &newName)
bool	setQuantity (unsigned index, const Quantity &q)
bool	setString (unsigned index, const std::string &value)
bool	setUnsigned (unsigned index, unsigned value)
std::vector< T >	subsetCastVector (const std::vector< U > &original)
ValidityReport	validityReport (StrictnessLevel level, bool checkNames=true) const
virtual	~IdfObject ()

Static Public Member Functions
Static Methods
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validSolarDistributionValues ()
Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)
static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)
static int	printedFieldSpace ()

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)
Protected Member Functions inherited from openstudio::WorkspaceObject
	WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
Protected Member Functions inherited from openstudio::IdfObject
	IdfObject (std::shared_ptr< detail::IdfObject_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 includeLifeCycleCosts=false)
	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...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional < WorkspaceObject >	OptionalWorkspaceObject
typedef std::vector < WorkspaceObject >	WorkspaceObjectVector
Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair
typedef std::vector< IdfObject >	IdfObjectVector
typedef boost::optional < IdfObject >	OptionalIdfObject
Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType
Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType
Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType

Detailed Description

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>().

Constructor & Destructor Documentation

virtual openstudio::model::SimulationControl::~SimulationControl ( )

inlinevirtual

openstudio::model::SimulationControl::SimulationControl ( const Model &  model )

explicitprotected

Constructs a new SimulationControl object in the model.

Member Function Documentation

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::doPlantSizingCalculation

(

)

const

bool openstudio::model::SimulationControl::doSystemSizingCalculation

(

)

const

bool openstudio::model::SimulationControl::doZoneSizingCalculation

(

)

const

Quantity openstudio::model::SimulationControl::getLoadsConvergenceToleranceValue

(

bool

returnIP = false

)

const

Quantity openstudio::model::SimulationControl::getTemperatureConvergenceToleranceValue

(

bool

returnIP = false

)

const

boost::optional<HeatBalanceAlgorithm> openstudio::model::SimulationControl::heatBalanceAlgorithm

(

)

const

Returns child HeatBalanceAlgorithm if it exists.

static IddObjectType openstudio::model::SimulationControl::iddObjectType ( )

static

boost::optional<InsideSurfaceConvectionAlgorithm> openstudio::model::SimulationControl::insideSurfaceConvectionAlgorithm

(

)

const

Returns child InsideSurfaceConvectionAlgorithm if it exists.

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::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::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::resetDoPlantSizingCalculation

(

)

void openstudio::model::SimulationControl::resetDoSystemSizingCalculation

(

)

void openstudio::model::SimulationControl::resetDoZoneSizingCalculation

(

)

void openstudio::model::SimulationControl::resetLoadsConvergenceToleranceValue

(

)

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

void openstudio::model::SimulationControl::setDoPlantSizingCalculation

(

bool

doPlantSizingCalculation

)

void openstudio::model::SimulationControl::setDoSystemSizingCalculation

(

bool

doSystemSizingCalculation

)

void openstudio::model::SimulationControl::setDoZoneSizingCalculation

(

bool

doZoneSizingCalculation

)

bool openstudio::model::SimulationControl::setLoadsConvergenceToleranceValue

(

double

loadsConvergenceToleranceValue

)

bool openstudio::model::SimulationControl::setLoadsConvergenceToleranceValue

(

const Quantity &

loadsConvergenceToleranceValue

)

bool openstudio::model::SimulationControl::setMaximumNumberofWarmupDays

(

int

maximumNumberofWarmupDays

)

bool openstudio::model::SimulationControl::setMinimumNumberofWarmupDays

(

int

minimumNumberofWarmupDays

)

void openstudio::model::SimulationControl::setRunSimulationforSizingPeriods

(

bool

runSimulationforSizingPeriods

)

void openstudio::model::SimulationControl::setRunSimulationforWeatherFileRunPeriods

(

bool

runSimulationforWeatherFileRunPeriods

)

bool openstudio::model::SimulationControl::setSolarDistribution

(

std::string

solarDistribution

)

bool openstudio::model::SimulationControl::setTemperatureConvergenceToleranceValue

(

double

temperatureConvergenceToleranceValue

)

bool openstudio::model::SimulationControl::setTemperatureConvergenceToleranceValue

(

const Quantity &

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 std::vector<std::string> openstudio::model::SimulationControl::validSolarDistributionValues ( )

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.

Friends And Related Function Documentation

typedef boost::optional<SimulationControl> OptionalSimulationControl

related