openstudio::model::WaterHeaterHeatPump Class Reference

#include <WaterHeaterHeatPump.hpp>

Inheritance diagram for openstudio::model::WaterHeaterHeatPump:

Public Member Functions
Constructors and Destructors
	WaterHeaterHeatPump (const Model &model)
	WaterHeaterHeatPump (const Model &model, const ModelObject &dxCoil, const HVACComponent &tank, const HVACComponent &fan, Schedule &compressorSetpointTemperatureSchedule, Schedule &inletAirMixerSchedule)
virtual	~WaterHeaterHeatPump ()
Getters
boost::optional< Schedule >	availabilitySchedule () const
Schedule	compressorSetpointTemperatureSchedule () const
double	deadBandTemperatureDifference () const
boost::optional< double >	condenserWaterFlowRate () const
bool	isCondenserWaterFlowRateAutosized () const
boost::optional< double >	evaporatorAirFlowRate () const
bool	isEvaporatorAirFlowRateAutosized () const
std::string	inletAirConfiguration () const
boost::optional< Schedule >	inletAirTemperatureSchedule () const
boost::optional< Schedule >	inletAirHumiditySchedule () const
HVACComponent	tank () const
ModelObject	dXCoil () const
double	minimumInletAirTemperatureforCompressorOperation () const
double	maximumInletAirTemperatureforCompressorOperation () const
std::string	compressorLocation () const
boost::optional< Schedule >	compressorAmbientTemperatureSchedule () const
HVACComponent	fan () const
std::string	fanPlacement () const
double	onCycleParasiticElectricLoad () const
double	offCycleParasiticElectricLoad () const
std::string	parasiticHeatRejectionLocation () const
Schedule	inletAirMixerSchedule () const
std::string	controlSensorLocationInStratifiedTank () const
Setters
bool	setAvailabilitySchedule (Schedule &schedule)
void	resetAvailabilitySchedule ()
bool	setCompressorSetpointTemperatureSchedule (Schedule &schedule)
bool	setDeadBandTemperatureDifference (double deadBandTemperatureDifference)
bool	setCondenserWaterFlowRate (double condenserWaterFlowRate)
void	resetCondenserWaterFlowRate ()
void	autosizeCondenserWaterFlowRate ()
bool	setEvaporatorAirFlowRate (double evaporatorAirFlowRate)
void	resetEvaporatorAirFlowRate ()
void	autosizeEvaporatorAirFlowRate ()
bool	setInletAirConfiguration (std::string inletAirConfiguration)
bool	setInletAirTemperatureSchedule (Schedule &schedule)
void	resetInletAirTemperatureSchedule ()
bool	setInletAirHumiditySchedule (Schedule &schedule)
void	resetInletAirHumiditySchedule ()
bool	setTank (const HVACComponent &waterHeater)
bool	setDXCoil (const ModelObject &coil)
bool	setMinimumInletAirTemperatureforCompressorOperation (double minimumInletAirTemperatureforCompressorOperation)
bool	setMaximumInletAirTemperatureforCompressorOperation (double maximumInletAirTemperatureforCompressorOperation)
bool	setCompressorLocation (std::string compressorLocation)
bool	setCompressorAmbientTemperatureSchedule (Schedule &schedule)
void	resetCompressorAmbientTemperatureSchedule ()
bool	setFan (const HVACComponent &fan)
bool	setFanPlacement (std::string fanPlacement)
bool	setOnCycleParasiticElectricLoad (double onCycleParasiticElectricLoad)
bool	setOffCycleParasiticElectricLoad (double offCycleParasiticElectricLoad)
bool	setParasiticHeatRejectionLocation (std::string parasiticHeatRejectionLocation)
bool	setInletAirMixerSchedule (Schedule &schedule)
bool	setControlSensorLocationInStratifiedTank (std::string controlSensorLocationInStratifiedTank)
Other
boost::optional< double >	autosizedCondenserWaterFlowRate () const
boost::optional< double >	autosizedEvaporatorAirFlowRate () const
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...
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 (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 >	compressorLocationValues ()
static std::vector< std::string >	controlSensorLocationInStratifiedTankValues ()
static std::vector< std::string >	fanPlacementValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	inletAirConfigurationValues ()
static std::vector< std::string >	parasiticHeatRejectionLocationValues ()

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

WaterHeaterHeatPump is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:WaterHeater:HeatPump'.

As of EnergyPlus version 8.4.0 this object maps to WaterHeaterHeatPumpPumpedCondenser in idf format.

Constructor & Destructor Documentation

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

explicit

openstudio::model::WaterHeaterHeatPump::WaterHeaterHeatPump ( const Model &  model, const ModelObject &  dxCoil, const HVACComponent &  tank, const HVACComponent &  fan, Schedule &  compressorSetpointTemperatureSchedule, Schedule &  inletAirMixerSchedule  )

explicit

virtual openstudio::model::WaterHeaterHeatPump::~WaterHeaterHeatPump ( )

inlinevirtual

Member Function Documentation

void openstudio::model::WaterHeaterHeatPump::autosizeCondenserWaterFlowRate

(

)

boost::optional<double> openstudio::model::WaterHeaterHeatPump::autosizedCondenserWaterFlowRate

(

)

const

boost::optional<double> openstudio::model::WaterHeaterHeatPump::autosizedEvaporatorAirFlowRate

(

)

const

void openstudio::model::WaterHeaterHeatPump::autosizeEvaporatorAirFlowRate

(

)

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

(

)

const

boost::optional<Schedule> openstudio::model::WaterHeaterHeatPump::compressorAmbientTemperatureSchedule

(

)

const

std::string openstudio::model::WaterHeaterHeatPump::compressorLocation

(

)

const

static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::compressorLocationValues ( )

static

Schedule openstudio::model::WaterHeaterHeatPump::compressorSetpointTemperatureSchedule

(

)

const

boost::optional<double> openstudio::model::WaterHeaterHeatPump::condenserWaterFlowRate

(

)

const

std::string openstudio::model::WaterHeaterHeatPump::controlSensorLocationInStratifiedTank

(

)

const

static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::controlSensorLocationInStratifiedTankValues ( )

static

double openstudio::model::WaterHeaterHeatPump::deadBandTemperatureDifference

(

)

const

ModelObject openstudio::model::WaterHeaterHeatPump::dXCoil

(

)

const

boost::optional<double> openstudio::model::WaterHeaterHeatPump::evaporatorAirFlowRate

(

)

const

HVACComponent openstudio::model::WaterHeaterHeatPump::fan

(

)

const

std::string openstudio::model::WaterHeaterHeatPump::fanPlacement

(

)

const

static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::fanPlacementValues ( )

static

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

static

std::string openstudio::model::WaterHeaterHeatPump::inletAirConfiguration

(

)

const

static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::inletAirConfigurationValues ( )

static

boost::optional<Schedule> openstudio::model::WaterHeaterHeatPump::inletAirHumiditySchedule

(

)

const

Schedule openstudio::model::WaterHeaterHeatPump::inletAirMixerSchedule

(

)

const

boost::optional<Schedule> openstudio::model::WaterHeaterHeatPump::inletAirTemperatureSchedule

(

)

const

bool openstudio::model::WaterHeaterHeatPump::isCondenserWaterFlowRateAutosized

(

)

const

bool openstudio::model::WaterHeaterHeatPump::isEvaporatorAirFlowRateAutosized

(

)

const

double openstudio::model::WaterHeaterHeatPump::maximumInletAirTemperatureforCompressorOperation

(

)

const

double openstudio::model::WaterHeaterHeatPump::minimumInletAirTemperatureforCompressorOperation

(

)

const

double openstudio::model::WaterHeaterHeatPump::offCycleParasiticElectricLoad

(

)

const

double openstudio::model::WaterHeaterHeatPump::onCycleParasiticElectricLoad

(

)

const

std::string openstudio::model::WaterHeaterHeatPump::parasiticHeatRejectionLocation

(

)

const

static std::vector<std::string> openstudio::model::WaterHeaterHeatPump::parasiticHeatRejectionLocationValues ( )

static

void openstudio::model::WaterHeaterHeatPump::resetAvailabilitySchedule

(

)

void openstudio::model::WaterHeaterHeatPump::resetCompressorAmbientTemperatureSchedule

(

)

void openstudio::model::WaterHeaterHeatPump::resetCondenserWaterFlowRate

(

)

void openstudio::model::WaterHeaterHeatPump::resetEvaporatorAirFlowRate

(

)

void openstudio::model::WaterHeaterHeatPump::resetInletAirHumiditySchedule

(

)

void openstudio::model::WaterHeaterHeatPump::resetInletAirTemperatureSchedule

(

)

bool openstudio::model::WaterHeaterHeatPump::setAvailabilitySchedule

(

Schedule &

schedule

)

bool openstudio::model::WaterHeaterHeatPump::setCompressorAmbientTemperatureSchedule

(

Schedule &

schedule

)

bool openstudio::model::WaterHeaterHeatPump::setCompressorLocation

(

std::string

compressorLocation

)

bool openstudio::model::WaterHeaterHeatPump::setCompressorSetpointTemperatureSchedule

(

Schedule &

schedule

)

bool openstudio::model::WaterHeaterHeatPump::setCondenserWaterFlowRate

(

double

condenserWaterFlowRate

)

bool openstudio::model::WaterHeaterHeatPump::setControlSensorLocationInStratifiedTank

(

std::string

controlSensorLocationInStratifiedTank

)

bool openstudio::model::WaterHeaterHeatPump::setDeadBandTemperatureDifference

(

double

deadBandTemperatureDifference

)

bool openstudio::model::WaterHeaterHeatPump::setDXCoil

(

const ModelObject &

coil

)

bool openstudio::model::WaterHeaterHeatPump::setEvaporatorAirFlowRate

(

double

evaporatorAirFlowRate

)

bool openstudio::model::WaterHeaterHeatPump::setFan

(

const HVACComponent &

fan

)

bool openstudio::model::WaterHeaterHeatPump::setFanPlacement

(

std::string

fanPlacement

)

bool openstudio::model::WaterHeaterHeatPump::setInletAirConfiguration

(

std::string

inletAirConfiguration

)

bool openstudio::model::WaterHeaterHeatPump::setInletAirHumiditySchedule

(

Schedule &

schedule

)

bool openstudio::model::WaterHeaterHeatPump::setInletAirMixerSchedule

(

Schedule &

schedule

)

bool openstudio::model::WaterHeaterHeatPump::setInletAirTemperatureSchedule

(

Schedule &

schedule

)

bool openstudio::model::WaterHeaterHeatPump::setMaximumInletAirTemperatureforCompressorOperation

(

double

maximumInletAirTemperatureforCompressorOperation

)

bool openstudio::model::WaterHeaterHeatPump::setMinimumInletAirTemperatureforCompressorOperation

(

double

minimumInletAirTemperatureforCompressorOperation

)

bool openstudio::model::WaterHeaterHeatPump::setOffCycleParasiticElectricLoad

(

double

offCycleParasiticElectricLoad

)

bool openstudio::model::WaterHeaterHeatPump::setOnCycleParasiticElectricLoad

(

double

onCycleParasiticElectricLoad

)

bool openstudio::model::WaterHeaterHeatPump::setParasiticHeatRejectionLocation

(

std::string

parasiticHeatRejectionLocation

)

bool openstudio::model::WaterHeaterHeatPump::setTank

(

const HVACComponent &

waterHeater

)

HVACComponent openstudio::model::WaterHeaterHeatPump::tank

(

)

const

Friends And Related Function Documentation

typedef boost::optional<WaterHeaterHeatPump> OptionalWaterHeaterHeatPump

related

typedef std::vector<WaterHeaterHeatPump> WaterHeaterHeatPumpVector

related