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)
bool	addSupplyBranchForComponent (HVACComponent hvacComponent)
void	autocalculatePlantLoopVolume ()
boost::optional< double >	autosizedMaximumLoopFlowRate () const
boost::optional< double >	autosizedPlantLoopVolume () const
void	autosizeMaximumLoopFlowRate ()
void	autosizeMinimumLoopFlowRate ()
OS_DEPRECATED boost::optional < AvailabilityManager >	availabilityManager () const
unsigned	availabilityManagerPriority (const AvailabilityManager &availabilityManager) const
std::vector< AvailabilityManager >	availabilityManagers () const
virtual ModelObject	clone (Model model) const override
boost::optional< std::string >	commonPipeSimulation () const
boost::optional< Schedule >	componentSetpointOperationSchemeSchedule () const
Node	demandInletNode () const override
std::vector< Node >	demandInletNodes () const override
Mixer	demandMixer ()
Node	demandOutletNode () const override
Splitter	demandSplitter ()
std::string	fluidType ()
int	glycolConcentration () const
bool	isMaximumLoopFlowRateAutosized ()
bool	isMinimumLoopFlowRateAutosized ()
bool	isPlantLoopVolumeAutocalculated ()
std::string	loadDistributionScheme ()
Node	loopTemperatureSetpointNode ()
boost::optional< double >	maximumLoopFlowRate ()
double	maximumLoopTemperature ()
boost::optional< double >	minimumLoopFlowRate ()
double	minimumLoopTemperature ()
boost::optional < PlantEquipmentOperationCoolingLoad >	plantEquipmentOperationCoolingLoad () const
boost::optional< Schedule >	plantEquipmentOperationCoolingLoadSchedule () const
boost::optional < PlantEquipmentOperationHeatingLoad >	plantEquipmentOperationHeatingLoad () const
boost::optional< Schedule >	plantEquipmentOperationHeatingLoadSchedule () const
	PlantLoop (Model &model)
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)
bool	removeSupplyBranchWithComponent (HVACComponent hvacComponent)
OS_DEPRECATED void	resetAvailabilityManager ()
void	resetAvailabilityManagers ()
void	resetCommonPipeSimulation ()
void	resetComponentSetpointOperationSchemeSchedule ()
void	resetPlantEquipmentOperationCoolingLoad ()
void	resetPlantEquipmentOperationCoolingLoadSchedule ()
void	resetPlantEquipmentOperationHeatingLoad ()
void	resetPlantEquipmentOperationHeatingLoadSchedule ()
void	resetPrimaryPlantEquipmentOperationScheme ()
void	resetPrimaryPlantEquipmentOperationSchemeSchedule ()
OS_DEPRECATED bool	setAvailabilityManager (const AvailabilityManager &availabilityManager)
bool	setAvailabilityManagerPriority (const AvailabilityManager &availabilityManager, unsigned priority)
bool	setAvailabilityManagers (const std::vector< AvailabilityManager > &avms)
bool	setCommonPipeSimulation (const std::string &value)
bool	setComponentSetpointOperationSchemeSchedule (Schedule &)
bool	setFluidType (const std::string &value)
bool	setGlycolConcentration (int glycolConcentration)
bool	setLoadDistributionScheme (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 &)
bool	setPlantEquipmentOperationHeatingLoad (const PlantEquipmentOperationHeatingLoad &plantOperation)
bool	setPlantEquipmentOperationHeatingLoadSchedule (Schedule &)
bool	setPlantLoopVolume (double value)
bool	setPrimaryPlantEquipmentOperationScheme (const PlantEquipmentOperationScheme &plantOperation)
bool	setPrimaryPlantEquipmentOperationSchemeSchedule (Schedule &)
SizingPlant	sizingPlant () const
Node	supplyInletNode () const override
Mixer	supplyMixer () const
Node	supplyOutletNode () const override
std::vector< Node >	supplyOutletNodes () const override
Splitter	supplySplitter () const
virtual	~PlantLoop ()

Static Public Member Functions
static std::vector< std::string >	fluidTypeValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	loadDistributionSchemeValues ()

Related Functions
typedef boost::optional < PlantLoop >	OptionalPlantLoop

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

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.

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

inlinevirtual

Member Function Documentation

bool openstudio::model::PlantLoop::addAvailabilityManager

(

const AvailabilityManager &

availabilityManager

)

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

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.

bool openstudio::model::PlantLoop::addSupplyBranchForComponent

(

HVACComponent

hvacComponent

)

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

void openstudio::model::PlantLoop::autocalculatePlantLoopVolume

(

)

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

(

)

const

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

(

)

const

void openstudio::model::PlantLoop::autosizeMaximumLoopFlowRate

(

)

void openstudio::model::PlantLoop::autosizeMinimumLoopFlowRate

(

)

OS_DEPRECATED boost::optional<AvailabilityManager> openstudio::model::PlantLoop::availabilityManager

(

)

const

unsigned openstudio::model::PlantLoop::availabilityManagerPriority

(

const AvailabilityManager &

availabilityManager

)

const

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

(

)

const

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

overridevirtual

Reimplemented from openstudio::model::Loop.

boost::optional<std::string> openstudio::model::PlantLoop::commonPipeSimulation

(

)

const

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

(

)

const

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

overridevirtual

Reimplemented from openstudio::model::Loop.

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

overridevirtual

Reimplemented from openstudio::model::Loop.

Mixer openstudio::model::PlantLoop::demandMixer

(

)

Returns the demand side Mixer.

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

overridevirtual

Reimplemented from openstudio::model::Loop.

Splitter openstudio::model::PlantLoop::demandSplitter

(

)

Returns the demand side Splitter.

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

(

)

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

static

int openstudio::model::PlantLoop::glycolConcentration

(

)

const

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

static

bool openstudio::model::PlantLoop::isMaximumLoopFlowRateAutosized

(

)

bool openstudio::model::PlantLoop::isMinimumLoopFlowRateAutosized

(

)

bool openstudio::model::PlantLoop::isPlantLoopVolumeAutocalculated

(

)

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

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

static

Node openstudio::model::PlantLoop::loopTemperatureSetpointNode

(

)

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

(

)

double openstudio::model::PlantLoop::maximumLoopTemperature

(

)

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

(

)

double openstudio::model::PlantLoop::minimumLoopTemperature

(

)

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

(

)

const

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

(

)

const

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.

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

(

)

const

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

(

)

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

(

)

const

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

(

)

const

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

overridevirtual

Reimplemented from openstudio::model::Loop.

bool openstudio::model::PlantLoop::removeAvailabilityManager

(

const AvailabilityManager &

avm

)

bool openstudio::model::PlantLoop::removeAvailabilityManager

(

unsigned

priority

)

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.

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.

OS_DEPRECATED void openstudio::model::PlantLoop::resetAvailabilityManager

(

)

void openstudio::model::PlantLoop::resetAvailabilityManagers

(

)

void openstudio::model::PlantLoop::resetCommonPipeSimulation

(

)

void openstudio::model::PlantLoop::resetComponentSetpointOperationSchemeSchedule

(

)

void openstudio::model::PlantLoop::resetPlantEquipmentOperationCoolingLoad

(

)

void openstudio::model::PlantLoop::resetPlantEquipmentOperationCoolingLoadSchedule

(

)

void openstudio::model::PlantLoop::resetPlantEquipmentOperationHeatingLoad

(

)

void openstudio::model::PlantLoop::resetPlantEquipmentOperationHeatingLoadSchedule

(

)

void openstudio::model::PlantLoop::resetPrimaryPlantEquipmentOperationScheme

(

)

void openstudio::model::PlantLoop::resetPrimaryPlantEquipmentOperationSchemeSchedule

(

)

OS_DEPRECATED bool openstudio::model::PlantLoop::setAvailabilityManager

(

const AvailabilityManager &

availabilityManager

)

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

bool openstudio::model::PlantLoop::setAvailabilityManagers

(

const std::vector< AvailabilityManager > &

avms

)

bool openstudio::model::PlantLoop::setCommonPipeSimulation

(

const std::string &

value

)

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.

bool openstudio::model::PlantLoop::setFluidType

(

const std::string &

value

)

bool openstudio::model::PlantLoop::setGlycolConcentration

(

int

glycolConcentration

)

bool openstudio::model::PlantLoop::setLoadDistributionScheme

(

std::string

scheme

)

bool openstudio::model::PlantLoop::setLoopTemperatureSetpointNode

(

Node &

node

)

bool openstudio::model::PlantLoop::setMaximumLoopFlowRate

(

double

value

)

bool openstudio::model::PlantLoop::setMaximumLoopTemperature

(

double

value

)

bool openstudio::model::PlantLoop::setMinimumLoopFlowRate

(

double

value

)

bool openstudio::model::PlantLoop::setMinimumLoopTemperature

(

double

value

)

bool openstudio::model::PlantLoop::setPlantEquipmentOperationCoolingLoad

(

const PlantEquipmentOperationCoolingLoad &

plantOperation

)

bool openstudio::model::PlantLoop::setPlantEquipmentOperationCoolingLoadSchedule

(

Schedule &

)

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

bool openstudio::model::PlantLoop::setPlantEquipmentOperationHeatingLoad

(

const PlantEquipmentOperationHeatingLoad &

plantOperation

)

bool openstudio::model::PlantLoop::setPlantEquipmentOperationHeatingLoadSchedule

(

Schedule &

)

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

bool openstudio::model::PlantLoop::setPlantLoopVolume

(

double

value

)

bool openstudio::model::PlantLoop::setPrimaryPlantEquipmentOperationScheme

(

const PlantEquipmentOperationScheme &

plantOperation

)

bool openstudio::model::PlantLoop::setPrimaryPlantEquipmentOperationSchemeSchedule

(

Schedule &

)

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

SizingPlant openstudio::model::PlantLoop::sizingPlant

(

)

const

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

overridevirtual

Reimplemented from openstudio::model::Loop.

Mixer openstudio::model::PlantLoop::supplyMixer

(

)

const

Returns the supply side Mixer.

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

overridevirtual

Reimplemented from openstudio::model::Loop.

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

overridevirtual

Reimplemented from openstudio::model::Loop.

Splitter openstudio::model::PlantLoop::supplySplitter

(

)

const

Returns the supply side Splitter.

Friends And Related Function Documentation

typedef boost::optional<PlantLoop> OptionalPlantLoop

related