#include <ThermalZone.hpp>

Inheritance diagram for openstudio::model::ThermalZone:

Public Member Functions
Getters
int	multiplier () const

bool	isMultiplierDefaulted () const

boost::optional< double >	ceilingHeight () const

bool	isCeilingHeightDefaulted () const

bool	isCeilingHeightAutocalculated () const

boost::optional< double >	volume () const

bool	isVolumeDefaulted () const

bool	isVolumeAutocalculated () const

boost::optional< std::string >	zoneInsideConvectionAlgorithm () const

boost::optional< std::string >	zoneOutsideConvectionAlgorithm () const

std::string	zoneConditioningEquipmentListName () const

boost::optional< Thermostat >	thermostat () const

boost::optional< ThermostatSetpointDualSetpoint >	thermostatSetpointDualSetpoint () const

boost::optional< ZoneControlHumidistat >	zoneControlHumidistat () const

boost::optional< ZoneControlContaminantController >	zoneControlContaminantController () const

double	fractionofZoneControlledbyPrimaryDaylightingControl () const

bool	isFractionofZoneControlledbyPrimaryDaylightingControlDefaulted () const

double	fractionofZoneControlledbySecondaryDaylightingControl () const

bool	isFractionofZoneControlledbySecondaryDaylightingControlDefaulted () const

SizingZone	sizingZone () const

ZonePropertyUserViewFactorsBySurfaceName	getZonePropertyUserViewFactorsBySurfaceName () const

Setters
bool	setMultiplier (int multiplier)

void	resetMultiplier ()

bool	setCeilingHeight (boost::optional< double > ceilingHeight)

bool	setCeilingHeight (double ceilingHeight)

void	resetCeilingHeight ()

void	autocalculateCeilingHeight ()

bool	setVolume (boost::optional< double > volume)

bool	setVolume (double volume)

void	resetVolume ()

void	autocalculateVolume ()

bool	setZoneInsideConvectionAlgorithm (boost::optional< std::string > zoneInsideConvectionAlgorithm)

bool	setZoneInsideConvectionAlgorithm (const std::string &zoneInsideConvectionAlgorithm)

void	resetZoneInsideConvectionAlgorithm ()

bool	setZoneOutsideConvectionAlgorithm (boost::optional< std::string > zoneOutsideConvectionAlgorithm)

bool	setZoneOutsideConvectionAlgorithm (const std::string &zoneOutsideConvectionAlgorithm)

void	resetZoneOutsideConvectionAlgorithm ()

bool	setZoneConditioningEquipmentListName (const std::string &zoneConditioningEquipmentListName)

bool	setThermostatSetpointDualSetpoint (const ThermostatSetpointDualSetpoint &thermostat)

void	resetThermostatSetpointDualSetpoint ()

bool	setThermostat (const Thermostat &thermostat)

void	resetThermostat ()

bool	setZoneControlHumidistat (const ZoneControlHumidistat &humidistat)

void	resetZoneControlHumidistat ()

bool	setZoneControlContaminantController (const ZoneControlContaminantController &contaminantController)

void	resetZoneControlContaminantController ()

bool	setFractionofZoneControlledbyPrimaryDaylightingControl (double fractionofZoneControlledbyPrimaryDaylightingControl)

void	resetFractionofZoneControlledbyPrimaryDaylightingControl ()

bool	setFractionofZoneControlledbySecondaryDaylightingControl (double fractionofZoneControlledbySecondaryDaylightingControl)

void	resetFractionofZoneControlledbySecondaryDaylightingControl ()

Public Member Functions inherited from openstudio::model::HVACComponent
bool	addToNode (Node &node)
	Adds this object to a new system node and returns a boolean indicating if the addition was successful.

bool	addToSplitter (Splitter &splitter)
	Adds this object to a splitter by creating a new branch.

boost::optional< AirLoopHVAC >	airLoopHVAC () const
	Returns the optional AirLoopHVAC object that the HVAC component is attached to.

boost::optional< AirLoopHVACOutdoorAirSystem >	airLoopHVACOutdoorAirSystem () const
	Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to.

std::vector< AppGFuelType >	appGHeatingFuelTypes () const

void	applySizingValues ()

void	autosize ()
	Returns the optional ModelObject connected to this object's port.

ComponentType	componentType () const

boost::optional< HVACComponent >	containingHVACComponent () const
	EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components.

boost::optional< StraightComponent >	containingStraightComponent () const

boost::optional< ZoneHVACComponent >	containingZoneHVACComponent () const
	Returns any ZoneHVACComponent that contains this HVACComponent.

std::vector< FuelType >	coolingFuelTypes () const

void	disconnect ()
	Removes all connections to other HVACComponent objects.

std::vector< FuelType >	heatingFuelTypes () const

	HVACComponent (const HVACComponent &other)=default

	HVACComponent (HVACComponent &&other)=default

bool	isRemovable () const
	Indicates if the HVACComponent can be removed from the model.

boost::optional< Loop >	loop () const
	Returns the optional Loop object that the HVAC component is attached to.

HVACComponent &	operator= (const HVACComponent &)=default

HVACComponent &	operator= (HVACComponent &&)=default

boost::optional< PlantLoop >	plantLoop () const
	Returns the optional PlantLoop object that the HVAC component is attached to.

std::vector< IdfObject >	remove ()
	Removes the HVACComponent from the model only if isRemovable() return true.

virtual	~HVACComponent () override=default

Public Member Functions inherited from openstudio::model::ParentObject
ParentObject &	operator= (const ParentObject &)=default

ParentObject &	operator= (ParentObject &&)=default

	ParentObject (const ParentObject &other)=default

	ParentObject (ParentObject &&other)=default

virtual	~ParentObject () override=default

std::vector< ModelObject >	children () const
	Return direct child objects in the Model.

std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types.

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject () override=default

	ModelObject (const ModelObject &other)=default

	ModelObject (ModelObject &&other)=default

ModelObject &	operator= (const ModelObject &)=default

ModelObject &	operator= (ModelObject &&)=default

ModelObject	clone () const
	Creates a deep copy of this object, placing it in this object's model().

ModelObject	clone (Model model) const
	Creates a deep copy of this object, placing it in model.

Component	createComponent () const
	Method for creating sharable Model snippets.

Model	model () const
	Returns the Model that contains this object.

boost::optional< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one.

std::vector< ResourceObject >	resources () const
	Get the resources directly used by this ModelObject.

template<typename T >
std::vector< T >	getModelObjectSources () const
	Get all objects of type T that point to this object.

template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
	Get all objects of type T that point to this object.

template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
	Get the object of type T pointed to by this object from field index.

template<typename T >
std::vector< T >	getModelObjectTargets () const
	Get all objects of type T to which this object points.

const std::vector< std::string > &	outputVariableNames () const
	Get all output variables names that could be associated with this object.

std::vector< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data.

boost::optional< openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object.

std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object.

std::vector< IdfObject >	removeLifeCycleCosts ()
	Removes all LifeCycleCosts that refer to this object.

IddObjectType	iddObjectType () const
	This is a virtual function that will tell you the type of iddObject you are dealing with.

AdditionalProperties	additionalProperties () const
	Returns this object's additional properties, constructing a new object if necessary.

bool	hasAdditionalProperties () const
	Returns true if this object has additional properties.

std::vector< IdfObject >	removeAdditionalProperties ()
	Removes all additional properties that refer to this object.

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

bool	operator< (const ModelObject &right) const

bool	operator== (const ModelObject &other) const
	equality test

bool	operator!= (const ModelObject &other) const
	inequality test

std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object.

boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
	Gets the autosized component value from the sql file.

virtual std::vector< EMSActuatorNames >	emsActuatorNames () const
	Return the names of the available ems actuators.

virtual std::vector< std::string >	emsInternalVariableNames () const
	Return the names of the available ems internal variables.

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

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

std::vector< std::string >	canBeTarget () const

std::vector< std::string >	canBeTarget () const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

IdfObject	idfObject ()

IdfObject	idfObject () const

bool	initialized () const

bool	initialized () const

bool	isSource () const

bool	isSource () const

bool	isTarget () const

bool	isTarget () const

unsigned	numSources () const

unsigned	numSources () const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	operator< (const WorkspaceObject &right) const

bool	operator< (const WorkspaceObject &right) const

std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

std::vector< openstudio::IdfObject >	remove ()

std::vector< openstudio::IdfObject >	remove ()

bool	setPointer (unsigned index, const Handle &targetHandle)

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

Workspace	workspace () const

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

virtual	~WorkspaceObject () override=default

virtual	~WorkspaceObject () override=default

Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const

std::string	briefDescription () const

T	cast () const

std::vector< T >	castVector (const std::vector< U > &objects)

std::vector< std::vector< std::string > >	clearExtensibleGroups ()

std::vector< std::vector< std::string > >	clearExtensibleGroups ()

IdfObject	clone (bool keepHandle=false) const

IdfObject	clone (bool keepHandle=false) const

std::string	comment () const

std::string	comment () const

boost::optional< std::string >	createName (bool overwrite=true)

boost::optional< std::string >	createName (bool overwrite=true)

std::vector< unsigned >	dataFields () const

std::vector< unsigned >	dataFields () const

bool	dataFieldsEqual (const IdfObject &other) const

bool	dataFieldsEqual (const IdfObject &other) const

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< IdfExtensibleGroup >	extensibleGroups () const

std::vector< IdfExtensibleGroup >	extensibleGroups () const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

std::vector< Handle >	getHandles (const std::vector< T > &objects)

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=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< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

Handle	handle () const

Handle	handle () const

IddObject	iddObject () const

IddObject	iddObject () const

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IdfObject &other)

	IdfObject (const IdfObject &other)

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (IdfObject &&other) noexcept

	IdfObject (IdfObject &&other) noexcept

void	initializeFields (bool fill_default=false)

void	initializeFields (bool fill_default=false)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

bool	isDataField (unsigned index) const

bool	isDataField (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxFields () const

boost::optional< unsigned >	maxFields () const

unsigned	minExtensibleGroups () const

unsigned	minExtensibleGroups () const

unsigned	minFields () const

unsigned	minFields () const

boost::optional< std::string >	name (bool returnDefault=false) const

boost::optional< std::string >	name (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

unsigned	numExtensibleGroups () const

unsigned	numExtensibleGroups () const

unsigned	numFields () const

unsigned	numFields () const

unsigned	numNonextensibleFields () const

unsigned	numNonextensibleFields () const

std::vector< unsigned >	objectListFields () const

std::vector< unsigned >	objectListFields () const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (IdfObject &&other) noexcept

IdfObject &	operator= (IdfObject &&other) noexcept

bool	operator== (const IdfObject &other) const

bool	operator== (const IdfObject &other) const

boost::optional< T >	optionalCast () const

std::vector< std::string >	popExtensibleGroup ()

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

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

std::vector< unsigned >	requiredFields () const

std::vector< unsigned >	requiredFields () const

void	setComment (const std::string &msg)

void	setComment (const std::string &msg)

bool	setDouble (unsigned index, double value)

bool	setDouble (unsigned index, double value)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setInt (unsigned index, int value)

bool	setInt (unsigned index, int value)

boost::optional< std::string >	setName (const std::string &newName)

boost::optional< std::string >	setName (const std::string &newName)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setString (unsigned index, const std::string &value)

bool	setString (unsigned index, const std::string &value)

bool	setUnsigned (unsigned index, unsigned value)

bool	setUnsigned (unsigned index, unsigned value)

std::vector< T >	subsetCastVector (const std::vector< U > &original)

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

virtual	~IdfObject ()=default

virtual	~IdfObject ()=default

Related Symbols
(Note that these are not member symbols.)
using	OptionalThermalZone = boost::optional<ThermalZone>

using	ThermalZoneVector = std::vector<ThermalZone>

Related Symbols 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 .

std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects .

Related Symbols inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object.

Constructors and Destructors
	ThermalZone (const Model &model)

virtual	~ThermalZone () override=default

	ThermalZone (const ThermalZone &other)=default

	ThermalZone (ThermalZone &&other)=default

ThermalZone &	operator= (const ThermalZone &)=default

ThermalZone &	operator= (ThermalZone &&)=default

static IddObjectType	iddObjectType ()

static std::vector< std::string >	validZoneInsideConvectionAlgorithmValues ()

static std::vector< std::string >	validZoneOutsideConvectionAlgorithmValues ()

Other
unsigned	returnAirPort () const

unsigned	zoneAirPort () const

OptionalModelObject	returnAirModelObject () const

std::vector< ModelObject >	returnAirModelObjects () const

Node	zoneAirNode () const

boost::optional< DaylightingControl >	primaryDaylightingControl () const

bool	setPrimaryDaylightingControl (const DaylightingControl &daylightingControl)

void	resetPrimaryDaylightingControl ()

boost::optional< DaylightingControl >	secondaryDaylightingControl () const

bool	setSecondaryDaylightingControl (const DaylightingControl &daylightingControl)

void	resetSecondaryDaylightingControl ()

boost::optional< IlluminanceMap >	illuminanceMap () const

bool	setIlluminanceMap (const IlluminanceMap &illuminanceMap)

void	resetIlluminanceMap ()

void	checkDaylightingControlsAndIlluminanceMaps ()

boost::optional< Schedule >	daylightingControlsAvailabilitySchedule () const

bool	setDaylightingControlsAvailabilitySchedule (Schedule &schedule)

void	resetDaylightingControlsAvailabilitySchedule ()

boost::optional< RenderingColor >	renderingColor () const
	Returns the rendering color.

bool	setRenderingColor (const RenderingColor &renderingColor)
	Sets the rendering color.

void	resetRenderingColor ()
	Resets the rendering color.

std::vector< ModelObject >	equipment () const

boost::optional< HVACComponent >	airLoopHVACTerminal () const

std::vector< HVACComponent >	airLoopHVACTerminals () const

std::vector< Space >	spaces () const
	returns all spaces in this thermal zone

std::vector< Space >	spacesWithDesignSpecificationOutdoorAir () const
	return all spaces that have a design specification outdoor air assigned

double	floorArea () const
	Accumulates the floorArea (m^2) of spaces.

double	exteriorSurfaceArea () const
	Accumulates the exterior surface area (m^2) of spaces.

double	exteriorWallArea () const
	Accumulates the exterior wall area (m^2) of spaces.

double	airVolume () const
	Accumulates the air volume (m^3) of spaces.

double	numberOfPeople () const
	Returns the number of people in the thermal zone.

double	peoplePerFloorArea () const
	Returns the number of people per floor area (people/m^2).

double	floorAreaPerPerson () const
	Returns the total floor area per person in this thermal zone (m^2/person).

double	lightingPower () const
	Returns the lighting power (W) in this thermal zone.

double	lightingPowerPerFloorArea () const
	Returns the lighting power density (W/m^2) of this thermal zone.

double	lightingPowerPerPerson () const
	Returns the lighting power per person (W/person) of this thermal zone.

double	electricEquipmentPower () const
	Returns the electric equipment power (W) of this thermal zone.

double	electricEquipmentPowerPerFloorArea () const
	Returns the electric equipment power density (W/m^2) of this thermal zone.

double	electricEquipmentPowerPerPerson () const
	Returns the electric equipment power per person (W/person) of this thermal zone.

double	gasEquipmentPower () const
	Returns the gas equipment power (W) of this thermal zone.

double	gasEquipmentPowerPerFloorArea () const
	Returns the gas equipment power density (W/m^2) of this thermal zone.

double	gasEquipmentPowerPerPerson () const
	Returns the gas equipment power per person (W/person) of this thermal zone.

double	infiltrationDesignFlowRate () const
	Returns the infiltration design flow rate (m^3/s) in this thermal zone.

double	infiltrationDesignFlowPerSpaceFloorArea () const
	Returns the infiltration design flow per space floor area (m^3/m^2*s) in this thermal zone.

double	infiltrationDesignFlowPerExteriorSurfaceArea () const
	Returns the infiltration design flow per exterior surface area (m^3/m^2*s) in this thermal zone.

double	infiltrationDesignFlowPerExteriorWallArea () const
	Returns the infiltration design flow per exterior wall area (m^3/m^2*s) in this thermal zone.

double	infiltrationDesignAirChangesPerHour () const
	Returns the infiltration design air changes per hour (1/h) in this thermal zone.

boost::optional< std::string >	isConditioned () const
	Determines if this zone is conditioned, based on the SqlFile output.

boost::optional< Space >	combineSpaces ()
	Combines all spaces referencing this zone into a single space referencing this zone.

void	disconnect ()
	Removes connections to all other HVACComponent objects.

bool	isRemovable () const
	ThermalZone must be disconnected from all loops to be removable.

bool	useIdealAirLoads () const
	Indicates if the zone will use EnergyPlus ideal air loads.

bool	setUseIdealAirLoads (bool useIdealAirLoads)
	Adds or removes ideal air loads for the zone.

bool	addToNode (Node &node)

bool	multiAddToNode (Node &node)
	This method is the same as addToNode, except existing air loop connections will not be removed.

PortList	returnPortList () const

PortList	inletPortList () const

PortList	exhaustPortList () const

bool	addEquipment (const ModelObject &equipment)
	Add new equipment setting the heating and cooling priorities to the next available priority level.

bool	removeEquipment (const ModelObject &equipment)
	Remove equipment from the EquipmentList.

std::string	loadDistributionScheme () const

bool	setLoadDistributionScheme (const std::string &scheme)

bool	setCoolingPriority (const ModelObject &equipment, unsigned priority)
	Set cooling priority of equipment.

bool	setHeatingPriority (const ModelObject &equipment, unsigned priority)
	Set heating priority of equipment.

std::vector< ModelObject >	equipmentInHeatingOrder () const
	Return all equipment.

std::vector< ModelObject >	equipmentInCoolingOrder () const
	Return all equipment.

boost::optional< double >	sequentialCoolingFraction (const ModelObject &equipment) const
	Return the Sequential Cooling Fraction of equipment, if it's a ScheduleConstant.

boost::optional< Schedule >	sequentialCoolingFractionSchedule (const ModelObject &equipment) const
	Return the Sequential Cooling Fraction Schedule of equipment.

boost::optional< double >	sequentialHeatingFraction (const ModelObject &equipment) const
	Return the Sequential Heating Fraction of equipment, if it's a ScheduleConstant Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'.

boost::optional< Schedule >	sequentialHeatingFractionSchedule (const ModelObject &equipment) const
	Return the Sequential Heating Fraction Schedule of equipment.

bool	setSequentialCoolingFraction (const ModelObject &equipment, double fraction)
	Set the Sequential Cooling Fraction of equipment, creates a ScheduleConstant for your convenience.

bool	setSequentialCoolingFractionSchedule (const ModelObject &equipment, Schedule &schedule)
	Set the Sequential Cooling Fraction Schedule of equipment.

bool	setSequentialHeatingFraction (const ModelObject &equipment, double fraction)
	Set the Sequential Heating Fraction of equipment, creates a ScheduleConstant for your convenience.

bool	setSequentialHeatingFractionSchedule (const ModelObject &equipment, Schedule &schedule)
	Set the Sequential Heating Fraction Schedule of equipment.

bool	isPlenum () const
	Return true if the ThermalZone is attached to an AirLoopHVACSupplyPlenum or AirLoopHVACReturnPlenum.

bool	canBePlenum () const
	Return true if the ThermalZone is unconditioned and available to be used as a plenum This means the zone is not attached to an AirLoopHVAC structure as a conditioned zone and there is no zone equipment.

bool	setSupplyPlenum (const ThermalZone &plenumZone)
	Establish plenumZone as the supply plenum for this ThermalZone.

bool	setSupplyPlenum (const ThermalZone &plenumZone, unsigned branchIndex)
	Overload of setSupplyPlenum() This variation can account for dual duct systems, branchIndex can be 0 or 1 indicating which branch of a dual duct system to attach to.

void	removeSupplyPlenum ()
	Remove any supply plenum serving this zone, associated with the AirLoopHVAC returned by ThermalZone::airLoopHVAC().

void	removeSupplyPlenum (const AirLoopHVAC &airloop)
	Remove any supply plenum associated with the given AirLoopHVAC instance.

void	removeSupplyPlenum (unsigned branchIndex)
	Overload of removeSupplyPlenum() This variation can account for dual duct systems, branchIndex can be 0 or 1 indicating which branch of a dual duct system to attach to.

void	removeSupplyPlenum (const AirLoopHVAC &airloop, unsigned branchIndex)
	Remove any supply plenum associated with the given AirLoopHVAC instance, and branchIndex in a dual duct system.

bool	setReturnPlenum (const ThermalZone &plenumZone)
	Establish plenumZone as the return plenum for this ThermalZone.

bool	setReturnPlenum (const ThermalZone &plenumZone, AirLoopHVAC &airLoop)
	setReturnPlenum for the specified air loop.

void	removeReturnPlenum ()
	Remove any return plenum serving this zone.

void	removeReturnPlenum (AirLoopHVAC &airLoop)
	Remove any return plenum serving this zone.

std::vector< ZoneMixing >	zoneMixing () const
	Returns all ZoneMixing objects associated with this zone, includes supply and exhaust mixing objects.

std::vector< ZoneMixing >	supplyZoneMixing () const
	Returns all ZoneMixing objects which supply air to this zone.

std::vector< ZoneMixing >	exhaustZoneMixing () const
	Returns all ZoneMixing objects which exhaust air from this zone.

AirflowNetworkZone	getAirflowNetworkZone ()
	Creates an AirflowNetworkZone object if an object is not already attached.

boost::optional< AirflowNetworkZone >	airflowNetworkZone () const
	Returns the attached AirflowNetworkZone if there is one.

std::vector< AirLoopHVAC >	airLoopHVACs () const

boost::optional< double >	getAutosizedValueFromZoneSizes (const std::string &columnName, const std::string &loadType) const

boost::optional< double >	autosizedMinimumOutdoorAirFlowRate () const

boost::optional< double >	autosizedCoolingDesignAirFlowRate () const

boost::optional< double >	autosizedHeatingDesignAirFlowRate () const

boost::optional< double >	autosizedCoolingDesignLoad () const

boost::optional< double >	autosizedDesignAirFlowRate () const

boost::optional< double >	autosizedHeatingDesignLoad () const

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

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 Types inherited from openstudio::model::HVACComponent
using	ImplType = detail::HVACComponent_Impl

Protected Types inherited from openstudio::model::ModelObject
using	ImplType = detail::ModelObject_Impl

Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType

Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType

Protected Member Functions inherited from openstudio::model::HVACComponent
	HVACComponent (IddObjectType type, const Model &model)

	HVACComponent (std::shared_ptr< ImplType > impl)

Protected Member Functions inherited from openstudio::model::ParentObject
	ParentObject (IddObjectType type, const Model &model)
	Constructs a new ParentObject object in the model.

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)

Detailed Description

ThermalZone is a HVACComponent that wraps the OpenStudio IDD object 'OS_ThermalZone'.

Constructor & Destructor Documentation

◆ ThermalZone() [1/3]

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

explicit

◆ ~ThermalZone()

virtual openstudio::model::ThermalZone::~ThermalZone ( )

overridevirtualdefault

◆ ThermalZone() [2/3]

openstudio::model::ThermalZone::ThermalZone ( const ThermalZone & other )

default

◆ ThermalZone() [3/3]

openstudio::model::ThermalZone::ThermalZone ( ThermalZone && other )

default

Member Function Documentation

◆ addEquipment()

bool openstudio::model::ThermalZone::addEquipment ( const ModelObject & equipment )

Add new equipment setting the heating and cooling priorities to the next available priority level.

Air terminals associated with AirLoopHVAC will be moved to first priority. This method is relatively dumb. It will add any model object to the list even if it is not hvac equipment. That might change in the future.

◆ addToNode()

bool openstudio::model::ThermalZone::addToNode ( Node & node )

◆ airflowNetworkZone()

boost::optional< AirflowNetworkZone > openstudio::model::ThermalZone::airflowNetworkZone ( ) const

Returns the attached AirflowNetworkZone if there is one.

◆ airLoopHVACs()

std::vector< AirLoopHVAC > openstudio::model::ThermalZone::airLoopHVACs ( ) const

◆ airLoopHVACTerminal()

boost::optional< HVACComponent > openstudio::model::ThermalZone::airLoopHVACTerminal ( ) const

◆ airLoopHVACTerminals()

std::vector< HVACComponent > openstudio::model::ThermalZone::airLoopHVACTerminals ( ) const

◆ airVolume()

double openstudio::model::ThermalZone::airVolume ( ) const

Accumulates the air volume (m^3) of spaces.

Does not include space multiplier.

◆ autocalculateCeilingHeight()

void openstudio::model::ThermalZone::autocalculateCeilingHeight ( )

◆ autocalculateVolume()

void openstudio::model::ThermalZone::autocalculateVolume ( )

◆ autosizedCoolingDesignAirFlowRate()

boost::optional< double > openstudio::model::ThermalZone::autosizedCoolingDesignAirFlowRate ( ) const

◆ autosizedCoolingDesignLoad()

boost::optional< double > openstudio::model::ThermalZone::autosizedCoolingDesignLoad ( ) const

◆ autosizedDesignAirFlowRate()

boost::optional< double > openstudio::model::ThermalZone::autosizedDesignAirFlowRate ( ) const

◆ autosizedHeatingDesignAirFlowRate()

boost::optional< double > openstudio::model::ThermalZone::autosizedHeatingDesignAirFlowRate ( ) const

◆ autosizedHeatingDesignLoad()

boost::optional< double > openstudio::model::ThermalZone::autosizedHeatingDesignLoad ( ) const

◆ autosizedMinimumOutdoorAirFlowRate()

boost::optional< double > openstudio::model::ThermalZone::autosizedMinimumOutdoorAirFlowRate ( ) const

◆ canBePlenum()

bool openstudio::model::ThermalZone::canBePlenum ( ) const

Return true if the ThermalZone is unconditioned and available to be used as a plenum This means the zone is not attached to an AirLoopHVAC structure as a conditioned zone and there is no zone equipment.

◆ ceilingHeight()

boost::optional< double > openstudio::model::ThermalZone::ceilingHeight ( ) const

◆ checkDaylightingControlsAndIlluminanceMaps()

void openstudio::model::ThermalZone::checkDaylightingControlsAndIlluminanceMaps ( )

◆ combineSpaces()

boost::optional< Space > openstudio::model::ThermalZone::combineSpaces ( )

Combines all spaces referencing this zone into a single space referencing this zone.

If this zone has no spaces referencing it, then an uninitialized optional space is returned. If this zone has one space referencing it, then that space is returned. If this zone is referenced by more than one space, then geometry from all spaces is added to a single zone. The space origin is at the minimum x, y, z coordinate of all space origins, direction of relative north is preserved if same for all spaces. If all spaces reference the same building story then that is preserved, otherwise it is cleared. If all spaces reference the same space type then that is preserved, otherwise space loads from the space type are applied to the new space directly. Direct child space loads are converted to absolute levels. Constructions and schedules are hard applied to all child surfaces and loads. Surfaces referencing other surfaces within the space are converted to interior partitions.

◆ daylightingControlsAvailabilitySchedule()

boost::optional< Schedule > openstudio::model::ThermalZone::daylightingControlsAvailabilitySchedule ( ) const

◆ disconnect()

void openstudio::model::ThermalZone::disconnect ( )

Removes connections to all other HVACComponent objects.

◆ electricEquipmentPower()

double openstudio::model::ThermalZone::electricEquipmentPower ( ) const

Returns the electric equipment power (W) of this thermal zone.

Does not include space multiplier. Does include equipment multiplier.

◆ electricEquipmentPowerPerFloorArea()

double openstudio::model::ThermalZone::electricEquipmentPowerPerFloorArea ( ) const

Returns the electric equipment power density (W/m^2) of this thermal zone.

Does not include space multiplier. Does include equipment multiplier.

◆ electricEquipmentPowerPerPerson()

double openstudio::model::ThermalZone::electricEquipmentPowerPerPerson ( ) const

Returns the electric equipment power per person (W/person) of this thermal zone.

Does not include space multiplier. Does include equipment multiplier.

◆ equipment()

std::vector< ModelObject > openstudio::model::ThermalZone::equipment ( ) const

◆ equipmentInCoolingOrder()

std::vector< ModelObject > openstudio::model::ThermalZone::equipmentInCoolingOrder ( ) const

Return all equipment.

Order is determined by cooling priority

◆ equipmentInHeatingOrder()

std::vector< ModelObject > openstudio::model::ThermalZone::equipmentInHeatingOrder ( ) const

Return all equipment.

Order is determined by heating priority

◆ exhaustPortList()

PortList openstudio::model::ThermalZone::exhaustPortList ( ) const

◆ exhaustZoneMixing()

std::vector< ZoneMixing > openstudio::model::ThermalZone::exhaustZoneMixing ( ) const

Returns all ZoneMixing objects which exhaust air from this zone.

◆ exteriorSurfaceArea()

double openstudio::model::ThermalZone::exteriorSurfaceArea ( ) const

Accumulates the exterior surface area (m^2) of spaces.

Does not include space multiplier.

◆ exteriorWallArea()

double openstudio::model::ThermalZone::exteriorWallArea ( ) const

Accumulates the exterior wall area (m^2) of spaces.

Does not include space multiplier.

◆ floorArea()

double openstudio::model::ThermalZone::floorArea ( ) const

Accumulates the floorArea (m^2) of spaces.

Does not include space multiplier.

◆ floorAreaPerPerson()

double openstudio::model::ThermalZone::floorAreaPerPerson ( ) const

Returns the total floor area per person in this thermal zone (m^2/person).

Does not include space multiplier. Does include people multiplier.

◆ fractionofZoneControlledbyPrimaryDaylightingControl()

double openstudio::model::ThermalZone::fractionofZoneControlledbyPrimaryDaylightingControl ( ) const

◆ fractionofZoneControlledbySecondaryDaylightingControl()

double openstudio::model::ThermalZone::fractionofZoneControlledbySecondaryDaylightingControl ( ) const

◆ gasEquipmentPower()

double openstudio::model::ThermalZone::gasEquipmentPower ( ) const

Returns the gas equipment power (W) of this thermal zone.

Does not include space multiplier. Does include equipment multiplier.

◆ gasEquipmentPowerPerFloorArea()

double openstudio::model::ThermalZone::gasEquipmentPowerPerFloorArea ( ) const

Returns the gas equipment power density (W/m^2) of this thermal zone.

Does not include space multiplier. Does include equipment multiplier.

◆ gasEquipmentPowerPerPerson()

double openstudio::model::ThermalZone::gasEquipmentPowerPerPerson ( ) const

Returns the gas equipment power per person (W/person) of this thermal zone.

Does not include space multiplier. Does include equipment multiplier.

◆ getAirflowNetworkZone()

AirflowNetworkZone openstudio::model::ThermalZone::getAirflowNetworkZone ( )

Creates an AirflowNetworkZone object if an object is not already attached.

◆ getAutosizedValueFromZoneSizes()

boost::optional< double > openstudio::model::ThermalZone::getAutosizedValueFromZoneSizes	(	const std::string &	columnName,
		const std::string &	loadType ) const

◆ getZonePropertyUserViewFactorsBySurfaceName()

ZonePropertyUserViewFactorsBySurfaceName openstudio::model::ThermalZone::getZonePropertyUserViewFactorsBySurfaceName ( ) const

◆ iddObjectType()

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

static

◆ illuminanceMap()

boost::optional< IlluminanceMap > openstudio::model::ThermalZone::illuminanceMap ( ) const

◆ infiltrationDesignAirChangesPerHour()

double openstudio::model::ThermalZone::infiltrationDesignAirChangesPerHour ( ) const

Returns the infiltration design air changes per hour (1/h) in this thermal zone.

Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects. Does not include space multiplier.

◆ infiltrationDesignFlowPerExteriorSurfaceArea()

double openstudio::model::ThermalZone::infiltrationDesignFlowPerExteriorSurfaceArea ( ) const

Returns the infiltration design flow per exterior surface area (m^3/m^2*s) in this thermal zone.

Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects. Does not include space multiplier.

◆ infiltrationDesignFlowPerExteriorWallArea()

double openstudio::model::ThermalZone::infiltrationDesignFlowPerExteriorWallArea ( ) const

Returns the infiltration design flow per exterior wall area (m^3/m^2*s) in this thermal zone.

Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects. Does not include space multiplier.

◆ infiltrationDesignFlowPerSpaceFloorArea()

double openstudio::model::ThermalZone::infiltrationDesignFlowPerSpaceFloorArea ( ) const

Returns the infiltration design flow per space floor area (m^3/m^2*s) in this thermal zone.

Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects. Does not include space multiplier.

◆ infiltrationDesignFlowRate()

double openstudio::model::ThermalZone::infiltrationDesignFlowRate ( ) const

Returns the infiltration design flow rate (m^3/s) in this thermal zone.

Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects. Does not include space multiplier.

◆ inletPortList()

PortList openstudio::model::ThermalZone::inletPortList ( ) const

◆ isCeilingHeightAutocalculated()

bool openstudio::model::ThermalZone::isCeilingHeightAutocalculated ( ) const

◆ isCeilingHeightDefaulted()

bool openstudio::model::ThermalZone::isCeilingHeightDefaulted ( ) const

◆ isConditioned()

boost::optional< std::string > openstudio::model::ThermalZone::isConditioned ( ) const

Determines if this zone is conditioned, based on the SqlFile output.

Returns 'Yes' if zone is conditioned.

◆ isFractionofZoneControlledbyPrimaryDaylightingControlDefaulted()

bool openstudio::model::ThermalZone::isFractionofZoneControlledbyPrimaryDaylightingControlDefaulted ( ) const

◆ isFractionofZoneControlledbySecondaryDaylightingControlDefaulted()

bool openstudio::model::ThermalZone::isFractionofZoneControlledbySecondaryDaylightingControlDefaulted ( ) const

◆ isMultiplierDefaulted()

bool openstudio::model::ThermalZone::isMultiplierDefaulted ( ) const

◆ isPlenum()

bool openstudio::model::ThermalZone::isPlenum ( ) const

Return true if the ThermalZone is attached to an AirLoopHVACSupplyPlenum or AirLoopHVACReturnPlenum.

◆ isRemovable()

bool openstudio::model::ThermalZone::isRemovable ( ) const

ThermalZone must be disconnected from all loops to be removable.

◆ isVolumeAutocalculated()

bool openstudio::model::ThermalZone::isVolumeAutocalculated ( ) const

◆ isVolumeDefaulted()

bool openstudio::model::ThermalZone::isVolumeDefaulted ( ) const

◆ lightingPower()

double openstudio::model::ThermalZone::lightingPower ( ) const

Returns the lighting power (W) in this thermal zone.

Does not include space multiplier. Does include lighting multiplier.

◆ lightingPowerPerFloorArea()

double openstudio::model::ThermalZone::lightingPowerPerFloorArea ( ) const

Returns the lighting power density (W/m^2) of this thermal zone.

Does not include space multiplier. Does include lighting multiplier.

◆ lightingPowerPerPerson()

double openstudio::model::ThermalZone::lightingPowerPerPerson ( ) const

Returns the lighting power per person (W/person) of this thermal zone.

Does not include space multiplier. Does include lighting multiplier.

◆ loadDistributionScheme()

std::string openstudio::model::ThermalZone::loadDistributionScheme ( ) const

◆ multiAddToNode()

bool openstudio::model::ThermalZone::multiAddToNode ( Node & node )

This method is the same as addToNode, except existing air loop connections will not be removed.

This is because EnergyPlus gained the ability to attach multiple air loops.

◆ multiplier()

int openstudio::model::ThermalZone::multiplier ( ) const

◆ numberOfPeople()

double openstudio::model::ThermalZone::numberOfPeople ( ) const

Returns the number of people in the thermal zone.

Does not include space multiplier. Does include people multiplier.

◆ operator=() [1/2]

ThermalZone & openstudio::model::ThermalZone::operator= ( const ThermalZone & )

default

◆ operator=() [2/2]

ThermalZone & openstudio::model::ThermalZone::operator= ( ThermalZone && )

default

◆ peoplePerFloorArea()

double openstudio::model::ThermalZone::peoplePerFloorArea ( ) const

Returns the number of people per floor area (people/m^2).

Does not include space multiplier. Does include people multiplier.

◆ primaryDaylightingControl()

boost::optional< DaylightingControl > openstudio::model::ThermalZone::primaryDaylightingControl ( ) const

◆ removeEquipment()

bool openstudio::model::ThermalZone::removeEquipment ( const ModelObject & equipment )

Remove equipment from the EquipmentList.

This will not remove the equipment from the model or disconnect any node connections. Use only if you know what you are doing.

◆ removeReturnPlenum() [1/2]

void openstudio::model::ThermalZone::removeReturnPlenum ( )

Remove any return plenum serving this zone.

◆ removeReturnPlenum() [2/2]

void openstudio::model::ThermalZone::removeReturnPlenum ( AirLoopHVAC & airLoop )

Remove any return plenum serving this zone.

◆ removeSupplyPlenum() [1/4]

void openstudio::model::ThermalZone::removeSupplyPlenum ( )

Remove any supply plenum serving this zone, associated with the AirLoopHVAC returned by ThermalZone::airLoopHVAC().

◆ removeSupplyPlenum() [2/4]

void openstudio::model::ThermalZone::removeSupplyPlenum ( const AirLoopHVAC & airloop )

Remove any supply plenum associated with the given AirLoopHVAC instance.

This method is important when a zone is connected to multiple AirLoopHVAC instances.

◆ removeSupplyPlenum() [3/4]

void openstudio::model::ThermalZone::removeSupplyPlenum	(	const AirLoopHVAC &	airloop,
		unsigned	branchIndex )

Remove any supply plenum associated with the given AirLoopHVAC instance, and branchIndex in a dual duct system.

This method is important when a zone is connected to multiple AirLoopHVAC instances. This variation can account for dual duct systems, branchIndex can be 0 or 1 indicating which branch of a dual duct system to attach to. branchIndex 0 corresponds to the branch of demandInletNode(0).

◆ removeSupplyPlenum() [4/4]

void openstudio::model::ThermalZone::removeSupplyPlenum ( unsigned branchIndex )

Overload of removeSupplyPlenum() This variation can account for dual duct systems, branchIndex can be 0 or 1 indicating which branch of a dual duct system to attach to.

branchIndex 0 corresponds to the branch of demandInletNode(0).

◆ renderingColor()

boost::optional< RenderingColor > openstudio::model::ThermalZone::renderingColor ( ) const

Returns the rendering color.

◆ resetCeilingHeight()

void openstudio::model::ThermalZone::resetCeilingHeight ( )

◆ resetDaylightingControlsAvailabilitySchedule()

void openstudio::model::ThermalZone::resetDaylightingControlsAvailabilitySchedule ( )

◆ resetFractionofZoneControlledbyPrimaryDaylightingControl()

void openstudio::model::ThermalZone::resetFractionofZoneControlledbyPrimaryDaylightingControl ( )

◆ resetFractionofZoneControlledbySecondaryDaylightingControl()

void openstudio::model::ThermalZone::resetFractionofZoneControlledbySecondaryDaylightingControl ( )

◆ resetIlluminanceMap()

void openstudio::model::ThermalZone::resetIlluminanceMap ( )

◆ resetMultiplier()

void openstudio::model::ThermalZone::resetMultiplier ( )

◆ resetPrimaryDaylightingControl()

void openstudio::model::ThermalZone::resetPrimaryDaylightingControl ( )

◆ resetRenderingColor()

void openstudio::model::ThermalZone::resetRenderingColor ( )

Resets the rendering color.

◆ resetSecondaryDaylightingControl()

void openstudio::model::ThermalZone::resetSecondaryDaylightingControl ( )

◆ resetThermostat()

void openstudio::model::ThermalZone::resetThermostat ( )

◆ resetThermostatSetpointDualSetpoint()

void openstudio::model::ThermalZone::resetThermostatSetpointDualSetpoint ( )

Deprecated

◆ resetVolume()

void openstudio::model::ThermalZone::resetVolume ( )

◆ resetZoneControlContaminantController()

void openstudio::model::ThermalZone::resetZoneControlContaminantController ( )

◆ resetZoneControlHumidistat()

void openstudio::model::ThermalZone::resetZoneControlHumidistat ( )

◆ resetZoneInsideConvectionAlgorithm()

void openstudio::model::ThermalZone::resetZoneInsideConvectionAlgorithm ( )

◆ resetZoneOutsideConvectionAlgorithm()

void openstudio::model::ThermalZone::resetZoneOutsideConvectionAlgorithm ( )

◆ returnAirModelObject()

OptionalModelObject openstudio::model::ThermalZone::returnAirModelObject ( ) const

◆ returnAirModelObjects()

std::vector< ModelObject > openstudio::model::ThermalZone::returnAirModelObjects ( ) const

◆ returnAirPort()

unsigned openstudio::model::ThermalZone::returnAirPort ( ) const

◆ returnPortList()

PortList openstudio::model::ThermalZone::returnPortList ( ) const

◆ secondaryDaylightingControl()

boost::optional< DaylightingControl > openstudio::model::ThermalZone::secondaryDaylightingControl ( ) const

◆ sequentialCoolingFraction()

boost::optional< double > openstudio::model::ThermalZone::sequentialCoolingFraction ( const ModelObject & equipment ) const

Return the Sequential Cooling Fraction of equipment, if it's a ScheduleConstant.

Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its heating priority is zero, or the loadDistributionScheme isn't 'Sequential'

◆ sequentialCoolingFractionSchedule()

boost::optional< Schedule > openstudio::model::ThermalZone::sequentialCoolingFractionSchedule ( const ModelObject & equipment ) const

Return the Sequential Cooling Fraction Schedule of equipment.

Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its heating priority is zero, or the loadDistributionScheme isn't 'Sequential'

◆ sequentialHeatingFraction()

boost::optional< double > openstudio::model::ThermalZone::sequentialHeatingFraction ( const ModelObject & equipment ) const

Return the Sequential Heating Fraction of equipment, if it's a ScheduleConstant Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'.

◆ sequentialHeatingFractionSchedule()

boost::optional< Schedule > openstudio::model::ThermalZone::sequentialHeatingFractionSchedule ( const ModelObject & equipment ) const

Return the Sequential Heating Fraction Schedule of equipment.

Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'

◆ setCeilingHeight() [1/2]

bool openstudio::model::ThermalZone::setCeilingHeight ( boost::optional< double > ceilingHeight )

◆ setCeilingHeight() [2/2]

bool openstudio::model::ThermalZone::setCeilingHeight ( double ceilingHeight )

◆ setCoolingPriority()

bool openstudio::model::ThermalZone::setCoolingPriority	(	const ModelObject &	equipment,
		unsigned	priority )

Set cooling priority of equipment.

Returns false when equipment is not in the ZoneHVACEquipmentList

◆ setDaylightingControlsAvailabilitySchedule()

bool openstudio::model::ThermalZone::setDaylightingControlsAvailabilitySchedule ( Schedule & schedule )

◆ setFractionofZoneControlledbyPrimaryDaylightingControl()

bool openstudio::model::ThermalZone::setFractionofZoneControlledbyPrimaryDaylightingControl ( double fractionofZoneControlledbyPrimaryDaylightingControl )

◆ setFractionofZoneControlledbySecondaryDaylightingControl()

bool openstudio::model::ThermalZone::setFractionofZoneControlledbySecondaryDaylightingControl ( double fractionofZoneControlledbySecondaryDaylightingControl )

◆ setHeatingPriority()

bool openstudio::model::ThermalZone::setHeatingPriority	(	const ModelObject &	equipment,
		unsigned	priority )

Set heating priority of equipment.

Returns false when equipment is not in the ZoneHVACEquipmentList

◆ setIlluminanceMap()

bool openstudio::model::ThermalZone::setIlluminanceMap ( const IlluminanceMap & illuminanceMap )

◆ setLoadDistributionScheme()

bool openstudio::model::ThermalZone::setLoadDistributionScheme ( const std::string & scheme )

◆ setMultiplier()

bool openstudio::model::ThermalZone::setMultiplier ( int multiplier )

◆ setPrimaryDaylightingControl()

bool openstudio::model::ThermalZone::setPrimaryDaylightingControl ( const DaylightingControl & daylightingControl )

◆ setRenderingColor()

bool openstudio::model::ThermalZone::setRenderingColor ( const RenderingColor & renderingColor )

Sets the rendering color.

◆ setReturnPlenum() [1/2]

bool openstudio::model::ThermalZone::setReturnPlenum ( const ThermalZone & plenumZone )

Establish plenumZone as the return plenum for this ThermalZone.

This ThermalZone must already be attached to AirLoopHVAC. The plenumZone must not be used as a plenum on another AirLoopHVAC structure. The method canBePlenum called on plenumZone must return true.

◆ setReturnPlenum() [2/2]

bool openstudio::model::ThermalZone::setReturnPlenum	(	const ThermalZone &	plenumZone,
		AirLoopHVAC &	airLoop )

setReturnPlenum for the specified air loop.

This method is used when there are multiple air loops attached to the zone

◆ setSecondaryDaylightingControl()

bool openstudio::model::ThermalZone::setSecondaryDaylightingControl ( const DaylightingControl & daylightingControl )

◆ setSequentialCoolingFraction()

bool openstudio::model::ThermalZone::setSequentialCoolingFraction	(	const ModelObject &	equipment,
		double	fraction )

Set the Sequential Cooling Fraction of equipment, creates a ScheduleConstant for your convenience.

Returns false when equipment is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'

◆ setSequentialCoolingFractionSchedule()

bool openstudio::model::ThermalZone::setSequentialCoolingFractionSchedule	(	const ModelObject &	equipment,
		Schedule &	schedule )

Set the Sequential Cooling Fraction Schedule of equipment.

Returns false when equipement is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'

◆ setSequentialHeatingFraction()

bool openstudio::model::ThermalZone::setSequentialHeatingFraction	(	const ModelObject &	equipment,
		double	fraction )

Set the Sequential Heating Fraction of equipment, creates a ScheduleConstant for your convenience.

Returns false when equipment is not in the ZoneHVACEquipmentList, its heating priority is zero, or the loadDistributionScheme isn't 'Sequential'

◆ setSequentialHeatingFractionSchedule()

bool openstudio::model::ThermalZone::setSequentialHeatingFractionSchedule	(	const ModelObject &	equipment,
		Schedule &	schedule )

Set the Sequential Heating Fraction Schedule of equipment.

Returns false when equipment is not in the ZoneHVACEquipmentList, its heating priority is zero, or the loadDistributionScheme isn't 'Sequential'

◆ setSupplyPlenum() [1/2]

bool openstudio::model::ThermalZone::setSupplyPlenum ( const ThermalZone & plenumZone )

Establish plenumZone as the supply plenum for this ThermalZone.

This ThermalZone must already be attached to AirLoopHVAC. The plenumZone must not be used as a plenum on another AirLoopHVAC structure. The method canBePlenum called on plenumZone must return true.

◆ setSupplyPlenum() [2/2]

bool openstudio::model::ThermalZone::setSupplyPlenum	(	const ThermalZone &	plenumZone,
		unsigned	branchIndex )

Overload of setSupplyPlenum() This variation can account for dual duct systems, branchIndex can be 0 or 1 indicating which branch of a dual duct system to attach to.

branchIndex 0 corresponds to the branch of demandInletNode(0).

◆ setThermostat()

bool openstudio::model::ThermalZone::setThermostat ( const Thermostat & thermostat )

◆ setThermostatSetpointDualSetpoint()

bool openstudio::model::ThermalZone::setThermostatSetpointDualSetpoint ( const ThermostatSetpointDualSetpoint & thermostat )

Deprecated

◆ setUseIdealAirLoads()

bool openstudio::model::ThermalZone::setUseIdealAirLoads ( bool useIdealAirLoads )

Adds or removes ideal air loads for the zone.

ThermalZones that are attached to air loops will be removed. If the ThermalZone is later added to a loop useIdealAirLoads will be reset to false.

◆ setVolume() [1/2]

bool openstudio::model::ThermalZone::setVolume ( boost::optional< double > volume )

◆ setVolume() [2/2]

bool openstudio::model::ThermalZone::setVolume ( double volume )

◆ setZoneConditioningEquipmentListName()

bool openstudio::model::ThermalZone::setZoneConditioningEquipmentListName ( const std::string & zoneConditioningEquipmentListName )

◆ setZoneControlContaminantController()

bool openstudio::model::ThermalZone::setZoneControlContaminantController ( const ZoneControlContaminantController & contaminantController )

◆ setZoneControlHumidistat()

bool openstudio::model::ThermalZone::setZoneControlHumidistat ( const ZoneControlHumidistat & humidistat )

◆ setZoneInsideConvectionAlgorithm() [1/2]

bool openstudio::model::ThermalZone::setZoneInsideConvectionAlgorithm ( boost::optional< std::string > zoneInsideConvectionAlgorithm )

◆ setZoneInsideConvectionAlgorithm() [2/2]

bool openstudio::model::ThermalZone::setZoneInsideConvectionAlgorithm ( const std::string & zoneInsideConvectionAlgorithm )

◆ setZoneOutsideConvectionAlgorithm() [1/2]

bool openstudio::model::ThermalZone::setZoneOutsideConvectionAlgorithm ( boost::optional< std::string > zoneOutsideConvectionAlgorithm )

◆ setZoneOutsideConvectionAlgorithm() [2/2]

bool openstudio::model::ThermalZone::setZoneOutsideConvectionAlgorithm ( const std::string & zoneOutsideConvectionAlgorithm )

◆ sizingZone()

SizingZone openstudio::model::ThermalZone::sizingZone ( ) const

◆ spaces()

std::vector< Space > openstudio::model::ThermalZone::spaces ( ) const

returns all spaces in this thermal zone

◆ spacesWithDesignSpecificationOutdoorAir()

std::vector< Space > openstudio::model::ThermalZone::spacesWithDesignSpecificationOutdoorAir ( ) const

return all spaces that have a design specification outdoor air assigned

◆ supplyZoneMixing()

std::vector< ZoneMixing > openstudio::model::ThermalZone::supplyZoneMixing ( ) const

Returns all ZoneMixing objects which supply air to this zone.

◆ thermostat()

boost::optional< Thermostat > openstudio::model::ThermalZone::thermostat ( ) const

◆ thermostatSetpointDualSetpoint()

boost::optional< ThermostatSetpointDualSetpoint > openstudio::model::ThermalZone::thermostatSetpointDualSetpoint ( ) const

◆ useIdealAirLoads()

bool openstudio::model::ThermalZone::useIdealAirLoads ( ) const

Indicates if the zone will use EnergyPlus ideal air loads.

◆ validZoneInsideConvectionAlgorithmValues()

static std::vector< std::string > openstudio::model::ThermalZone::validZoneInsideConvectionAlgorithmValues ( )

static

◆ validZoneOutsideConvectionAlgorithmValues()

static std::vector< std::string > openstudio::model::ThermalZone::validZoneOutsideConvectionAlgorithmValues ( )

static

◆ volume()

boost::optional< double > openstudio::model::ThermalZone::volume ( ) const

◆ zoneAirNode()

Node openstudio::model::ThermalZone::zoneAirNode ( ) const

◆ zoneAirPort()

unsigned openstudio::model::ThermalZone::zoneAirPort ( ) const

◆ zoneConditioningEquipmentListName()

std::string openstudio::model::ThermalZone::zoneConditioningEquipmentListName ( ) const

◆ zoneControlContaminantController()

boost::optional< ZoneControlContaminantController > openstudio::model::ThermalZone::zoneControlContaminantController ( ) const

◆ zoneControlHumidistat()

boost::optional< ZoneControlHumidistat > openstudio::model::ThermalZone::zoneControlHumidistat ( ) const

◆ zoneInsideConvectionAlgorithm()

boost::optional< std::string > openstudio::model::ThermalZone::zoneInsideConvectionAlgorithm ( ) const

◆ zoneMixing()

std::vector< ZoneMixing > openstudio::model::ThermalZone::zoneMixing ( ) const

Returns all ZoneMixing objects associated with this zone, includes supply and exhaust mixing objects.

◆ zoneOutsideConvectionAlgorithm()

boost::optional< std::string > openstudio::model::ThermalZone::zoneOutsideConvectionAlgorithm ( ) const

Friends And Related Symbol Documentation

◆ OptionalThermalZone

using OptionalThermalZone = boost::optional<ThermalZone>

using ThermalZoneVector = std::vector<ThermalZone>

Public Member Functions

Related Symbols

Constructors and Destructors

Other

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ThermalZone() [1/3]

◆ ~ThermalZone()

◆ ThermalZone() [2/3]

◆ ThermalZone() [3/3]

Member Function Documentation

◆ addEquipment()

◆ addToNode()

◆ airflowNetworkZone()

◆ airLoopHVACs()

◆ airLoopHVACTerminal()

◆ airLoopHVACTerminals()

◆ airVolume()

◆ autocalculateCeilingHeight()

◆ autocalculateVolume()

◆ autosizedCoolingDesignAirFlowRate()

◆ autosizedCoolingDesignLoad()

◆ autosizedDesignAirFlowRate()

◆ autosizedHeatingDesignAirFlowRate()

◆ autosizedHeatingDesignLoad()

◆ autosizedMinimumOutdoorAirFlowRate()

◆ canBePlenum()

◆ ceilingHeight()

◆ checkDaylightingControlsAndIlluminanceMaps()

◆ combineSpaces()

◆ daylightingControlsAvailabilitySchedule()

◆ disconnect()

◆ electricEquipmentPower()

◆ electricEquipmentPowerPerFloorArea()

◆ electricEquipmentPowerPerPerson()

◆ equipment()

◆ equipmentInCoolingOrder()

◆ equipmentInHeatingOrder()

◆ exhaustPortList()

◆ exhaustZoneMixing()

◆ exteriorSurfaceArea()

◆ exteriorWallArea()

◆ floorArea()

◆ floorAreaPerPerson()

◆ fractionofZoneControlledbyPrimaryDaylightingControl()

◆ fractionofZoneControlledbySecondaryDaylightingControl()

◆ gasEquipmentPower()

◆ gasEquipmentPowerPerFloorArea()

◆ gasEquipmentPowerPerPerson()

◆ getAirflowNetworkZone()

◆ getAutosizedValueFromZoneSizes()

◆ getZonePropertyUserViewFactorsBySurfaceName()

◆ iddObjectType()

◆ illuminanceMap()

◆ infiltrationDesignAirChangesPerHour()

◆ infiltrationDesignFlowPerExteriorSurfaceArea()

◆ infiltrationDesignFlowPerExteriorWallArea()

◆ infiltrationDesignFlowPerSpaceFloorArea()

◆ infiltrationDesignFlowRate()

◆ inletPortList()

◆ isCeilingHeightAutocalculated()

◆ isCeilingHeightDefaulted()

◆ isConditioned()

◆ isFractionofZoneControlledbyPrimaryDaylightingControlDefaulted()

◆ isFractionofZoneControlledbySecondaryDaylightingControlDefaulted()

◆ isMultiplierDefaulted()

◆ isPlenum()

◆ isRemovable()

◆ isVolumeAutocalculated()

◆ isVolumeDefaulted()

◆ lightingPower()

◆ lightingPowerPerFloorArea()

◆ lightingPowerPerPerson()

◆ loadDistributionScheme()

◆ multiAddToNode()

◆ multiplier()

◆ numberOfPeople()

◆ operator=() [1/2]

◆ operator=() [2/2]