openstudio::model::PlantLoop Class Reference

#include <PlantLoop.hpp>

Inheritance diagram for openstudio::model::PlantLoop:

Public Member Functions
bool	addAvailabilityManager (const AvailabilityManager &availabilityManager)
bool	addAvailabilityManager (const AvailabilityManager &availabilityManager, unsigned priority)
bool	addDemandBranchForComponent (HVACComponent hvacComponent, bool tertiary=false)
	Adds a new demand branch for component and returns a bool indicating success.
bool	addSupplyBranchForComponent (HVACComponent hvacComponent)
	Adds a new demand branch for component and returns a bool indicating success.
void	autocalculatePlantLoopVolume ()
boost::optional< double >	autosizedMaximumLoopFlowRate () const
boost::optional< double >	autosizedPlantLoopVolume () const
void	autosizeMaximumLoopFlowRate ()
void	autosizeMinimumLoopFlowRate ()
unsigned	availabilityManagerPriority (const AvailabilityManager &availabilityManager) const
std::vector< AvailabilityManager >	availabilityManagers () const
virtual ModelObject	clone (Model model) const override
std::string	commonPipeSimulation () const
boost::optional< Schedule >	componentSetpointOperationSchemeSchedule () const
Node	demandInletNode () const override
std::vector< Node >	demandInletNodes () const override
Mixer	demandMixer ()
	Returns the demand side Mixer.
Node	demandOutletNode () const override
Splitter	demandSplitter ()
	Returns the demand side Splitter.
std::string	fluidType ()
int	glycolConcentration () const
bool	isCommonPipeSimulationDefaulted () const
bool	isMaximumLoopFlowRateAutosized ()
bool	isMinimumLoopFlowRateAutosized ()
bool	isPlantLoopVolumeAutocalculated ()
std::string	loadDistributionScheme ()
	Prior to OS 1.11.0 the options where Optimal, Sequential, and Uniform.
Node	loopTemperatureSetpointNode ()
boost::optional< double >	maximumLoopFlowRate ()
double	maximumLoopTemperature ()
boost::optional< double >	minimumLoopFlowRate ()
double	minimumLoopTemperature ()
PlantLoop &	operator= (const PlantLoop &)=default
PlantLoop &	operator= (PlantLoop &&)=default
boost::optional< PlantEquipmentOperationCoolingLoad >	plantEquipmentOperationCoolingLoad () const
boost::optional< Schedule >	plantEquipmentOperationCoolingLoadSchedule () const
boost::optional< PlantEquipmentOperationHeatingLoad >	plantEquipmentOperationHeatingLoad () const
	In OpenStudio there are three levels of "priority" for PlantEquipmentOperationScheme instances.
boost::optional< Schedule >	plantEquipmentOperationHeatingLoadSchedule () const
	PlantLoop (const PlantLoop &other)=default
	PlantLoop (Model &model)
	Constructs a new PlantLoop object and places it inside the model.
	PlantLoop (PlantLoop &&other)=default
boost::optional< double >	plantLoopVolume ()
boost::optional< PlantEquipmentOperationScheme >	primaryPlantEquipmentOperationScheme () const
boost::optional< Schedule >	primaryPlantEquipmentOperationSchemeSchedule () const
virtual std::vector< openstudio::IdfObject >	remove () override
bool	removeAvailabilityManager (const AvailabilityManager &avm)
bool	removeAvailabilityManager (unsigned priority)
bool	removeDemandBranchWithComponent (HVACComponent hvacComponent)
	Removes the demand side branch that contains the specified hvacComponent.
bool	removeSupplyBranchWithComponent (HVACComponent hvacComponent)
	Removes the demand side branch that contains the specified hvacComponent.
void	resetAvailabilityManagers ()
void	resetCommonPipeSimulation ()
void	resetComponentSetpointOperationSchemeSchedule ()
void	resetPlantEquipmentOperationCoolingLoad ()
void	resetPlantEquipmentOperationCoolingLoadSchedule ()
void	resetPlantEquipmentOperationHeatingLoad ()
void	resetPlantEquipmentOperationHeatingLoadSchedule ()
void	resetPrimaryPlantEquipmentOperationScheme ()
void	resetPrimaryPlantEquipmentOperationSchemeSchedule ()
bool	setAvailabilityManagerPriority (const AvailabilityManager &availabilityManager, unsigned priority)
bool	setAvailabilityManagers (const std::vector< AvailabilityManager > &avms)
bool	setCommonPipeSimulation (const std::string &value)
bool	setComponentSetpointOperationSchemeSchedule (Schedule &)
	Set the hours of operation for which the ComponentSetpointOperationScheme, if any, applies.
bool	setFluidType (const std::string &value)
bool	setGlycolConcentration (int glycolConcentration)
bool	setLoadDistributionScheme (const std::string &scheme)
bool	setLoopTemperatureSetpointNode (Node &node)
bool	setMaximumLoopFlowRate (double value)
bool	setMaximumLoopTemperature (double value)
bool	setMinimumLoopFlowRate (double value)
bool	setMinimumLoopTemperature (double value)
bool	setPlantEquipmentOperationCoolingLoad (const PlantEquipmentOperationCoolingLoad &plantOperation)
bool	setPlantEquipmentOperationCoolingLoadSchedule (Schedule &)
	Set the hours of operation for which the PlantEquipmentOperationCoolingLoad, if any, applies.
bool	setPlantEquipmentOperationHeatingLoad (const PlantEquipmentOperationHeatingLoad &plantOperation)
bool	setPlantEquipmentOperationHeatingLoadSchedule (Schedule &)
	Set the hours of operation for which the PlantEquipmentOperationHeatingLoad, if any, applies.
bool	setPlantLoopVolume (double value)
bool	setPrimaryPlantEquipmentOperationScheme (const PlantEquipmentOperationScheme &plantOperation)
bool	setPrimaryPlantEquipmentOperationSchemeSchedule (Schedule &)
	Set the hours of operation for which the PrimaryPlantEquipmentOperationScheme, if any, applies.
SizingPlant	sizingPlant () const
Node	supplyInletNode () const override
Mixer	supplyMixer () const
	Returns the supply side Mixer.
Node	supplyOutletNode () const override
std::vector< Node >	supplyOutletNodes () const override
Splitter	supplySplitter () const
	Returns the supply side Splitter.
virtual	~PlantLoop () override=default
Public Member Functions inherited from openstudio::model::Loop
std::vector< AppGFuelType >	appGHeatingFuelTypes () const
void	applySizingValues ()
void	autosize ()
virtual std::vector< ModelObject >	children () const
virtual boost::optional< ModelObject >	component (openstudio::Handle handle) const
	Returns an optional ModelObject with the given handle.
std::vector< ModelObject >	components (const HVACComponent &inletComp, const HVACComponent &outletComp, openstudio::IddObjectType type=openstudio::IddObjectType("Catchall"))
	Returns supplyComponents() or demandComponents(), depending on if the inlet and outlet component arugments are on the supply or demand side.
virtual std::vector< ModelObject >	components (openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the HVAC equipment within the air loop including both the supply and demand sides of the loop.
ComponentType	componentType () const
std::vector< FuelType >	coolingFuelTypes () const
virtual boost::optional< ModelObject >	demandComponent (openstudio::Handle handle) const
	Returns an optional ModelObject with the given handle.
virtual std::vector< ModelObject >	demandComponents (const HVACComponent &inletComp, const HVACComponent &outletComp, openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the demand side hvac equipment between inletComps and outletComps.
virtual std::vector< ModelObject >	demandComponents (openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the demand side HVAC equipment within the air loop.
Mixer	demandMixer () const
Splitter	demandSplitter () const
std::vector< FuelType >	heatingFuelTypes () const
	Loop (const Loop &other)=default
	Loop (Loop &&other)=default
Loop &	operator= (const Loop &)=default
Loop &	operator= (Loop &&)=default
virtual boost::optional< ModelObject >	supplyComponent (openstudio::Handle handle) const
	Returns an optional ModelObject with the given handle.
virtual std::vector< ModelObject >	supplyComponents (const HVACComponent &inletComp, const HVACComponent &outletComp, openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the supply side hvac equipment between inletComps and outletComps.
virtual std::vector< ModelObject >	supplyComponents (openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the supply side HVAC equipment within the air loop.
virtual	~Loop () 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

Static Public Member Functions
static std::vector< std::string >	commonPipeSimulationValues ()
static std::vector< std::string >	fluidTypeValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	loadDistributionSchemeValues ()
static std::vector< std::string >	validCommonPipeSimulationValues ()
static std::vector< std::string >	validFluidTypeValues ()
static std::vector< std::string >	validLoadDistributionSchemeValues ()
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 Symbols
(Note that these are not member symbols.)
using	OptionalPlantLoop = boost::optional<PlantLoop>
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.

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObject >	OptionalWorkspaceObject
typedef std::vector< WorkspaceObject >	WorkspaceObjectVector
Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair
typedef std::vector< IdfObject >	IdfObjectVector
typedef boost::optional< IdfObject >	OptionalIdfObject
Protected Types inherited from openstudio::model::ModelObject
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::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

PlantLoop is an interface to the EnergyPlus IDD object named "PlantLoop".

The purpose of this class is to simplify the construction and manipulation of the EnergyPlus PlantLoop object.

Constructor & Destructor Documentation

PlantLoop() [1/3]

openstudio::model::PlantLoop::PlantLoop ( Model & model )

explicit

Constructs a new PlantLoop object and places it inside the model.

The loop is fully initialized with all companion objects.

~PlantLoop()

virtual openstudio::model::PlantLoop::~PlantLoop ( )

overridevirtualdefault

PlantLoop() [2/3]

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

default

PlantLoop() [3/3]

openstudio::model::PlantLoop::PlantLoop ( PlantLoop && other )

default

Member Function Documentation

addAvailabilityManager() [1/2]

bool openstudio::model::PlantLoop::addAvailabilityManager

(

const AvailabilityManager &

availabilityManager

)

addAvailabilityManager() [2/2]

bool openstudio::model::PlantLoop::addAvailabilityManager	(	const AvailabilityManager &	availabilityManager,
		unsigned	priority )

addDemandBranchForComponent()

bool openstudio::model::PlantLoop::addDemandBranchForComponent	(	HVACComponent	hvacComponent,
		bool	tertiary = false )

Adds a new demand branch for component and returns a bool indicating success.

This method will create a new ControllerWaterCoil if hvacComponent is a CoilCoolingWater or a CoilHeatingWater.

addSupplyBranchForComponent()

bool openstudio::model::PlantLoop::addSupplyBranchForComponent

(

HVACComponent

hvacComponent

)

Adds a new demand branch for component and returns a bool indicating success.

autocalculatePlantLoopVolume()

void openstudio::model::PlantLoop::autocalculatePlantLoopVolume

(

)

autosizedMaximumLoopFlowRate()

boost::optional< double > openstudio::model::PlantLoop::autosizedMaximumLoopFlowRate

(

)

const

autosizedPlantLoopVolume()

boost::optional< double > openstudio::model::PlantLoop::autosizedPlantLoopVolume

(

)

const

autosizeMaximumLoopFlowRate()

void openstudio::model::PlantLoop::autosizeMaximumLoopFlowRate

(

)

autosizeMinimumLoopFlowRate()

void openstudio::model::PlantLoop::autosizeMinimumLoopFlowRate

(

)

availabilityManagerPriority()

unsigned openstudio::model::PlantLoop::availabilityManagerPriority

(

const AvailabilityManager &

availabilityManager

)

const

availabilityManagers()

std::vector< AvailabilityManager > openstudio::model::PlantLoop::availabilityManagers

(

)

const

clone()

virtual ModelObject openstudio::model::PlantLoop::clone ( Model model ) const

overridevirtual

Reimplemented from openstudio::model::Loop.

commonPipeSimulation()

std::string openstudio::model::PlantLoop::commonPipeSimulation

(

)

const

commonPipeSimulationValues()

static std::vector< std::string > openstudio::model::PlantLoop::commonPipeSimulationValues ( )

static

componentSetpointOperationSchemeSchedule()

boost::optional< Schedule > openstudio::model::PlantLoop::componentSetpointOperationSchemeSchedule

(

)

const

demandInletNode()

Node openstudio::model::PlantLoop::demandInletNode ( ) const

overridevirtual

Reimplemented from openstudio::model::Loop.

demandInletNodes()

std::vector< Node > openstudio::model::PlantLoop::demandInletNodes ( ) const

overridevirtual

Reimplemented from openstudio::model::Loop.

demandMixer()

Mixer openstudio::model::PlantLoop::demandMixer

(

)

Returns the demand side Mixer.

demandOutletNode()

Node openstudio::model::PlantLoop::demandOutletNode ( ) const

overridevirtual

Reimplemented from openstudio::model::Loop.

demandSplitter()

Splitter openstudio::model::PlantLoop::demandSplitter

(

)

Returns the demand side Splitter.

fluidType()

std::string openstudio::model::PlantLoop::fluidType

(

)

fluidTypeValues()

static std::vector< std::string > openstudio::model::PlantLoop::fluidTypeValues ( )

static

glycolConcentration()

int openstudio::model::PlantLoop::glycolConcentration

(

)

const

iddObjectType()

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

static

isCommonPipeSimulationDefaulted()

bool openstudio::model::PlantLoop::isCommonPipeSimulationDefaulted

(

)

const

isMaximumLoopFlowRateAutosized()

bool openstudio::model::PlantLoop::isMaximumLoopFlowRateAutosized

(

)

isMinimumLoopFlowRateAutosized()

bool openstudio::model::PlantLoop::isMinimumLoopFlowRateAutosized

(

)

isPlantLoopVolumeAutocalculated()

bool openstudio::model::PlantLoop::isPlantLoopVolumeAutocalculated

(

)

loadDistributionScheme()

std::string openstudio::model::PlantLoop::loadDistributionScheme

(

)

Prior to OS 1.11.0 the options where Optimal, Sequential, and Uniform.

E+ changed the available options to. Optimal, SequentialLoad, UniformLoad, UniformPLR, SequentialUniformPLR in version 8.2.0.

OS did not catch up to the new options until 1.11.0. In 1.11.0 existing OS files will be upgraded to use the new options. Sequential will be version translated to SequentialLoad and Uniform will be translated to UniformLoad.

Existing API clients may continue using the old enumerations of Sequential and Uniform, however these options are deprecated.

The current options supported by OS are now consisitent with E+, Optimal, SequentialLoad, UniformLoad, UniformPLR, SequentialUniformPLR

loadDistributionSchemeValues()

static std::vector< std::string > openstudio::model::PlantLoop::loadDistributionSchemeValues ( )

static

loopTemperatureSetpointNode()

Node openstudio::model::PlantLoop::loopTemperatureSetpointNode

(

)

maximumLoopFlowRate()

boost::optional< double > openstudio::model::PlantLoop::maximumLoopFlowRate

(

)

maximumLoopTemperature()

double openstudio::model::PlantLoop::maximumLoopTemperature

(

)

minimumLoopFlowRate()

boost::optional< double > openstudio::model::PlantLoop::minimumLoopFlowRate

(

)

minimumLoopTemperature()

double openstudio::model::PlantLoop::minimumLoopTemperature

(

)

operator=() [1/2]

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

default

operator=() [2/2]

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

default

plantEquipmentOperationCoolingLoad()

boost::optional< PlantEquipmentOperationCoolingLoad > openstudio::model::PlantLoop::plantEquipmentOperationCoolingLoad

(

)

const

plantEquipmentOperationCoolingLoadSchedule()

boost::optional< Schedule > openstudio::model::PlantLoop::plantEquipmentOperationCoolingLoadSchedule

(

)

const

plantEquipmentOperationHeatingLoad()

boost::optional< PlantEquipmentOperationHeatingLoad > openstudio::model::PlantLoop::plantEquipmentOperationHeatingLoad

(

)

const

In OpenStudio there are three levels of "priority" for PlantEquipmentOperationScheme instances.

Priority here means that if there are multiple operation schemes that list the same equipment, the one with the highest priority will define operation for that equipment. The operation scheme defined for primaryPlantEquipmentOperationScheme() is the highest priority, followed by any component setpoint operation. Heating and cooling load operation, defined by plantEquipmentOperationHeatingLoad() and plantEquipmentOperationCoolingLoad() has the lowest priority.

No operation scheme is required for plant operation. OpenStudio will provide suitable defaults if none are provied. If any operation schemes, including primary, heating load, or cooling load, are defined then the default logic is entirely disabled.

OpenStudio does not define a PlantEquipmentOperationComponentSetpoint, which is defined in EnergyPlus, but the funcitonality is supported. In OpenStudio placing a setpoint manager on a component outlet node will trigger OpenStudio to produce a component setpoint operation scheme on export to EnergyPlus. This component setpoint behavior is in place even if there are other primary, heating load, or cooling load schemes defined.

plantEquipmentOperationHeatingLoadSchedule()

boost::optional< Schedule > openstudio::model::PlantLoop::plantEquipmentOperationHeatingLoadSchedule

(

)

const

plantLoopVolume()

boost::optional< double > openstudio::model::PlantLoop::plantLoopVolume

(

)

primaryPlantEquipmentOperationScheme()

boost::optional< PlantEquipmentOperationScheme > openstudio::model::PlantLoop::primaryPlantEquipmentOperationScheme

(

)

const

primaryPlantEquipmentOperationSchemeSchedule()

boost::optional< Schedule > openstudio::model::PlantLoop::primaryPlantEquipmentOperationSchemeSchedule

(

)

const

remove()

virtual std::vector< openstudio::IdfObject > openstudio::model::PlantLoop::remove ( )

overridevirtual

Reimplemented from openstudio::model::Loop.

removeAvailabilityManager() [1/2]

bool openstudio::model::PlantLoop::removeAvailabilityManager

(

const AvailabilityManager &

avm

)

removeAvailabilityManager() [2/2]

bool openstudio::model::PlantLoop::removeAvailabilityManager

(

unsigned

priority

)

removeDemandBranchWithComponent()

bool openstudio::model::PlantLoop::removeDemandBranchWithComponent

(

HVACComponent

hvacComponent

)

Removes the demand side branch that contains the specified hvacComponent.

Does not remove the component from the model, but may remove surrounding, components on the branch if they are not attached to other HVAC objects.

removeSupplyBranchWithComponent()

bool openstudio::model::PlantLoop::removeSupplyBranchWithComponent

(

HVACComponent

hvacComponent

)

Removes the demand side branch that contains the specified hvacComponent.

Does not remove the component from the model, but may remove surrounding, components on the branch if they are not attached to other HVAC objects.

resetAvailabilityManagers()

void openstudio::model::PlantLoop::resetAvailabilityManagers

(

)

resetCommonPipeSimulation()

void openstudio::model::PlantLoop::resetCommonPipeSimulation

(

)

resetComponentSetpointOperationSchemeSchedule()

void openstudio::model::PlantLoop::resetComponentSetpointOperationSchemeSchedule

(

)

resetPlantEquipmentOperationCoolingLoad()

void openstudio::model::PlantLoop::resetPlantEquipmentOperationCoolingLoad

(

)

resetPlantEquipmentOperationCoolingLoadSchedule()

void openstudio::model::PlantLoop::resetPlantEquipmentOperationCoolingLoadSchedule

(

)

resetPlantEquipmentOperationHeatingLoad()

void openstudio::model::PlantLoop::resetPlantEquipmentOperationHeatingLoad

(

)

resetPlantEquipmentOperationHeatingLoadSchedule()

void openstudio::model::PlantLoop::resetPlantEquipmentOperationHeatingLoadSchedule

(

)

resetPrimaryPlantEquipmentOperationScheme()

void openstudio::model::PlantLoop::resetPrimaryPlantEquipmentOperationScheme

(

)

resetPrimaryPlantEquipmentOperationSchemeSchedule()

void openstudio::model::PlantLoop::resetPrimaryPlantEquipmentOperationSchemeSchedule

(

)

setAvailabilityManagerPriority()

bool openstudio::model::PlantLoop::setAvailabilityManagerPriority	(	const AvailabilityManager &	availabilityManager,
		unsigned	priority )

setAvailabilityManagers()

bool openstudio::model::PlantLoop::setAvailabilityManagers

(

const std::vector< AvailabilityManager > &

avms

)

setCommonPipeSimulation()

bool openstudio::model::PlantLoop::setCommonPipeSimulation

(

const std::string &

value

)

setComponentSetpointOperationSchemeSchedule()

bool openstudio::model::PlantLoop::setComponentSetpointOperationSchemeSchedule

(

Schedule &

)

Set the hours of operation for which the ComponentSetpointOperationScheme, if any, applies.

The existance of ComponentSetpointOperationSchemes is controlled by the existance of setpoint managers on the plant component outlet nodes.

setFluidType()

bool openstudio::model::PlantLoop::setFluidType

(

const std::string &

value

)

setGlycolConcentration()

bool openstudio::model::PlantLoop::setGlycolConcentration

(

int

glycolConcentration

)

setLoadDistributionScheme()

bool openstudio::model::PlantLoop::setLoadDistributionScheme

(

const std::string &

scheme

)

setLoopTemperatureSetpointNode()

bool openstudio::model::PlantLoop::setLoopTemperatureSetpointNode

(

Node &

node

)

setMaximumLoopFlowRate()

bool openstudio::model::PlantLoop::setMaximumLoopFlowRate

(

double

value

)

setMaximumLoopTemperature()

bool openstudio::model::PlantLoop::setMaximumLoopTemperature

(

double

value

)

setMinimumLoopFlowRate()

bool openstudio::model::PlantLoop::setMinimumLoopFlowRate

(

double

value

)

setMinimumLoopTemperature()

bool openstudio::model::PlantLoop::setMinimumLoopTemperature

(

double

value

)

setPlantEquipmentOperationCoolingLoad()

bool openstudio::model::PlantLoop::setPlantEquipmentOperationCoolingLoad

(

const PlantEquipmentOperationCoolingLoad &

plantOperation

)

setPlantEquipmentOperationCoolingLoadSchedule()

bool openstudio::model::PlantLoop::setPlantEquipmentOperationCoolingLoadSchedule

(

Schedule &

)

Set the hours of operation for which the PlantEquipmentOperationCoolingLoad, if any, applies.

setPlantEquipmentOperationHeatingLoad()

bool openstudio::model::PlantLoop::setPlantEquipmentOperationHeatingLoad

(

const PlantEquipmentOperationHeatingLoad &

plantOperation

)

setPlantEquipmentOperationHeatingLoadSchedule()

bool openstudio::model::PlantLoop::setPlantEquipmentOperationHeatingLoadSchedule

(

Schedule &

)

Set the hours of operation for which the PlantEquipmentOperationHeatingLoad, if any, applies.

setPlantLoopVolume()

bool openstudio::model::PlantLoop::setPlantLoopVolume

(

double

value

)

setPrimaryPlantEquipmentOperationScheme()

bool openstudio::model::PlantLoop::setPrimaryPlantEquipmentOperationScheme

(

const PlantEquipmentOperationScheme &

plantOperation

)

setPrimaryPlantEquipmentOperationSchemeSchedule()

bool openstudio::model::PlantLoop::setPrimaryPlantEquipmentOperationSchemeSchedule

(

Schedule &

)

Set the hours of operation for which the PrimaryPlantEquipmentOperationScheme, if any, applies.

sizingPlant()

SizingPlant openstudio::model::PlantLoop::sizingPlant

(

)

const

supplyInletNode()

Node openstudio::model::PlantLoop::supplyInletNode ( ) const

overridevirtual

Reimplemented from openstudio::model::Loop.

supplyMixer()

Mixer openstudio::model::PlantLoop::supplyMixer

(

)

const

Returns the supply side Mixer.

supplyOutletNode()

Node openstudio::model::PlantLoop::supplyOutletNode ( ) const

overridevirtual

Reimplemented from openstudio::model::Loop.

supplyOutletNodes()

std::vector< Node > openstudio::model::PlantLoop::supplyOutletNodes ( ) const

overridevirtual

Reimplemented from openstudio::model::Loop.

supplySplitter()

Splitter openstudio::model::PlantLoop::supplySplitter

(

)

const

Returns the supply side Splitter.

validCommonPipeSimulationValues()

static std::vector< std::string > openstudio::model::PlantLoop::validCommonPipeSimulationValues ( )

static

validFluidTypeValues()

static std::vector< std::string > openstudio::model::PlantLoop::validFluidTypeValues ( )

static

validLoadDistributionSchemeValues()

static std::vector< std::string > openstudio::model::PlantLoop::validLoadDistributionSchemeValues ( )

static

Friends And Related Symbol Documentation

OptionalPlantLoop

using OptionalPlantLoop = boost::optional<PlantLoop>

related