openstudio::model::CoolingTowerVariableSpeed Class Reference

#include <CoolingTowerVariableSpeed.hpp>

Inheritance diagram for openstudio::model::CoolingTowerVariableSpeed:

Public Member Functions
boost::optional< double >	autosizedDesignAirFlowRate () const
boost::optional< double >	autosizedDesignFanPower () const
boost::optional< double >	autosizedDesignWaterFlowRate () const
void	autosizeDesignAirFlowRate ()
void	autosizeDesignFanPower ()
void	autosizeDesignWaterFlowRate ()
boost::optional< double >	basinHeaterCapacity () const
boost::optional< Schedule >	basinHeaterOperatingSchedule () const
boost::optional< double >	basinHeaterSetpointTemperature () const
boost::optional< std::string >	blowdownCalculationMode () const
boost::optional< double >	blowdownConcentrationRatio () const
boost::optional< Schedule >	blowdownMakeupWaterUsageSchedule () const
boost::optional< std::string >	cellControl () const
boost::optional< double >	cellMaximumWaterFlowRateFraction () const
boost::optional< double >	cellMinimumWaterFlowRateFraction () const
	CoolingTowerVariableSpeed (const Model &model)
boost::optional< double >	designAirFlowRate () const
boost::optional< double >	designApproachTemperature () const
boost::optional< double >	designFanPower () const
boost::optional< double >	designInletAirWetBulbTemperature () const
boost::optional< double >	designRangeTemperature () const
boost::optional< double >	designWaterFlowRate () const
boost::optional< double >	driftLossPercent () const
std::string	endUseSubcategory () const
double	evaporationLossFactor () const
boost::optional< std::string >	evaporationLossMode () const
boost::optional< CurveCubic >	fanPowerRatioFunctionofAirFlowRateRatioCurve () const
boost::optional< double >	fractionofTowerCapacityinFreeConvectionRegime () const
bool	isDesignAirFlowRateAutosized () const
bool	isDesignFanPowerAutosized () const
bool	isDesignWaterFlowRateAutosized () const
bool	isEvaporationLossFactorDefaulted () const
boost::optional< double >	minimumAirFlowRateRatio () const
boost::optional< ModelObject >	modelCoefficient () const
	Returns CoolingTowerPerformanceYorkCalc, CoolingTowerPerformanceCoolTools, or boost::none. More...
boost::optional< std::string >	modelType () const
boost::optional< int >	numberofCells () const
void	resetBasinHeaterCapacity ()
void	resetBasinHeaterOperatingSchedule ()
void	resetBasinHeaterSetpointTemperature ()
void	resetBlowdownCalculationMode ()
void	resetBlowdownConcentrationRatio ()
void	resetBlowdownMakeupWaterUsageSchedule ()
void	resetCellControl ()
void	resetCellMaximumWaterFlowRateFraction ()
void	resetCellMinimumWaterFlowRateFraction ()
void	resetDesignApproachTemperature ()
void	resetDesignInletAirWetBulbTemperature ()
void	resetDesignRangeTemperature ()
void	resetDriftLossPercent ()
void	resetEvaporationLossFactor ()
void	resetEvaporationLossMode ()
void	resetFanPowerRatioFunctionofAirFlowRateRatioCurve ()
void	resetFractionofTowerCapacityinFreeConvectionRegime ()
void	resetMinimumAirFlowRateRatio ()
void	resetModelCoefficient ()
void	resetModelType ()
void	resetNumberofCells ()
void	resetSizingFactor ()
bool	setBasinHeaterCapacity (double basinHeaterCapacity)
bool	setBasinHeaterOperatingSchedule (Schedule &schedule)
bool	setBasinHeaterSetpointTemperature (double basinHeaterSetpointTemperature)
bool	setBlowdownCalculationMode (std::string blowdownCalculationMode)
bool	setBlowdownConcentrationRatio (double blowdownConcentrationRatio)
bool	setBlowdownMakeupWaterUsageSchedule (Schedule &schedule)
bool	setCellControl (std::string cellControl)
bool	setCellMaximumWaterFlowRateFraction (double cellMaximumWaterFlowRateFraction)
bool	setCellMinimumWaterFlowRateFraction (double cellMinimumWaterFlowRateFraction)
bool	setDesignAirFlowRate (double designAirFlowRate)
bool	setDesignApproachTemperature (double designApproachTemperature)
bool	setDesignFanPower (double designFanPower)
bool	setDesignInletAirWetBulbTemperature (double designInletAirWetBulbTemperature)
bool	setDesignRangeTemperature (double designRangeTemperature)
bool	setDesignWaterFlowRate (double designWaterFlowRate)
bool	setDriftLossPercent (double driftLossPercent)
bool	setEndUseSubcategory (const std::string &endUseSubcategory)
bool	setEvaporationLossFactor (double evaporationLossFactor)
bool	setEvaporationLossMode (std::string evaporationLossMode)
bool	setFanPowerRatioFunctionofAirFlowRateRatioCurve (const CurveCubic &curve)
bool	setFractionofTowerCapacityinFreeConvectionRegime (double fractionofTowerCapacityinFreeConvectionRegime)
bool	setMinimumAirFlowRateRatio (double minimumAirFlowRateRatio)
bool	setModelCoefficient (const ModelObject &variableSpeedTowerCoefficient)
	Accepts CoolingTowerPerformanceYorkCalc or CoolingTowerPerformanceCoolTools. More...
bool	setModelType (std::string modelType)
bool	setNumberofCells (int numberofCells)
bool	setSizingFactor (double sizingFactor)
boost::optional< double >	sizingFactor () const
virtual	~CoolingTowerVariableSpeed ()
Public Member Functions inherited from openstudio::model::StraightComponent
bool	addToNode (Node &node)
boost::optional< AirLoopHVAC >	airLoopHVAC () const
	Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
ModelObject	clone (Model model) const
void	disconnect ()
boost::optional< ModelObject >	inletModelObject () const
	Returns the optional ModelObject connected to the inlet port. More...
unsigned	inletPort () const
	Returns the inlet port. More...
boost::optional< ModelObject >	outletModelObject () const
	Returns the optional ModelObject connected to the outlet port. More...
unsigned	outletPort () const
	Returns the outlet port. More...
std::vector < openstudio::IdfObject >	remove ()
bool	removeFromLoop ()
	StraightComponent (IddObjectType type, const Model &model)
virtual	~StraightComponent ()
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...
void	applySizingValues ()
void	autosize ()
	Returns the optional ModelObject connected to this object's port. 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...
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...
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 (std::string valueName, std::string unitString) 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 std::vector< std::string >	blowdownCalculationModeValues ()
static std::vector< std::string >	cellControlValues ()
static std::vector< std::string >	evaporationLossModeValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	modelTypeValues ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < CoolingTowerVariableSpeed >	CoolingTowerVariableSpeedVector
typedef boost::optional < CoolingTowerVariableSpeed >	OptionalCoolingTowerVariableSpeed
Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=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...

Additional Inherited Members
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 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)

Detailed Description

CoolingTowerVariableSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:CoolingTower:VariableSpeed'.

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::CoolingTowerVariableSpeed::~CoolingTowerVariableSpeed ( )

inlinevirtual

Member Function Documentation

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::autosizedDesignAirFlowRate

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::autosizedDesignFanPower

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::autosizedDesignWaterFlowRate

(

)

const

void openstudio::model::CoolingTowerVariableSpeed::autosizeDesignAirFlowRate

(

)

void openstudio::model::CoolingTowerVariableSpeed::autosizeDesignFanPower

(

)

void openstudio::model::CoolingTowerVariableSpeed::autosizeDesignWaterFlowRate

(

)

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::basinHeaterCapacity

(

)

const

boost::optional<Schedule> openstudio::model::CoolingTowerVariableSpeed::basinHeaterOperatingSchedule

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::basinHeaterSetpointTemperature

(

)

const

boost::optional<std::string> openstudio::model::CoolingTowerVariableSpeed::blowdownCalculationMode

(

)

const

static std::vector<std::string> openstudio::model::CoolingTowerVariableSpeed::blowdownCalculationModeValues ( )

static

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::blowdownConcentrationRatio

(

)

const

boost::optional<Schedule> openstudio::model::CoolingTowerVariableSpeed::blowdownMakeupWaterUsageSchedule

(

)

const

boost::optional<std::string> openstudio::model::CoolingTowerVariableSpeed::cellControl

(

)

const

static std::vector<std::string> openstudio::model::CoolingTowerVariableSpeed::cellControlValues ( )

static

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::cellMaximumWaterFlowRateFraction

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::cellMinimumWaterFlowRateFraction

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::designAirFlowRate

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::designApproachTemperature

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::designFanPower

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::designInletAirWetBulbTemperature

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::designRangeTemperature

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::designWaterFlowRate

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::driftLossPercent

(

)

const

std::string openstudio::model::CoolingTowerVariableSpeed::endUseSubcategory

(

)

const

double openstudio::model::CoolingTowerVariableSpeed::evaporationLossFactor

(

)

const

boost::optional<std::string> openstudio::model::CoolingTowerVariableSpeed::evaporationLossMode

(

)

const

static std::vector<std::string> openstudio::model::CoolingTowerVariableSpeed::evaporationLossModeValues ( )

static

boost::optional<CurveCubic> openstudio::model::CoolingTowerVariableSpeed::fanPowerRatioFunctionofAirFlowRateRatioCurve

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::fractionofTowerCapacityinFreeConvectionRegime

(

)

const

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

static

bool openstudio::model::CoolingTowerVariableSpeed::isDesignAirFlowRateAutosized

(

)

const

bool openstudio::model::CoolingTowerVariableSpeed::isDesignFanPowerAutosized

(

)

const

bool openstudio::model::CoolingTowerVariableSpeed::isDesignWaterFlowRateAutosized

(

)

const

bool openstudio::model::CoolingTowerVariableSpeed::isEvaporationLossFactorDefaulted

(

)

const

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::minimumAirFlowRateRatio

(

)

const

boost::optional<ModelObject> openstudio::model::CoolingTowerVariableSpeed::modelCoefficient

(

)

const

Returns CoolingTowerPerformanceYorkCalc, CoolingTowerPerformanceCoolTools, or boost::none.

boost::optional<std::string> openstudio::model::CoolingTowerVariableSpeed::modelType

(

)

const

static std::vector<std::string> openstudio::model::CoolingTowerVariableSpeed::modelTypeValues ( )

static

boost::optional<int> openstudio::model::CoolingTowerVariableSpeed::numberofCells

(

)

const

void openstudio::model::CoolingTowerVariableSpeed::resetBasinHeaterCapacity

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetBasinHeaterOperatingSchedule

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetBasinHeaterSetpointTemperature

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetBlowdownCalculationMode

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetBlowdownConcentrationRatio

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetBlowdownMakeupWaterUsageSchedule

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetCellControl

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetCellMaximumWaterFlowRateFraction

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetCellMinimumWaterFlowRateFraction

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetDesignApproachTemperature

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetDesignInletAirWetBulbTemperature

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetDesignRangeTemperature

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetDriftLossPercent

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetEvaporationLossFactor

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetEvaporationLossMode

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetFanPowerRatioFunctionofAirFlowRateRatioCurve

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetFractionofTowerCapacityinFreeConvectionRegime

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetMinimumAirFlowRateRatio

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetModelCoefficient

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetModelType

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetNumberofCells

(

)

void openstudio::model::CoolingTowerVariableSpeed::resetSizingFactor

(

)

bool openstudio::model::CoolingTowerVariableSpeed::setBasinHeaterCapacity

(

double

basinHeaterCapacity

)

bool openstudio::model::CoolingTowerVariableSpeed::setBasinHeaterOperatingSchedule

(

Schedule &

schedule

)

bool openstudio::model::CoolingTowerVariableSpeed::setBasinHeaterSetpointTemperature

(

double

basinHeaterSetpointTemperature

)

bool openstudio::model::CoolingTowerVariableSpeed::setBlowdownCalculationMode

(

std::string

blowdownCalculationMode

)

bool openstudio::model::CoolingTowerVariableSpeed::setBlowdownConcentrationRatio

(

double

blowdownConcentrationRatio

)

bool openstudio::model::CoolingTowerVariableSpeed::setBlowdownMakeupWaterUsageSchedule

(

Schedule &

schedule

)

bool openstudio::model::CoolingTowerVariableSpeed::setCellControl

(

std::string

cellControl

)

bool openstudio::model::CoolingTowerVariableSpeed::setCellMaximumWaterFlowRateFraction

(

double

cellMaximumWaterFlowRateFraction

)

bool openstudio::model::CoolingTowerVariableSpeed::setCellMinimumWaterFlowRateFraction

(

double

cellMinimumWaterFlowRateFraction

)

bool openstudio::model::CoolingTowerVariableSpeed::setDesignAirFlowRate

(

double

designAirFlowRate

)

bool openstudio::model::CoolingTowerVariableSpeed::setDesignApproachTemperature

(

double

designApproachTemperature

)

bool openstudio::model::CoolingTowerVariableSpeed::setDesignFanPower

(

double

designFanPower

)

bool openstudio::model::CoolingTowerVariableSpeed::setDesignInletAirWetBulbTemperature

(

double

designInletAirWetBulbTemperature

)

bool openstudio::model::CoolingTowerVariableSpeed::setDesignRangeTemperature

(

double

designRangeTemperature

)

bool openstudio::model::CoolingTowerVariableSpeed::setDesignWaterFlowRate

(

double

designWaterFlowRate

)

bool openstudio::model::CoolingTowerVariableSpeed::setDriftLossPercent

(

double

driftLossPercent

)

bool openstudio::model::CoolingTowerVariableSpeed::setEndUseSubcategory

(

const std::string &

endUseSubcategory

)

bool openstudio::model::CoolingTowerVariableSpeed::setEvaporationLossFactor

(

double

evaporationLossFactor

)

bool openstudio::model::CoolingTowerVariableSpeed::setEvaporationLossMode

(

std::string

evaporationLossMode

)

bool openstudio::model::CoolingTowerVariableSpeed::setFanPowerRatioFunctionofAirFlowRateRatioCurve

(

const CurveCubic &

curve

)

bool openstudio::model::CoolingTowerVariableSpeed::setFractionofTowerCapacityinFreeConvectionRegime

(

double

fractionofTowerCapacityinFreeConvectionRegime

)

bool openstudio::model::CoolingTowerVariableSpeed::setMinimumAirFlowRateRatio

(

double

minimumAirFlowRateRatio

)

bool openstudio::model::CoolingTowerVariableSpeed::setModelCoefficient

(

const ModelObject &

variableSpeedTowerCoefficient

)

Accepts CoolingTowerPerformanceYorkCalc or CoolingTowerPerformanceCoolTools.

bool openstudio::model::CoolingTowerVariableSpeed::setModelType

(

std::string

modelType

)

bool openstudio::model::CoolingTowerVariableSpeed::setNumberofCells

(

int

numberofCells

)

bool openstudio::model::CoolingTowerVariableSpeed::setSizingFactor

(

double

sizingFactor

)

boost::optional<double> openstudio::model::CoolingTowerVariableSpeed::sizingFactor

(

)

const

Friends And Related Function Documentation

typedef std::vector<CoolingTowerVariableSpeed> CoolingTowerVariableSpeedVector

related

typedef boost::optional<CoolingTowerVariableSpeed> OptionalCoolingTowerVariableSpeed

related