 |
OpenStudioCore:model |
|
OpenStudioCore:model |
#include <ThermalZone.hpp>
Inheritance diagram for openstudio::model::ThermalZone:Public Member Functions | |
Constructors and Destructors | |
| ThermalZone (const Model &model) | |
| virtual | ~ThermalZone () |
Getters | |
| int | multiplier () const |
| bool | isMultiplierDefaulted () const |
| boost::optional< double > | ceilingHeight () const |
| OSOptionalQuantity | getCeilingHeight (bool returnIP=false) const |
| bool | isCeilingHeightDefaulted () const |
| bool | isCeilingHeightAutocalculated () const |
| boost::optional< double > | volume () const |
| OSOptionalQuantity | getVolume (bool returnIP=false) 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 |
| double | fractionofZoneControlledbyPrimaryDaylightingControl () const |
| Quantity | getFractionofZoneControlledbyPrimaryDaylightingControl (bool returnIP=false) const |
| bool | isFractionofZoneControlledbyPrimaryDaylightingControlDefaulted () const |
| double | fractionofZoneControlledbySecondaryDaylightingControl () const |
| Quantity | getFractionofZoneControlledbySecondaryDaylightingControl (bool returnIP=false) const |
| bool | isFractionofZoneControlledbySecondaryDaylightingControlDefaulted () const |
| SizingZone | sizingZone () const |
Setters | |
| bool | setMultiplier (int multiplier) |
| void | resetMultiplier () |
| void | setCeilingHeight (boost::optional< double > ceilingHeight) |
| void | setCeilingHeight (double ceilingHeight) |
| bool | setCeilingHeight (const Quantity &ceilingHeight) |
| void | resetCeilingHeight () |
| void | autocalculateCeilingHeight () |
| void | setVolume (boost::optional< double > volume) |
| void | setVolume (double volume) |
| bool | setVolume (const Quantity &volume) |
| void | resetVolume () |
| void | autocalculateVolume () |
| bool | setZoneInsideConvectionAlgorithm (boost::optional< std::string > zoneInsideConvectionAlgorithm) |
| bool | setZoneInsideConvectionAlgorithm (std::string zoneInsideConvectionAlgorithm) |
| void | resetZoneInsideConvectionAlgorithm () |
| bool | setZoneOutsideConvectionAlgorithm (boost::optional< std::string > zoneOutsideConvectionAlgorithm) |
| bool | setZoneOutsideConvectionAlgorithm (std::string zoneOutsideConvectionAlgorithm) |
| void | resetZoneOutsideConvectionAlgorithm () |
| void | setZoneConditioningEquipmentListName (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 | setFractionofZoneControlledbyPrimaryDaylightingControl (double fractionofZoneControlledbyPrimaryDaylightingControl) |
| bool | setFractionofZoneControlledbyPrimaryDaylightingControl (const Quantity &fractionofZoneControlledbyPrimaryDaylightingControl) |
| void | resetFractionofZoneControlledbyPrimaryDaylightingControl () |
| bool | setFractionofZoneControlledbySecondaryDaylightingControl (double fractionofZoneControlledbySecondaryDaylightingControl) |
| bool | setFractionofZoneControlledbySecondaryDaylightingControl (const Quantity &fractionofZoneControlledbySecondaryDaylightingControl) |
| void | resetFractionofZoneControlledbySecondaryDaylightingControl () |
Other | |
| unsigned | returnAirPort () |
| unsigned | zoneAirPort () |
| OptionalModelObject | returnAirModelObject () |
| Node | zoneAirNode () |
| 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< RenderingColor > | renderingColor () const |
| Returns the rendering color. More... | |
| bool | setRenderingColor (const RenderingColor &renderingColor) |
| Sets the rendering color. More... | |
| void | resetRenderingColor () |
| Resets the rendering color. More... | |
| std::vector< ModelObject > | equipment () const |
| std::vector< Space > | spaces () const |
| returns all spaces in this thermal zone More... | |
| double | floorArea () const |
| Accumulates the floorArea (m^2) of spaces. More... | |
| double | exteriorSurfaceArea () const |
| Accumulates the exterior surface area (m^2) of spaces. More... | |
| double | exteriorWallArea () const |
| Accumulates the exterior wall area (m^2) of spaces. More... | |
| double | airVolume () const |
| Accumulates the air volume (m^3) of spaces. More... | |
| double | numberOfPeople () const |
| Returns the number of people in the thermal zone. More... | |
| double | peoplePerFloorArea () const |
| Returns the number of people per floor area (people/m^2). More... | |
| double | floorAreaPerPerson () const |
| Returns the total floor area per person in this thermal zone (m^2/person). More... | |
| double | lightingPower () const |
| Returns the lighting power (W) in this thermal zone. More... | |
| double | lightingPowerPerFloorArea () const |
| Returns the lighting power density (W/m^2) of this thermal zone. More... | |
| double | lightingPowerPerPerson () const |
| Returns the lighting power per person (W/person) of this thermal zone. More... | |
| double | electricEquipmentPower () const |
| Returns the electric equipment power (W) of this thermal zone. More... | |
| double | electricEquipmentPowerPerFloorArea () const |
| Returns the electric equipment power density (W/m^2) of this thermal zone. More... | |
| double | electricEquipmentPowerPerPerson () const |
| Returns the electric equipment power per person (W/person) of this thermal zone. More... | |
| double | gasEquipmentPower () const |
| Returns the gas equipment power (W) of this thermal zone. More... | |
| double | gasEquipmentPowerPerFloorArea () const |
| Returns the gas equipment power density (W/m^2) of this thermal zone. More... | |
| double | gasEquipmentPowerPerPerson () const |
| Returns the gas equipment power per person (W/person) of this thermal zone. More... | |
| double | infiltrationDesignFlowRate () const |
| Returns the infiltration design flow rate (m^3/s) in this thermal zone. More... | |
| double | infiltrationDesignFlowPerSpaceFloorArea () const |
| Returns the infiltration design flow per space floor area (m^3/m^2*s) in this thermal zone. More... | |
| double | infiltrationDesignFlowPerExteriorSurfaceArea () const |
| Returns the infiltration design flow per exterior surface area (m^3/m^2*s) in this thermal zone. More... | |
| double | infiltrationDesignFlowPerExteriorWallArea () const |
| Returns the infiltration design flow per exterior wall area (m^3/m^2*s) in this thermal zone. More... | |
| double | infiltrationDesignAirChangesPerHour () const |
| Returns the infiltration design air changes per hour (1/h) in this thermal zone. More... | |
| boost::optional< std::string > | isConditioned () const |
| Determines if this zone is conditioned, based on the SqlFile output. More... | |
| boost::optional< Space > | combineSpaces () |
| Combines all spaces referencing this zone into a single space referencing this zone. More... | |
| void | disconnect () |
| Removes connections to all other HVACComponent objects. More... | |
| bool | isRemovable () const |
| ThermalZone must be disconnected from all loops to be removable. More... | |
| bool | useIdealAirLoads () const |
| Indicates if the zone will use EnergyPlus ideal air loads. More... | |
| void | setUseIdealAirLoads (bool useIdealAirLoads) |
| Adds or removes ideal air loads for the zone. More... | |
| bool | addToNode (Node &node) |
| PortList | inletPortList () const |
| PortList | exhaustPortList () const |
| void | addEquipment (const ModelObject &equipment) |
| Add new equipment setting the heating and cooling priorities to the next available priority level. More... | |
| void | removeEquipment (const ModelObject &equipment) |
| Remove equipment from the EquipmentList. More... | |
| void | setCoolingPriority (const ModelObject &equipment, unsigned priority) |
| Set cooling priority of equipment. More... | |
| void | setHeatingPriority (const ModelObject &euqipment, unsigned priority) |
| Set heating priority of equipment. More... | |
| std::vector< ModelObject > | equipmentInHeatingOrder () |
| Return all equipment. More... | |
| std::vector< ModelObject > | equipmentInCoolingOrder () |
| Return all equipment. More... | |
| bool | isPlenum () const |
| Return true if the ThermalZone is attached to an AirLoopHVACSupplyPlenum or AirLoopHVACReturnPlenum. More... | |
| 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. More... | |
| bool | setSupplyPlenum (const ThermalZone &plenumZone) |
| Establish plenumZone as the supply plenum for this ThermalZone. More... | |
| 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. More... | |
| void | removeSupplyPlenum () |
| Remove any supply plenum serving this zone. More... | |
| 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. More... | |
| bool | setReturnPlenum (const ThermalZone &plenumZone) |
| Establish plenumZone as the return plenum for this ThermalZone. More... | |
| void | removeReturnPlenum () |
| Remove any return plenum serving this zone. More... | |
| std::vector< ZoneMixing > | zoneMixing () const |
| Returns all ZoneMixing objects associated with this zone, includes supply and exhaust mixing objects. More... | |
| std::vector< ZoneMixing > | supplyZoneMixing () const |
| Returns all ZoneMixing objects which supply air to this zone. More... | |
| std::vector< ZoneMixing > | exhaustZoneMixing () const |
| Returns all ZoneMixing objects which exhaust air from this zone. More... | |
| 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. More... | |
| bool | addToSplitter (Splitter &splitter) |
| Adds this object to a splitter by creating a new branch. More... | |
| boost::optional< AirLoopHVAC > | airLoopHVAC () const |
| Returns the optional AirLoopHVAC object that the HVAC component is attached to. More... | |
| boost::optional < AirLoopHVACOutdoorAirSystem > | airLoopHVACOutdoorAirSystem () const |
| Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More... | |
| boost::optional< HVACComponent > | containingHVACComponent () const |
| EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More... | |
| boost::optional < StraightComponent > | containingStraightComponent () const |
| boost::optional < ZoneHVACComponent > | containingZoneHVACComponent () const |
| Returns any ZoneHVACComponent that contains this HVACComponent. More... | |
| void | disconnect () |
| Removes all connections to other HVACComponent objects. More... | |
| bool | isRemovable () const |
| Indicates if the HVACComponent can be removed from the model. More... | |
| boost::optional< Loop > | loop () const |
| Returns the optional Loop object that the HVAC component is attached to. More... | |
| boost::optional< PlantLoop > | plantLoop () const |
| Returns the optional PlantLoop object that the HVAC component is attached to. More... | |
| std::vector< IdfObject > | remove () |
| Removes the HVACComponent from the model only if isRemovable() return true. More... | |
| virtual | ~HVACComponent () |
| 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... | |
| std::vector< std::string > | relationshipNames () const |
| Return all valid relationship names. More... | |
| std::vector< Relationship > | relationships () const |
| Return all relationships for this ModelObject. More... | |
| boost::optional< Relationship > | getRelationship (const std::string &name) const |
| Get the relationship named name, if it exists. More... | |
| bool | setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject) |
| Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More... | |
| bool | setRelationship (const std::string &name, const Component &component) |
| Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More... | |
| std::vector< std::string > | attributeNames () const |
| Return all valid attribute names. More... | |
| std::vector < openstudio::Attribute > | attributes () const |
| Return all Attributes for this ModelObject. More... | |
| boost::optional < openstudio::Attribute > | getAttribute (const std::string &name) const |
| Get the attribute named name, if it exists. More... | |
| bool | isSettableAttribute (const std::string &name) const |
| Is the named attribute settable. More... | |
| bool | isOptionalAttribute (const std::string &name) const |
| Is the named attribute optional. More... | |
| bool | setAttribute (const std::string &name, bool value) |
| Set the attribute named name, if it exists. More... | |
| bool | setAttribute (const std::string &name, int value) |
| bool | setAttribute (const std::string &name, unsigned value) |
| bool | setAttribute (const std::string &name, double value) |
| bool | setAttribute (const std::string &name, const Quantity &value) |
| bool | setAttribute (const std::string &name, const std::string &value) |
| bool | setAttribute (const std::string &name, const char *value) |
| bool | resetAttribute (const std::string &name) |
| Reset the attribute named name. 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 |
| 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 (const std::vector< std::string > &values) |
| IdfExtensibleGroup | pushExtensibleGroup () |
| 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 IddObjectType | iddObjectType () |
| static std::vector< std::string > | validZoneInsideConvectionAlgorithmValues () |
| static std::vector< std::string > | validZoneOutsideConvectionAlgorithmValues () |
| 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 () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef boost::optional < ThermalZone > | OptionalThermalZone |
| typedef std::vector< ThermalZone > | ThermalZoneVector |
| 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::HVACComponent | |
| typedef detail::HVACComponent_Impl | ImplType |
| 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 |
| Protected Member Functions inherited from openstudio::model::HVACComponent | |
| virtual std::vector< ModelObject > | children () const |
| HVACComponent (IddObjectType type, const Model &model) | |
| Returns the optional ModelObject connected to this object's port. More... | |
| 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. 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) | |
ThermalZone is a HVACComponent that wraps the OpenStudio IDD object 'OS_ThermalZone'.
|
explicit |
|
inlinevirtual |
| void 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.
| bool openstudio::model::ThermalZone::addToNode | ( | Node & | node | ) |
| double openstudio::model::ThermalZone::airVolume | ( | ) | const |
Accumulates the air volume (m^3) of spaces.
Does not include space multiplier.
| void openstudio::model::ThermalZone::autocalculateCeilingHeight | ( | ) |
| void openstudio::model::ThermalZone::autocalculateVolume | ( | ) |
| 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.
| boost::optional<double> openstudio::model::ThermalZone::ceilingHeight | ( | ) | const |
| void openstudio::model::ThermalZone::checkDaylightingControlsAndIlluminanceMaps | ( | ) |
| 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.
| void openstudio::model::ThermalZone::disconnect | ( | ) |
Removes connections to all other HVACComponent objects.
| 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.
| 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.
| 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.
| std::vector<ModelObject> openstudio::model::ThermalZone::equipment | ( | ) | const |
| std::vector<ModelObject> openstudio::model::ThermalZone::equipmentInCoolingOrder | ( | ) |
Return all equipment.
Order is determined by cooling priority
| std::vector<ModelObject> openstudio::model::ThermalZone::equipmentInHeatingOrder | ( | ) |
Return all equipment.
Order is determined by heating priority
| PortList openstudio::model::ThermalZone::exhaustPortList | ( | ) | const |
| std::vector<ZoneMixing> openstudio::model::ThermalZone::exhaustZoneMixing | ( | ) | const |
Returns all ZoneMixing objects which exhaust air from this zone.
| double openstudio::model::ThermalZone::exteriorSurfaceArea | ( | ) | const |
Accumulates the exterior surface area (m^2) of spaces.
Does not include space multiplier.
| double openstudio::model::ThermalZone::exteriorWallArea | ( | ) | const |
Accumulates the exterior wall area (m^2) of spaces.
Does not include space multiplier.
| double openstudio::model::ThermalZone::floorArea | ( | ) | const |
Accumulates the floorArea (m^2) of spaces.
Does not include space multiplier.
| 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.
| double openstudio::model::ThermalZone::fractionofZoneControlledbyPrimaryDaylightingControl | ( | ) | const |
| double openstudio::model::ThermalZone::fractionofZoneControlledbySecondaryDaylightingControl | ( | ) | const |
| 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.
| 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.
| 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.
| OSOptionalQuantity openstudio::model::ThermalZone::getCeilingHeight | ( | bool | returnIP = false | ) | const |
| Quantity openstudio::model::ThermalZone::getFractionofZoneControlledbyPrimaryDaylightingControl | ( | bool | returnIP = false | ) | const |
| Quantity openstudio::model::ThermalZone::getFractionofZoneControlledbySecondaryDaylightingControl | ( | bool | returnIP = false | ) | const |
| OSOptionalQuantity openstudio::model::ThermalZone::getVolume | ( | bool | returnIP = false | ) | const |
|
static |
| boost::optional<IlluminanceMap> openstudio::model::ThermalZone::illuminanceMap | ( | ) | const |
| double openstudio::model::ThermalZone::infiltrationDesignAirChangesPerHour | ( | ) | const |
Returns the infiltration design air changes per hour (1/h) in this thermal zone.
Ignores SpaceInfiltrationEffectiveLeakageArea objects. Does not include space multiplier.
| 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 objects. Does not include space multiplier.
| 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 objects. Does not include space multiplier.
| 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 objects. Does not include space multiplier.
| double openstudio::model::ThermalZone::infiltrationDesignFlowRate | ( | ) | const |
Returns the infiltration design flow rate (m^3/s) in this thermal zone.
Ignores SpaceInfiltrationEffectiveLeakageArea objects. Does not include space multiplier.
| PortList openstudio::model::ThermalZone::inletPortList | ( | ) | const |
| bool openstudio::model::ThermalZone::isCeilingHeightAutocalculated | ( | ) | const |
| bool openstudio::model::ThermalZone::isCeilingHeightDefaulted | ( | ) | const |
| 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.
| bool openstudio::model::ThermalZone::isFractionofZoneControlledbyPrimaryDaylightingControlDefaulted | ( | ) | const |
| bool openstudio::model::ThermalZone::isFractionofZoneControlledbySecondaryDaylightingControlDefaulted | ( | ) | const |
| bool openstudio::model::ThermalZone::isMultiplierDefaulted | ( | ) | const |
| bool openstudio::model::ThermalZone::isPlenum | ( | ) | const |
Return true if the ThermalZone is attached to an AirLoopHVACSupplyPlenum or AirLoopHVACReturnPlenum.
| bool openstudio::model::ThermalZone::isRemovable | ( | ) | const |
ThermalZone must be disconnected from all loops to be removable.
| bool openstudio::model::ThermalZone::isVolumeAutocalculated | ( | ) | const |
| bool openstudio::model::ThermalZone::isVolumeDefaulted | ( | ) | const |
| double openstudio::model::ThermalZone::lightingPower | ( | ) | const |
Returns the lighting power (W) in this thermal zone.
Does not include space multiplier. Does include lighting multiplier.
| 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.
| 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.
| int openstudio::model::ThermalZone::multiplier | ( | ) | const |
| double openstudio::model::ThermalZone::numberOfPeople | ( | ) | const |
Returns the number of people in the thermal zone.
Does not include space multiplier. Does include people multiplier.
| 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.
| boost::optional<DaylightingControl> openstudio::model::ThermalZone::primaryDaylightingControl | ( | ) | const |
| void 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.
| void openstudio::model::ThermalZone::removeReturnPlenum | ( | ) |
Remove any return plenum serving this zone.
| void openstudio::model::ThermalZone::removeSupplyPlenum | ( | ) |
Remove any supply plenum serving this zone.
| 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).
| boost::optional<RenderingColor> openstudio::model::ThermalZone::renderingColor | ( | ) | const |
Returns the rendering color.
| void openstudio::model::ThermalZone::resetCeilingHeight | ( | ) |
| void openstudio::model::ThermalZone::resetFractionofZoneControlledbyPrimaryDaylightingControl | ( | ) |
| void openstudio::model::ThermalZone::resetFractionofZoneControlledbySecondaryDaylightingControl | ( | ) |
| void openstudio::model::ThermalZone::resetIlluminanceMap | ( | ) |
| void openstudio::model::ThermalZone::resetMultiplier | ( | ) |
| void openstudio::model::ThermalZone::resetPrimaryDaylightingControl | ( | ) |
| void openstudio::model::ThermalZone::resetRenderingColor | ( | ) |
Resets the rendering color.
| void openstudio::model::ThermalZone::resetSecondaryDaylightingControl | ( | ) |
| void openstudio::model::ThermalZone::resetThermostat | ( | ) |
| void openstudio::model::ThermalZone::resetThermostatSetpointDualSetpoint | ( | ) |
| void openstudio::model::ThermalZone::resetVolume | ( | ) |
| void openstudio::model::ThermalZone::resetZoneControlHumidistat | ( | ) |
| void openstudio::model::ThermalZone::resetZoneInsideConvectionAlgorithm | ( | ) |
| void openstudio::model::ThermalZone::resetZoneOutsideConvectionAlgorithm | ( | ) |
| OptionalModelObject openstudio::model::ThermalZone::returnAirModelObject | ( | ) |
| unsigned openstudio::model::ThermalZone::returnAirPort | ( | ) |
| boost::optional<DaylightingControl> openstudio::model::ThermalZone::secondaryDaylightingControl | ( | ) | const |
| void openstudio::model::ThermalZone::setCeilingHeight | ( | boost::optional< double > | ceilingHeight | ) |
| void openstudio::model::ThermalZone::setCeilingHeight | ( | double | ceilingHeight | ) |
| bool openstudio::model::ThermalZone::setCeilingHeight | ( | const Quantity & | ceilingHeight | ) |
| void openstudio::model::ThermalZone::setCoolingPriority | ( | const ModelObject & | equipment, |
| unsigned | priority | ||
| ) |
Set cooling priority of equipment.
Asserts when equipment is not in the ZoneHVACEquipmentList
| bool openstudio::model::ThermalZone::setFractionofZoneControlledbyPrimaryDaylightingControl | ( | double | fractionofZoneControlledbyPrimaryDaylightingControl | ) |
| bool openstudio::model::ThermalZone::setFractionofZoneControlledbyPrimaryDaylightingControl | ( | const Quantity & | fractionofZoneControlledbyPrimaryDaylightingControl | ) |
| bool openstudio::model::ThermalZone::setFractionofZoneControlledbySecondaryDaylightingControl | ( | double | fractionofZoneControlledbySecondaryDaylightingControl | ) |
| bool openstudio::model::ThermalZone::setFractionofZoneControlledbySecondaryDaylightingControl | ( | const Quantity & | fractionofZoneControlledbySecondaryDaylightingControl | ) |
| void openstudio::model::ThermalZone::setHeatingPriority | ( | const ModelObject & | euqipment, |
| unsigned | priority | ||
| ) |
Set heating priority of equipment.
Asserts when equipment is not in the ZoneHVACEquipmentList
| bool openstudio::model::ThermalZone::setIlluminanceMap | ( | const IlluminanceMap & | illuminanceMap | ) |
| bool openstudio::model::ThermalZone::setMultiplier | ( | int | multiplier | ) |
| bool openstudio::model::ThermalZone::setPrimaryDaylightingControl | ( | const DaylightingControl & | daylightingControl | ) |
| bool openstudio::model::ThermalZone::setRenderingColor | ( | const RenderingColor & | renderingColor | ) |
Sets the rendering color.
| 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.
| bool openstudio::model::ThermalZone::setSecondaryDaylightingControl | ( | const DaylightingControl & | daylightingControl | ) |
| 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.
| 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).
| bool openstudio::model::ThermalZone::setThermostat | ( | const Thermostat & | thermostat | ) |
| bool openstudio::model::ThermalZone::setThermostatSetpointDualSetpoint | ( | const ThermostatSetpointDualSetpoint & | thermostat | ) |
| void 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.
| void openstudio::model::ThermalZone::setVolume | ( | boost::optional< double > | volume | ) |
| void openstudio::model::ThermalZone::setVolume | ( | double | volume | ) |
| bool openstudio::model::ThermalZone::setVolume | ( | const Quantity & | volume | ) |
| void openstudio::model::ThermalZone::setZoneConditioningEquipmentListName | ( | std::string | zoneConditioningEquipmentListName | ) |
| bool openstudio::model::ThermalZone::setZoneControlHumidistat | ( | const ZoneControlHumidistat & | humidistat | ) |
| bool openstudio::model::ThermalZone::setZoneInsideConvectionAlgorithm | ( | boost::optional< std::string > | zoneInsideConvectionAlgorithm | ) |
| bool openstudio::model::ThermalZone::setZoneInsideConvectionAlgorithm | ( | std::string | zoneInsideConvectionAlgorithm | ) |
| bool openstudio::model::ThermalZone::setZoneOutsideConvectionAlgorithm | ( | boost::optional< std::string > | zoneOutsideConvectionAlgorithm | ) |
| bool openstudio::model::ThermalZone::setZoneOutsideConvectionAlgorithm | ( | std::string | zoneOutsideConvectionAlgorithm | ) |
| SizingZone openstudio::model::ThermalZone::sizingZone | ( | ) | const |
| std::vector<Space> openstudio::model::ThermalZone::spaces | ( | ) | const |
returns all spaces in this thermal zone
| std::vector<ZoneMixing> openstudio::model::ThermalZone::supplyZoneMixing | ( | ) | const |
Returns all ZoneMixing objects which supply air to this zone.
| boost::optional<Thermostat> openstudio::model::ThermalZone::thermostat | ( | ) | const |
| boost::optional<ThermostatSetpointDualSetpoint> openstudio::model::ThermalZone::thermostatSetpointDualSetpoint | ( | ) | const |
| bool openstudio::model::ThermalZone::useIdealAirLoads | ( | ) | const |
Indicates if the zone will use EnergyPlus ideal air loads.
|
static |
|
static |
| boost::optional<double> openstudio::model::ThermalZone::volume | ( | ) | const |
| Node openstudio::model::ThermalZone::zoneAirNode | ( | ) |
| unsigned openstudio::model::ThermalZone::zoneAirPort | ( | ) |
| std::string openstudio::model::ThermalZone::zoneConditioningEquipmentListName | ( | ) | const |
| boost::optional<ZoneControlHumidistat> openstudio::model::ThermalZone::zoneControlHumidistat | ( | ) | const |
| boost::optional<std::string> openstudio::model::ThermalZone::zoneInsideConvectionAlgorithm | ( | ) | const |
| std::vector<ZoneMixing> openstudio::model::ThermalZone::zoneMixing | ( | ) | const |
Returns all ZoneMixing objects associated with this zone, includes supply and exhaust mixing objects.
| boost::optional<std::string> openstudio::model::ThermalZone::zoneOutsideConvectionAlgorithm | ( | ) | const |
|
related |
|
related |