openstudio::model::RefrigerationAirChiller Class Reference

#include <RefrigerationAirChiller.hpp>

Inheritance diagram for openstudio::model::RefrigerationAirChiller:

Public Member Functions
Constructors and Destructors
	RefrigerationAirChiller (const Model &model, Schedule &defrostSchedule)
virtual	~RefrigerationAirChiller ()
Getters
boost::optional< Schedule >	availabilitySchedule () const
std::string	capacityRatingType () const
boost::optional< double >	ratedUnitLoadFactor () const
boost::optional< double >	ratedCapacity () const
double	ratedRelativeHumidity () const
bool	isRatedRelativeHumidityDefaulted () const
double	ratedCoolingSourceTemperature () const
double	ratedTemperatureDifferenceDT1 () const
boost::optional< double >	maximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature () const
double	coilMaterialCorrectionFactor () const
bool	isCoilMaterialCorrectionFactorDefaulted () const
double	refrigerantCorrectionFactor () const
bool	isRefrigerantCorrectionFactorDefaulted () const
double	sHR60CorrectionFactor () const
bool	isSHR60CorrectionFactorDefaulted () const
double	ratedTotalHeatingPower () const
boost::optional< Schedule >	heatingPowerSchedule () const
std::string	fanSpeedControlType () const
bool	isFanSpeedControlTypeDefaulted () const
double	ratedFanPower () const
bool	isRatedFanPowerDefaulted () const
double	ratedAirFlow () const
double	minimumFanAirFlowRatio () const
bool	isMinimumFanAirFlowRatioDefaulted () const
std::string	defrostType () const
bool	isDefrostTypeDefaulted () const
std::string	defrostControlType () const
bool	isDefrostControlTypeDefaulted () const
Schedule	defrostSchedule () const
boost::optional< Schedule >	defrostDripDownSchedule () const
boost::optional< double >	defrostPower () const
boost::optional< double >	temperatureTerminationDefrostFractiontoIce () const
std::string	verticalLocation () const
bool	isVerticalLocationDefaulted () const
double	averageRefrigerantChargeInventory () const
bool	isAverageRefrigerantChargeInventoryDefaulted () const
boost::optional < RefrigerationSystem >	system () const
Setters
bool	setAvailabilitySchedule (Schedule &schedule)
void	resetAvailabilitySchedule ()
bool	setCapacityRatingType (std::string capacityRatingType)
bool	setRatedUnitLoadFactor (double ratedUnitLoadFactor)
void	resetRatedUnitLoadFactor ()
bool	setRatedCapacity (double ratedCapacity)
void	resetRatedCapacity ()
bool	setRatedRelativeHumidity (double ratedRelativeHumidity)
void	resetRatedRelativeHumidity ()
bool	setRatedCoolingSourceTemperature (double ratedCoolingSourceTemperature)
bool	setRatedTemperatureDifferenceDT1 (double ratedTemperatureDifferenceDT1)
bool	setMaximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature (double maximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature)
void	resetMaximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature ()
bool	setCoilMaterialCorrectionFactor (double coilMaterialCorrectionFactor)
void	resetCoilMaterialCorrectionFactor ()
bool	setRefrigerantCorrectionFactor (double refrigerantCorrectionFactor)
void	resetRefrigerantCorrectionFactor ()
bool	setSHR60CorrectionFactor (double sHR60CorrectionFactor)
void	resetSHR60CorrectionFactor ()
bool	setRatedTotalHeatingPower (double ratedTotalHeatingPower)
bool	setHeatingPowerSchedule (Schedule &schedule)
void	resetHeatingPowerSchedule ()
bool	setFanSpeedControlType (std::string fanSpeedControlType)
void	resetFanSpeedControlType ()
bool	setRatedFanPower (double ratedFanPower)
void	resetRatedFanPower ()
bool	setRatedAirFlow (double ratedAirFlow)
bool	setMinimumFanAirFlowRatio (double minimumFanAirFlowRatio)
void	resetMinimumFanAirFlowRatio ()
bool	setDefrostType (std::string defrostType)
void	resetDefrostType ()
bool	setDefrostControlType (std::string defrostControlType)
void	resetDefrostControlType ()
bool	setDefrostSchedule (Schedule &schedule)
bool	setDefrostDripDownSchedule (Schedule &schedule)
void	resetDefrostDripDownSchedule ()
bool	setDefrostPower (double defrostPower)
void	resetDefrostPower ()
bool	setTemperatureTerminationDefrostFractiontoIce (double temperatureTerminationDefrostFractiontoIce)
void	resetTemperatureTerminationDefrostFractiontoIce ()
bool	setAverageRefrigerantChargeInventory (double averageRefrigerantChargeInventory)
void	resetAverageRefrigerantChargeInventory ()
void	removeFromSystem ()
Public Member Functions inherited from openstudio::model::ZoneHVACComponent
bool	addToNode (Node &node)
	Adds this ZoneHVACComponent to a node on an AirLoopHVAC object. More...
bool	addToThermalZone (ThermalZone &thermalZone)
	Adds this ZoneHVACComponent to the thermal zone while managing all node connections automatically. More...
boost::optional< ModelObject >	airInletModelObject () const
	Provided for backwards compatibility, use inletNode instead. More...
boost::optional< AirLoopHVAC >	airLoopHVAC () const
	Returns the AirLoopHVAC attached to this ZoneHVACComponent. More...
boost::optional< ModelObject >	airOutletModelObject () const
	Provided for backwards compatibility, use outletNode instead. More...
boost::optional< Node >	inletNode () const
	Returns the optional node connected to the inletPort(). More...
unsigned	inletPort () const
	Returns the inlet port. More...
boost::optional< Node >	outletNode () const
	Returns the optional node connected to the outletPort(). More...
unsigned	outletPort () const
	Returns the outlet port. More...
bool	removeFromAirLoopHVAC ()
	If this ZoneHVACComponent is used as a supply component on an AirLoopHVAC system, then this method will detach this ZoneHVACComponent from the AirLoopHVAC system, otherwise this method does nothing. More...
void	removeFromThermalZone ()
	Detaches this ZoneHVACComponent from the associated ThermalZone. More...
void	removeReturnPlenum ()
	Remove any return plenum attached to this ZoneHVACComponent. More...
boost::optional < AirLoopHVACReturnPlenum >	returnPlenum () const
bool	setReturnPlenum (const ThermalZone &plenumZone)
	Establish plenumZone as the return plenum for this ZoneHVACComponent. More...
virtual boost::optional < ThermalZone >	thermalZone () const
	Returns the optional ThermalZone that this ZoneHVACComponent is attached to. More...
virtual	~ZoneHVACComponent ()
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 >	capacityRatingTypeValues ()
static std::vector< std::string >	defrostControlTypeValues ()
static std::vector< std::string >	defrostTypeValues ()
static std::vector< std::string >	fanSpeedControlTypeValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	verticalLocationValues ()

Related Functions
(Note that these are not member functions.)
typedef boost::optional < RefrigerationAirChiller >	OptionalRefrigerationAirChiller
typedef std::vector < RefrigerationAirChiller >	RefrigerationAirChillerVector
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...

Additional Inherited Members
Protected Types inherited from openstudio::model::ZoneHVACComponent
typedef detail::ZoneHVACComponent_Impl	ImplType
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::ZoneHVACComponent
virtual std::vector< ModelObject >	children () const override
	ZoneHVACComponent (IddObjectType type, const Model &model)
	ZoneHVACComponent (std::shared_ptr< ImplType > impl)
Protected Member Functions inherited from openstudio::model::HVACComponent
	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

RefrigerationAirChiller is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:Refrigeration:AirChiller'.

Constructor & Destructor Documentation

openstudio::model::RefrigerationAirChiller::RefrigerationAirChiller ( const Model &  model, Schedule &  defrostSchedule  )

explicit

virtual openstudio::model::RefrigerationAirChiller::~RefrigerationAirChiller ( )

inlinevirtual

Member Function Documentation

boost::optional<Schedule> openstudio::model::RefrigerationAirChiller::availabilitySchedule

(

)

const

double openstudio::model::RefrigerationAirChiller::averageRefrigerantChargeInventory

(

)

const

std::string openstudio::model::RefrigerationAirChiller::capacityRatingType

(

)

const

static std::vector<std::string> openstudio::model::RefrigerationAirChiller::capacityRatingTypeValues ( )

static

double openstudio::model::RefrigerationAirChiller::coilMaterialCorrectionFactor

(

)

const

std::string openstudio::model::RefrigerationAirChiller::defrostControlType

(

)

const

static std::vector<std::string> openstudio::model::RefrigerationAirChiller::defrostControlTypeValues ( )

static

boost::optional<Schedule> openstudio::model::RefrigerationAirChiller::defrostDripDownSchedule

(

)

const

boost::optional<double> openstudio::model::RefrigerationAirChiller::defrostPower

(

)

const

Schedule openstudio::model::RefrigerationAirChiller::defrostSchedule

(

)

const

std::string openstudio::model::RefrigerationAirChiller::defrostType

(

)

const

static std::vector<std::string> openstudio::model::RefrigerationAirChiller::defrostTypeValues ( )

static

std::string openstudio::model::RefrigerationAirChiller::fanSpeedControlType

(

)

const

static std::vector<std::string> openstudio::model::RefrigerationAirChiller::fanSpeedControlTypeValues ( )

static

boost::optional<Schedule> openstudio::model::RefrigerationAirChiller::heatingPowerSchedule

(

)

const

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

static

bool openstudio::model::RefrigerationAirChiller::isAverageRefrigerantChargeInventoryDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isCoilMaterialCorrectionFactorDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isDefrostControlTypeDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isDefrostTypeDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isFanSpeedControlTypeDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isMinimumFanAirFlowRatioDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isRatedFanPowerDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isRatedRelativeHumidityDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isRefrigerantCorrectionFactorDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isSHR60CorrectionFactorDefaulted

(

)

const

bool openstudio::model::RefrigerationAirChiller::isVerticalLocationDefaulted

(

)

const

boost::optional<double> openstudio::model::RefrigerationAirChiller::maximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature

(

)

const

double openstudio::model::RefrigerationAirChiller::minimumFanAirFlowRatio

(

)

const

double openstudio::model::RefrigerationAirChiller::ratedAirFlow

(

)

const

boost::optional<double> openstudio::model::RefrigerationAirChiller::ratedCapacity

(

)

const

double openstudio::model::RefrigerationAirChiller::ratedCoolingSourceTemperature

(

)

const

double openstudio::model::RefrigerationAirChiller::ratedFanPower

(

)

const

double openstudio::model::RefrigerationAirChiller::ratedRelativeHumidity

(

)

const

double openstudio::model::RefrigerationAirChiller::ratedTemperatureDifferenceDT1

(

)

const

double openstudio::model::RefrigerationAirChiller::ratedTotalHeatingPower

(

)

const

boost::optional<double> openstudio::model::RefrigerationAirChiller::ratedUnitLoadFactor

(

)

const

double openstudio::model::RefrigerationAirChiller::refrigerantCorrectionFactor

(

)

const

void openstudio::model::RefrigerationAirChiller::removeFromSystem

(

)

void openstudio::model::RefrigerationAirChiller::resetAvailabilitySchedule

(

)

void openstudio::model::RefrigerationAirChiller::resetAverageRefrigerantChargeInventory

(

)

void openstudio::model::RefrigerationAirChiller::resetCoilMaterialCorrectionFactor

(

)

void openstudio::model::RefrigerationAirChiller::resetDefrostControlType

(

)

void openstudio::model::RefrigerationAirChiller::resetDefrostDripDownSchedule

(

)

void openstudio::model::RefrigerationAirChiller::resetDefrostPower

(

)

void openstudio::model::RefrigerationAirChiller::resetDefrostType

(

)

void openstudio::model::RefrigerationAirChiller::resetFanSpeedControlType

(

)

void openstudio::model::RefrigerationAirChiller::resetHeatingPowerSchedule

(

)

void openstudio::model::RefrigerationAirChiller::resetMaximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature

(

)

void openstudio::model::RefrigerationAirChiller::resetMinimumFanAirFlowRatio

(

)

void openstudio::model::RefrigerationAirChiller::resetRatedCapacity

(

)

void openstudio::model::RefrigerationAirChiller::resetRatedFanPower

(

)

void openstudio::model::RefrigerationAirChiller::resetRatedRelativeHumidity

(

)

void openstudio::model::RefrigerationAirChiller::resetRatedUnitLoadFactor

(

)

void openstudio::model::RefrigerationAirChiller::resetRefrigerantCorrectionFactor

(

)

void openstudio::model::RefrigerationAirChiller::resetSHR60CorrectionFactor

(

)

void openstudio::model::RefrigerationAirChiller::resetTemperatureTerminationDefrostFractiontoIce

(

)

bool openstudio::model::RefrigerationAirChiller::setAvailabilitySchedule

(

Schedule &

schedule

)

bool openstudio::model::RefrigerationAirChiller::setAverageRefrigerantChargeInventory

(

double

averageRefrigerantChargeInventory

)

bool openstudio::model::RefrigerationAirChiller::setCapacityRatingType

(

std::string

capacityRatingType

)

bool openstudio::model::RefrigerationAirChiller::setCoilMaterialCorrectionFactor

(

double

coilMaterialCorrectionFactor

)

bool openstudio::model::RefrigerationAirChiller::setDefrostControlType

(

std::string

defrostControlType

)

bool openstudio::model::RefrigerationAirChiller::setDefrostDripDownSchedule

(

Schedule &

schedule

)

bool openstudio::model::RefrigerationAirChiller::setDefrostPower

(

double

defrostPower

)

bool openstudio::model::RefrigerationAirChiller::setDefrostSchedule

(

Schedule &

schedule

)

bool openstudio::model::RefrigerationAirChiller::setDefrostType

(

std::string

defrostType

)

bool openstudio::model::RefrigerationAirChiller::setFanSpeedControlType

(

std::string

fanSpeedControlType

)

bool openstudio::model::RefrigerationAirChiller::setHeatingPowerSchedule

(

Schedule &

schedule

)

bool openstudio::model::RefrigerationAirChiller::setMaximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature

(

double

maximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature

)

bool openstudio::model::RefrigerationAirChiller::setMinimumFanAirFlowRatio

(

double

minimumFanAirFlowRatio

)

bool openstudio::model::RefrigerationAirChiller::setRatedAirFlow

(

double

ratedAirFlow

)

bool openstudio::model::RefrigerationAirChiller::setRatedCapacity

(

double

ratedCapacity

)

bool openstudio::model::RefrigerationAirChiller::setRatedCoolingSourceTemperature

(

double

ratedCoolingSourceTemperature

)

bool openstudio::model::RefrigerationAirChiller::setRatedFanPower

(

double

ratedFanPower

)

bool openstudio::model::RefrigerationAirChiller::setRatedRelativeHumidity

(

double

ratedRelativeHumidity

)

bool openstudio::model::RefrigerationAirChiller::setRatedTemperatureDifferenceDT1

(

double

ratedTemperatureDifferenceDT1

)

bool openstudio::model::RefrigerationAirChiller::setRatedTotalHeatingPower

(

double

ratedTotalHeatingPower

)

bool openstudio::model::RefrigerationAirChiller::setRatedUnitLoadFactor

(

double

ratedUnitLoadFactor

)

bool openstudio::model::RefrigerationAirChiller::setRefrigerantCorrectionFactor

(

double

refrigerantCorrectionFactor

)

bool openstudio::model::RefrigerationAirChiller::setSHR60CorrectionFactor

(

double

sHR60CorrectionFactor

)

bool openstudio::model::RefrigerationAirChiller::setTemperatureTerminationDefrostFractiontoIce

(

double

temperatureTerminationDefrostFractiontoIce

)

double openstudio::model::RefrigerationAirChiller::sHR60CorrectionFactor

(

)

const

boost::optional<RefrigerationSystem> openstudio::model::RefrigerationAirChiller::system

(

)

const

boost::optional<double> openstudio::model::RefrigerationAirChiller::temperatureTerminationDefrostFractiontoIce

(

)

const

std::string openstudio::model::RefrigerationAirChiller::verticalLocation

(

)

const

static std::vector<std::string> openstudio::model::RefrigerationAirChiller::verticalLocationValues ( )

static

Friends And Related Function Documentation

typedef boost::optional<RefrigerationAirChiller> OptionalRefrigerationAirChiller

related

typedef std::vector<RefrigerationAirChiller> RefrigerationAirChillerVector

related