OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::HeatPumpWaterToWaterEquationFitCooling Class Reference

#include <HeatPumpWaterToWaterEquationFitCooling.hpp>

+ Inheritance diagram for openstudio::model::HeatPumpWaterToWaterEquationFitCooling:

Public Member Functions

Constructors and Destructors
 HeatPumpWaterToWaterEquationFitCooling (const Model &model)
 
virtual ~HeatPumpWaterToWaterEquationFitCooling ()
 
Getters
boost::optional< double > referenceLoadSideFlowRate () const
 
double ratedLoadSideFlowRate () const
 Prior to EnergyPlus 8.7.0 this field was not autosizeable. More...
 
bool isReferenceLoadSideFlowRateAutosized () const
 
boost::optional< double > referenceSourceSideFlowRate () const
 
double ratedSourceSideFlowRate () const
 Prior to EnergyPlus 8.7.0 this field was not autosizeable. More...
 
bool isReferenceSourceSideFlowRateAutosized () const
 
boost::optional< double > ratedCoolingCapacity () const
 In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Capacity". More...
 
bool isRatedCoolingCapacityAutosized () const
 
boost::optional< double > ratedCoolingPowerConsumption () const
 In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Power Consumption". More...
 
bool isRatedCoolingPowerConsumptionAutosized () const
 
double coolingCapacityCoefficient1 () const
 
double coolingCapacityCoefficient2 () const
 
double coolingCapacityCoefficient3 () const
 
double coolingCapacityCoefficient4 () const
 
double coolingCapacityCoefficient5 () const
 
double coolingCompressorPowerCoefficient1 () const
 
double coolingCompressorPowerCoefficient2 () const
 
double coolingCompressorPowerCoefficient3 () const
 
double coolingCompressorPowerCoefficient4 () const
 
double coolingCompressorPowerCoefficient5 () const
 
double referenceCoefficientofPerformance () const
 
double sizingFactor () const
 
boost::optional
< HeatPumpWaterToWaterEquationFitHeating
companionHeatingHeatPump () const
 
Setters
bool setReferenceLoadSideFlowRate (double referenceLoadSideFlowRate)
 
bool setRatedLoadSideFlowRate (double ratedLoadSideFlowRate)
 Synonym of setReferenceLoadSideFlowRate for backwards compatibility. More...
 
void autosizeReferenceLoadSideFlowRate ()
 
bool setReferenceSourceSideFlowRate (double referenceSourceSideFlowRate)
 
bool setRatedSourceSideFlowRate (double ratedSourceSideFlowRate)
 Synonym of setReferenceLoadSideFlowRate for backwards compatibility. More...
 
void autosizeReferenceSourceSideFlowRate ()
 
bool setRatedCoolingCapacity (double ratedCoolingCapacity)
 In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Capacity". More...
 
void autosizeRatedCoolingCapacity ()
 
bool setRatedCoolingPowerConsumption (double ratedCoolingPowerConsumption)
 In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Power Consumption". More...
 
void autosizeRatedCoolingPowerConsumption ()
 
bool setCoolingCapacityCoefficient1 (double coolingCapacityCoefficient1)
 
bool setCoolingCapacityCoefficient2 (double coolingCapacityCoefficient2)
 
bool setCoolingCapacityCoefficient3 (double coolingCapacityCoefficient3)
 
bool setCoolingCapacityCoefficient4 (double coolingCapacityCoefficient4)
 
bool setCoolingCapacityCoefficient5 (double coolingCapacityCoefficient5)
 
bool setCoolingCompressorPowerCoefficient1 (double coolingCompressorPowerCoefficient1)
 
bool setCoolingCompressorPowerCoefficient2 (double coolingCompressorPowerCoefficient2)
 
bool setCoolingCompressorPowerCoefficient3 (double coolingCompressorPowerCoefficient3)
 
bool setCoolingCompressorPowerCoefficient4 (double coolingCompressorPowerCoefficient4)
 
bool setCoolingCompressorPowerCoefficient5 (double coolingCompressorPowerCoefficient5)
 
bool setReferenceCoefficientofPerformance (double referenceCoefficientofPerformance)
 
bool setSizingFactor (double sizingFactor)
 
bool setCompanionHeatingHeatPump (const HeatPumpWaterToWaterEquationFitHeating &companionHP)
 
Other
boost::optional< double > autosizedReferenceLoadSideFlowRate () const
 
boost::optional< double > autosizedReferenceSourceSideFlowRate () const
 
boost::optional< double > autosizedRatedCoolingCapacity () const
 
boost::optional< double > autosizedRatedCoolingPowerConsumption () const
 
- Public Member Functions inherited from openstudio::model::WaterToWaterComponent
virtual bool addToNode (Node &node)
 
virtual bool addToTertiaryNode (Node &node)
 Add this WaterToWaterComponent to a tertiaryPlantLoop by making connections to the tertiary inlet and outlet. More...
 
virtual ModelObject clone (Model model) const
 
virtual boost::optional
< ModelObject
demandInletModelObject () const
 Returns the optional ModelObject connected to the demand inlet port. More...
 
virtual unsigned demandInletPort () const
 Returns the demand inlet port. More...
 
virtual boost::optional
< ModelObject
demandOutletModelObject () const
 Returns the optional ModelObject connected to the demand outlet port. More...
 
virtual unsigned demandOutletPort () const
 Returns the demand outlet port. More...
 
void disconnect ()
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is a supply component on. More...
 
virtual std::vector
< openstudio::IdfObject > 
remove ()
 
bool removeFromPlantLoop ()
 Removes the component from the plantLoop if one is attached. More...
 
bool removeFromSecondaryPlantLoop ()
 Removes the component from the secondaryPlantLoop if one is attached. More...
 
bool removeFromTertiaryPlantLoop ()
 Removes the component from the tertiaryPlantLoop if one is attached. More...
 
boost::optional< PlantLoopsecondaryPlantLoop () const
 Returns the optional PlantLoop object that the HVAC component is a demand component on. More...
 
virtual boost::optional
< ModelObject
supplyInletModelObject () const
 Returns the optional ModelObject connected to the supply inlet port. More...
 
virtual unsigned supplyInletPort () const
 Returns the supply inlet port. More...
 
virtual boost::optional
< ModelObject
supplyOutletModelObject () const
 Returns the optional ModelObject connected to the supply outlet port. More...
 
virtual unsigned supplyOutletPort () const
 Returns the supply outlet port. More...
 
boost::optional< ModelObjecttertiaryInletModelObject () const
 Returns the optional ModelObject connected to the tertiary inlet. More...
 
boost::optional< ModelObjecttertiaryOutletModelObject () const
 Returns the optional ModelObject connected to the tertiary outlet. More...
 
boost::optional< PlantLooptertiaryPlantLoop () const
 Tertiary plant loop applies to a limited number of WaterToWaterComponent types that interact with three plant systems. More...
 
 WaterToWaterComponent (IddObjectType type, const Model &model)
 
virtual ~WaterToWaterComponent ()
 
- 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< AirLoopHVACairLoopHVAC () 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< HVACComponentcontainingHVACComponent () 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< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
boost::optional< PlantLoopplantLoop () 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< ModelObjectchildren () 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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< HeatPumpWaterToWaterEquationFitCooling
HeatPumpWaterToWaterEquationFitCoolingVector
 
typedef boost::optional
< HeatPumpWaterToWaterEquationFitCooling
OptionalHeatPumpWaterToWaterEquationFitCooling
 

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< ModelObjectchildren () 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

HeatPumpWaterToWaterEquationFitCooling is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:HeatPump:WaterToWater:EquationFit:Cooling'.

Constructor & Destructor Documentation

openstudio::model::HeatPumpWaterToWaterEquationFitCooling::HeatPumpWaterToWaterEquationFitCooling ( const Model model)
explicit
virtual openstudio::model::HeatPumpWaterToWaterEquationFitCooling::~HeatPumpWaterToWaterEquationFitCooling ( )
inlinevirtual

Member Function Documentation

boost::optional<double> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::autosizedRatedCoolingCapacity ( ) const
boost::optional<double> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::autosizedRatedCoolingPowerConsumption ( ) const
boost::optional<double> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::autosizedReferenceLoadSideFlowRate ( ) const
boost::optional<double> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::autosizedReferenceSourceSideFlowRate ( ) const
void openstudio::model::HeatPumpWaterToWaterEquationFitCooling::autosizeRatedCoolingCapacity ( )
void openstudio::model::HeatPumpWaterToWaterEquationFitCooling::autosizeRatedCoolingPowerConsumption ( )
void openstudio::model::HeatPumpWaterToWaterEquationFitCooling::autosizeReferenceLoadSideFlowRate ( )
void openstudio::model::HeatPumpWaterToWaterEquationFitCooling::autosizeReferenceSourceSideFlowRate ( )
boost::optional<HeatPumpWaterToWaterEquationFitHeating> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::companionHeatingHeatPump ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCapacityCoefficient1 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCapacityCoefficient2 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCapacityCoefficient3 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCapacityCoefficient4 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCapacityCoefficient5 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCompressorPowerCoefficient1 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCompressorPowerCoefficient2 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCompressorPowerCoefficient3 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCompressorPowerCoefficient4 ( ) const
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::coolingCompressorPowerCoefficient5 ( ) const
static IddObjectType openstudio::model::HeatPumpWaterToWaterEquationFitCooling::iddObjectType ( )
static
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::isRatedCoolingCapacityAutosized ( ) const
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::isRatedCoolingPowerConsumptionAutosized ( ) const
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::isReferenceLoadSideFlowRateAutosized ( ) const
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::isReferenceSourceSideFlowRateAutosized ( ) const
boost::optional<double> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::ratedCoolingCapacity ( ) const

In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Capacity".

boost::optional<double> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::ratedCoolingPowerConsumption ( ) const

In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Power Consumption".

double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::ratedLoadSideFlowRate ( ) const

Prior to EnergyPlus 8.7.0 this field was not autosizeable.

To preserve backwards compatibility this method will return -999.0 in autosized models.

double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::ratedSourceSideFlowRate ( ) const

Prior to EnergyPlus 8.7.0 this field was not autosizeable.

To preserve backwards compatibility this method will return -999.0 in autosized models.

double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::referenceCoefficientofPerformance ( ) const
boost::optional<double> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::referenceLoadSideFlowRate ( ) const
boost::optional<double> openstudio::model::HeatPumpWaterToWaterEquationFitCooling::referenceSourceSideFlowRate ( ) const
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCompanionHeatingHeatPump ( const HeatPumpWaterToWaterEquationFitHeating companionHP)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCapacityCoefficient1 ( double  coolingCapacityCoefficient1)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCapacityCoefficient2 ( double  coolingCapacityCoefficient2)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCapacityCoefficient3 ( double  coolingCapacityCoefficient3)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCapacityCoefficient4 ( double  coolingCapacityCoefficient4)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCapacityCoefficient5 ( double  coolingCapacityCoefficient5)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCompressorPowerCoefficient1 ( double  coolingCompressorPowerCoefficient1)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCompressorPowerCoefficient2 ( double  coolingCompressorPowerCoefficient2)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCompressorPowerCoefficient3 ( double  coolingCompressorPowerCoefficient3)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCompressorPowerCoefficient4 ( double  coolingCompressorPowerCoefficient4)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setCoolingCompressorPowerCoefficient5 ( double  coolingCompressorPowerCoefficient5)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setRatedCoolingCapacity ( double  ratedCoolingCapacity)

In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Capacity".

bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setRatedCoolingPowerConsumption ( double  ratedCoolingPowerConsumption)

In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Power Consumption".

bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setRatedLoadSideFlowRate ( double  ratedLoadSideFlowRate)

Synonym of setReferenceLoadSideFlowRate for backwards compatibility.

bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setRatedSourceSideFlowRate ( double  ratedSourceSideFlowRate)

Synonym of setReferenceLoadSideFlowRate for backwards compatibility.

bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setReferenceCoefficientofPerformance ( double  referenceCoefficientofPerformance)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setReferenceLoadSideFlowRate ( double  referenceLoadSideFlowRate)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setReferenceSourceSideFlowRate ( double  referenceSourceSideFlowRate)
bool openstudio::model::HeatPumpWaterToWaterEquationFitCooling::setSizingFactor ( double  sizingFactor)
double openstudio::model::HeatPumpWaterToWaterEquationFitCooling::sizingFactor ( ) const

Friends And Related Function Documentation