#include <CoilCoolingWater.hpp>

Inheritance diagram for openstudio::model::CoilCoolingWater:

Public Member Functions
Constructors and Destructors
	CoilCoolingWater (const Model &model, Schedule &availableSchedule)
	Constructs a new CoilCoolingWater object and places it inside the model. More...

	CoilCoolingWater (const Model &model)

virtual	~CoilCoolingWater ()=default

	CoilCoolingWater (const CoilCoolingWater &other)=default

	CoilCoolingWater (CoilCoolingWater &&other)=default

CoilCoolingWater &	operator= (const CoilCoolingWater &)=default

CoilCoolingWater &	operator= (CoilCoolingWater &&)=default

Getters and Setters
Schedule	availabilitySchedule () const
	Returns the schedule referred to by the Availability Schedule Name field. More...

Schedule	availableSchedule () const

bool	setAvailabilitySchedule (Schedule &schedule)
	Sets the schedule referred to by the Availability Schedule Name field. More...

bool	setAvailableSchedule (Schedule &schedule)

boost::optional< double >	designWaterFlowRate ()
	Returns the value of the DesignWaterFlowRate field. More...

bool	setDesignWaterFlowRate (double value)
	Sets the value of the DesignWaterFlowRate field. More...

bool	isDesignWaterFlowRateAutosized ()
	Returns true if the DesignWaterFlowRate field is set to autosize. More...

void	autosizeDesignWaterFlowRate ()
	Set the DesignWaterFlowRate field to autosize. More...

boost::optional< double >	designAirFlowRate ()
	Returns the value of the DesignAirFlowRate field. More...

bool	setDesignAirFlowRate (double value)
	Sets the value of the DesignAirFlowRate field. More...

bool	isDesignAirFlowRateAutosized ()
	Returns true if the DesignAirFlowRate field is set to autosize. More...

void	autosizeDesignAirFlowRate ()
	Set the DesignAirFlowRate field to autosize. More...

boost::optional< double >	designInletWaterTemperature ()
	Returns the value of the DesignInletWaterTemperature field. More...

bool	setDesignInletWaterTemperature (double value)
	Sets the value of the DesignInletWaterTemperature field. More...

bool	isDesignInletWaterTemperatureAutosized ()
	Returns true if the DesignInletWaterTemperature field is set to autosize. More...

void	autosizeDesignInletWaterTemperature ()
	Set the DesignInletWaterTemperature field to autosize. More...

boost::optional< double >	designInletAirTemperature ()
	Returns the value of the DesignInletAirTemperature field. More...

bool	setDesignInletAirTemperature (double value)
	Sets the value of the DesignInletAirTemperature field. More...

bool	isDesignInletAirTemperatureAutosized ()
	Returns true if the DesignInletAirTemperature field is set to autosize. More...

void	autosizeDesignInletAirTemperature ()
	Set the DesignInletAirTemperature field to autosize. More...

boost::optional< double >	designOutletAirTemperature ()
	Returns the value of the DesignOutletAirTemperature field. More...

bool	setDesignOutletAirTemperature (double value)
	Sets the value of the DesignOutletAirTemperature field. More...

bool	isDesignOutletAirTemperatureAutosized ()
	Returns true if the DesignOutletAirTemperature field is set to autosize. More...

void	autosizeDesignOutletAirTemperature ()
	Set the DesignOutletAirTemperature field to autosize. More...

boost::optional< double >	designInletAirHumidityRatio ()
	Returns the value of the DesignInletAirHumidityRatio field. More...

bool	setDesignInletAirHumidityRatio (double value)
	Sets the value of the DesignInletAirHumidityRatio field. More...

bool	isDesignInletAirHumidityRatioAutosized ()
	Returns true if the DesignInletAirHumidityRatio field is set to autosize. More...

void	autosizeDesignInletAirHumidityRatio ()
	Set the DesignInletAirHumidityRatio field to autosize. More...

boost::optional< double >	designOutletAirHumidityRatio ()
	Returns the value of the DesignOutletAirHumidityRatio field. More...

bool	setDesignOutletAirHumidityRatio (double value)
	Sets the value of the DesignOutletAirHumidityRatio field. More...

bool	isDesignOutletAirHumidityRatioAutosized ()
	Returns true if the DesignOutletAirHumidityRatio field is set to autosize. More...

void	autosizeDesignOutletAirHumidityRatio ()
	Set the DesignOutletAirHumidityRatio field to autosize. More...

std::string	typeOfAnalysis ()
	Returns the value of the TypeOfAnalysis field. More...

bool	setTypeOfAnalysis (const std::string &value)
	Sets the value of the TypeOfAnalysis field. More...

std::string	heatExchangerConfiguration ()
	Returns the value of the HeatExchangerConfiguration field. More...

bool	setHeatExchangerConfiguration (const std::string &value)
	Sets the value of the HeatExchangerConfiguration field. More...

boost::optional < ControllerWaterCoil >	controllerWaterCoil ()
	Returns the optional ControllerWaterCoil associated with this coil. More...

AirflowNetworkEquivalentDuct	getAirflowNetworkEquivalentDuct (double length, double diameter)
	Creates a new equivalent duct object if an object is not already attached. More...

boost::optional < AirflowNetworkEquivalentDuct >	airflowNetworkEquivalentDuct () const
	Returns the attached equivalent duct object, if any. More...

boost::optional< double >	autosizedDesignWaterFlowRate () const

boost::optional< double >	autosizedDesignAirFlowRate () const

boost::optional< double >	autosizedDesignInletWaterTemperature () const

boost::optional< double >	autosizedDesignInletAirTemperature () const

boost::optional< double >	autosizedDesignOutletAirTemperature () const

boost::optional< double >	autosizedDesignInletAirHumidityRatio () const

boost::optional< double >	autosizedDesignOutletAirHumidityRatio () const

boost::optional< double >	autosizedDesignCoilLoad () const

Public Member Functions inherited from openstudio::model::WaterToAirComponent
virtual bool	addToNode (Node &node)

virtual bool	addToSplitter (Splitter &splitter)

virtual boost::optional < ModelObject >	airInletModelObject () const
	Returns the optional ModelObject connected to the air inlet port. More...

virtual unsigned	airInletPort () const
	Returns the air inlet port. More...

virtual boost::optional < AirLoopHVAC >	airLoopHVAC () const

virtual boost::optional < ModelObject >	airOutletModelObject () const
	Returns the optional ModelObject connected to the air outlet port. More...

virtual unsigned	airOutletPort () const
	Returns the air outlet port. More...

virtual ModelObject	clone (Model model) const

void	disconnectAirSide ()

void	disconnectWaterSide ()

WaterToAirComponent &	operator= (const WaterToAirComponent &)=default

WaterToAirComponent &	operator= (WaterToAirComponent &&)=default

virtual boost::optional < PlantLoop >	plantLoop () const

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

bool	removeFromAirLoopHVAC ()
	Removes the component from the airLoopHVAC if one is attached. More...

bool	removeFromPlantLoop ()
	Removes the component from the plantLoop if one is attached. More...

virtual boost::optional < ModelObject >	waterInletModelObject () const
	Returns the optional ModelObject connected to the water inlet port. More...

virtual unsigned	waterInletPort () const
	Returns the water inlet port. More...

virtual boost::optional < ModelObject >	waterOutletModelObject () const
	Returns the optional ModelObject connected to the water outlet port. More...

virtual unsigned	waterOutletPort () const
	Returns the water outlet port. More...

	WaterToAirComponent (const WaterToAirComponent &other)=default

	WaterToAirComponent (WaterToAirComponent &&other)=default

virtual	~WaterToAirComponent ()=default

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

std::vector< AppGFuelType >	appGHeatingFuelTypes () const

void	applySizingValues ()

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

ComponentType	componentType () const

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

std::vector< FuelType >	coolingFuelTypes () const

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

std::vector< FuelType >	heatingFuelTypes () const

	HVACComponent (const HVACComponent &other)=default

	HVACComponent (HVACComponent &&other)=default

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

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

HVACComponent &	operator= (const HVACComponent &)=default

HVACComponent &	operator= (HVACComponent &&)=default

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

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

virtual	~HVACComponent ()=default

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

ParentObject &	operator= (const ParentObject &)=default

ParentObject &	operator= (ParentObject &&)=default

	ParentObject (const ParentObject &other)=default

	ParentObject (ParentObject &&other)=default

virtual	~ParentObject ()=default

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=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(). More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 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< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
	Gets the autosized component value from the sql file. More...

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

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

boost::optional< ModelObject >	connectedObject (unsigned port) const

boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Static Public Member Functions
static IddObjectType	iddObjectType ()

Additional Inherited Members
Protected Types inherited from openstudio::model::HVACComponent
using	ImplType = detail::HVACComponent_Impl

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

Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObject >	children () const

	HVACComponent (IddObjectType type, const Model &model)

	HVACComponent (std::shared_ptr< ImplType > impl)

Protected Member Functions inherited from openstudio::model::ParentObject
	ParentObject (IddObjectType type, const Model &model)
	Constructs a new ParentObject object in the model. 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)

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

Detailed Description

CoilCoolingWater is a WaterToAirComponent that wraps the IDD object named "OS:Coil:Cooling:Water".

Polymorphic behavior:

bool addToNode(Node & node);
- inherited from HVACComponent
- Adds this coil to node. If the coil is not allowed at the given node returns false. If controllerWaterCoil is associated with this coil, then the controller's sensor node will be set to the air outlet node.

Constructor & Destructor Documentation

openstudio::model::CoilCoolingWater::CoilCoolingWater	(	const Model &	model,
		Schedule &	availableSchedule
	)

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

The coil is fully initialized with all companion objects.

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

virtual openstudio::model::CoilCoolingWater::~CoilCoolingWater ( )

virtualdefault

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

default

openstudio::model::CoilCoolingWater::CoilCoolingWater ( CoilCoolingWater && other )

default

Member Function Documentation

boost::optional<AirflowNetworkEquivalentDuct> openstudio::model::CoilCoolingWater::airflowNetworkEquivalentDuct ( ) const

Returns the attached equivalent duct object, if any.

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

boost::optional<double> openstudio::model::CoilCoolingWater::autosizedDesignCoilLoad ( ) const

boost::optional<double> openstudio::model::CoilCoolingWater::autosizedDesignInletAirHumidityRatio ( ) const

boost::optional<double> openstudio::model::CoilCoolingWater::autosizedDesignInletAirTemperature ( ) const

boost::optional<double> openstudio::model::CoilCoolingWater::autosizedDesignInletWaterTemperature ( ) const

boost::optional<double> openstudio::model::CoilCoolingWater::autosizedDesignOutletAirHumidityRatio ( ) const

boost::optional<double> openstudio::model::CoilCoolingWater::autosizedDesignOutletAirTemperature ( ) const

boost::optional<double> openstudio::model::CoilCoolingWater::autosizedDesignWaterFlowRate ( ) const

void openstudio::model::CoilCoolingWater::autosizeDesignAirFlowRate ( )

Set the DesignAirFlowRate field to autosize.

void openstudio::model::CoilCoolingWater::autosizeDesignInletAirHumidityRatio ( )

Set the DesignInletAirHumidityRatio field to autosize.

void openstudio::model::CoilCoolingWater::autosizeDesignInletAirTemperature ( )

Set the DesignInletAirTemperature field to autosize.

void openstudio::model::CoilCoolingWater::autosizeDesignInletWaterTemperature ( )

Set the DesignInletWaterTemperature field to autosize.

void openstudio::model::CoilCoolingWater::autosizeDesignOutletAirHumidityRatio ( )

Set the DesignOutletAirHumidityRatio field to autosize.

void openstudio::model::CoilCoolingWater::autosizeDesignOutletAirTemperature ( )

Set the DesignOutletAirTemperature field to autosize.

void openstudio::model::CoilCoolingWater::autosizeDesignWaterFlowRate ( )

Set the DesignWaterFlowRate field to autosize.

Schedule openstudio::model::CoilCoolingWater::availabilitySchedule ( ) const

Returns the schedule referred to by the Availability Schedule Name field.

Schedule openstudio::model::CoilCoolingWater::availableSchedule ( ) const

Deprecated:

boost::optional<ControllerWaterCoil> openstudio::model::CoilCoolingWater::controllerWaterCoil ( )

Returns the optional ControllerWaterCoil associated with this coil.

boost::optional<double> openstudio::model::CoilCoolingWater::designAirFlowRate ( )

Returns the value of the DesignAirFlowRate field.

boost::optional<double> openstudio::model::CoilCoolingWater::designInletAirHumidityRatio ( )

Returns the value of the DesignInletAirHumidityRatio field.

boost::optional<double> openstudio::model::CoilCoolingWater::designInletAirTemperature ( )

Returns the value of the DesignInletAirTemperature field.

boost::optional<double> openstudio::model::CoilCoolingWater::designInletWaterTemperature ( )

Returns the value of the DesignInletWaterTemperature field.

boost::optional<double> openstudio::model::CoilCoolingWater::designOutletAirHumidityRatio ( )

Returns the value of the DesignOutletAirHumidityRatio field.

boost::optional<double> openstudio::model::CoilCoolingWater::designOutletAirTemperature ( )

Returns the value of the DesignOutletAirTemperature field.

boost::optional<double> openstudio::model::CoilCoolingWater::designWaterFlowRate ( )

Returns the value of the DesignWaterFlowRate field.

AirflowNetworkEquivalentDuct openstudio::model::CoilCoolingWater::getAirflowNetworkEquivalentDuct	(	double	length,
		double	diameter
	)

Creates a new equivalent duct object if an object is not already attached.

std::string openstudio::model::CoilCoolingWater::heatExchangerConfiguration ( )

Returns the value of the HeatExchangerConfiguration field.

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

static

bool openstudio::model::CoilCoolingWater::isDesignAirFlowRateAutosized ( )

Returns true if the DesignAirFlowRate field is set to autosize.

bool openstudio::model::CoilCoolingWater::isDesignInletAirHumidityRatioAutosized ( )

Returns true if the DesignInletAirHumidityRatio field is set to autosize.

bool openstudio::model::CoilCoolingWater::isDesignInletAirTemperatureAutosized ( )

Returns true if the DesignInletAirTemperature field is set to autosize.

bool openstudio::model::CoilCoolingWater::isDesignInletWaterTemperatureAutosized ( )

Returns true if the DesignInletWaterTemperature field is set to autosize.

bool openstudio::model::CoilCoolingWater::isDesignOutletAirHumidityRatioAutosized ( )

Returns true if the DesignOutletAirHumidityRatio field is set to autosize.

bool openstudio::model::CoilCoolingWater::isDesignOutletAirTemperatureAutosized ( )

Returns true if the DesignOutletAirTemperature field is set to autosize.

bool openstudio::model::CoilCoolingWater::isDesignWaterFlowRateAutosized ( )

Returns true if the DesignWaterFlowRate field is set to autosize.

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

default

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

default

bool openstudio::model::CoilCoolingWater::setAvailabilitySchedule ( Schedule & schedule )

Sets the schedule referred to by the Availability Schedule Name field.

bool openstudio::model::CoilCoolingWater::setAvailableSchedule ( Schedule & schedule )

Deprecated:

bool openstudio::model::CoilCoolingWater::setDesignAirFlowRate ( double value )

Sets the value of the DesignAirFlowRate field.

bool openstudio::model::CoilCoolingWater::setDesignInletAirHumidityRatio ( double value )

Sets the value of the DesignInletAirHumidityRatio field.

bool openstudio::model::CoilCoolingWater::setDesignInletAirTemperature ( double value )

Sets the value of the DesignInletAirTemperature field.

bool openstudio::model::CoilCoolingWater::setDesignInletWaterTemperature ( double value )

Sets the value of the DesignInletWaterTemperature field.

bool openstudio::model::CoilCoolingWater::setDesignOutletAirHumidityRatio ( double value )

Sets the value of the DesignOutletAirHumidityRatio field.

bool openstudio::model::CoilCoolingWater::setDesignOutletAirTemperature ( double value )

Sets the value of the DesignOutletAirTemperature field.

bool openstudio::model::CoilCoolingWater::setDesignWaterFlowRate ( double value )

Sets the value of the DesignWaterFlowRate field.

bool openstudio::model::CoilCoolingWater::setHeatExchangerConfiguration ( const std::string & value )

Sets the value of the HeatExchangerConfiguration field.

Options are CrossFlow and CounterFlow.

bool openstudio::model::CoilCoolingWater::setTypeOfAnalysis ( const std::string & value )

Sets the value of the TypeOfAnalysis field.

Options are SimpleAnalysis and DetailedAnalysis

std::string openstudio::model::CoilCoolingWater::typeOfAnalysis ( )

Returns the value of the TypeOfAnalysis field.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation