CoilCoolingWater Class Reference

#include "CoilCoolingWater.hpp"

Inheritance diagram for openstudio::model::CoilCoolingWater:

Public Member Functions
	CoilCoolingWater (const Model &model, Schedule &availableSchedule)
	CoilCoolingWater (const Model &model)
virtual	~CoilCoolingWater ()
Schedule	availabilitySchedule () const
Schedule	availableSchedule () const
bool	setAvailabilitySchedule (Schedule &schedule)
bool	setAvailableSchedule (Schedule &schedule)
boost::optional< double >	designWaterFlowRate ()
bool	setDesignWaterFlowRate (double value)
bool	isDesignWaterFlowRateAutosized ()
void	autosizeDesignWaterFlowRate ()
boost::optional< double >	designAirFlowRate ()
bool	setDesignAirFlowRate (double value)
bool	isDesignAirFlowRateAutosized ()
void	autosizeDesignAirFlowRate ()
boost::optional< double >	designInletWaterTemperature ()
bool	setDesignInletWaterTemperature (double value)
bool	isDesignInletWaterTemperatureAutosized ()
void	autosizeDesignInletWaterTemperature ()
boost::optional< double >	designInletAirTemperature ()
bool	setDesignInletAirTemperature (double value)
bool	isDesignInletAirTemperatureAutosized ()
void	autosizeDesignInletAirTemperature ()
boost::optional< double >	designOutletAirTemperature ()
bool	setDesignOutletAirTemperature (double value)
bool	isDesignOutletAirTemperatureAutosized ()
void	autosizeDesignOutletAirTemperature ()
boost::optional< double >	designInletAirHumidityRatio ()
bool	setDesignInletAirHumidityRatio (double value)
bool	isDesignInletAirHumidityRatioAutosized ()
void	autosizeDesignInletAirHumidityRatio ()
boost::optional< double >	designOutletAirHumidityRatio ()
bool	setDesignOutletAirHumidityRatio (double value)
bool	isDesignOutletAirHumidityRatioAutosized ()
void	autosizeDesignOutletAirHumidityRatio ()
std::string	typeOfAnalysis ()
bool	setTypeOfAnalysis (std::string value)
std::string	heatExchangerConfiguration ()
bool	setHeatExchangerConfiguration (std::string value)
boost::optional < ControllerWaterCoil >	controllerWaterCoil ()
AirflowNetworkEquivalentDuct	getAirflowNetworkEquivalentDuct (double length, double diameter)
boost::optional < AirflowNetworkEquivalentDuct >	airflowNetworkEquivalentDuct () const
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

Static Public Member Functions
static IddObjectType	iddObjectType ()

Detailed Description

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

Polymorphic behavior:

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

inlinevirtual

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

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

(

std::string

value

)

Sets the value of the HeatExchangerConfiguration field.

Options are CrossFlow and CounterFlow.

bool openstudio::model::CoilCoolingWater::setTypeOfAnalysis

(

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.