OpenStudio:model
Loading...
Searching...
No Matches
openstudio::model::PumpVariableSpeed Class Reference

#include <PumpVariableSpeed.hpp>

+ Inheritance diagram for openstudio::model::PumpVariableSpeed:

Public Member Functions

Getters
boost::optional< double > ratedFlowRate () const
 In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Maximum Flow Rate".
 
bool isRatedFlowRateDefaulted () const
 
bool isRatedFlowRateAutosized () const
 
double ratedPumpHead () const
 In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Pump Head".
 
bool isRatedPumpHeadDefaulted () const
 
boost::optional< double > ratedPowerConsumption () const
 In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Power Consumption".
 
bool isRatedPowerConsumptionDefaulted () const
 
bool isRatedPowerConsumptionAutosized () const
 
double motorEfficiency () const
 
bool isMotorEfficiencyDefaulted () const
 
double fractionofMotorInefficienciestoFluidStream () const
 
bool isFractionofMotorInefficienciestoFluidStreamDefaulted () const
 
double coefficient1ofthePartLoadPerformanceCurve () const
 
bool isCoefficient1ofthePartLoadPerformanceCurveDefaulted () const
 
double coefficient2ofthePartLoadPerformanceCurve () const
 
bool isCoefficient2ofthePartLoadPerformanceCurveDefaulted () const
 
double coefficient3ofthePartLoadPerformanceCurve () const
 
bool isCoefficient3ofthePartLoadPerformanceCurveDefaulted () const
 
double coefficient4ofthePartLoadPerformanceCurve () const
 
bool isCoefficient4ofthePartLoadPerformanceCurveDefaulted () const
 
double minimumFlowRate () const
 In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Minimum Flow Rate".
 
bool isMinimumFlowRateDefaulted () const
 
std::string pumpControlType () const
 
bool isPumpControlTypeDefaulted () const
 
boost::optional< SchedulepumpFlowRateSchedule () const
 
boost::optional< CurvepumpCurve () const
 
boost::optional< double > impellerDiameter () const
 
boost::optional< std::string > vFDControlType () const
 
boost::optional< SchedulepumpRPMSchedule () const
 
boost::optional< ScheduleminimumPressureSchedule () const
 
boost::optional< SchedulemaximumPressureSchedule () const
 
boost::optional< ScheduleminimumRPMSchedule () const
 
boost::optional< SchedulemaximumRPMSchedule () const
 
std::string endUseSubcategory () const
 
- Public Member Functions inherited from openstudio::model::StraightComponent
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to.
 
boost::optional< ModelObjectinletModelObject () const
 Returns the optional ModelObject connected to the inlet port.
 
unsigned inletPort () const
 Returns the inlet port.
 
StraightComponentoperator= (const StraightComponent &)=default
 
StraightComponentoperator= (StraightComponent &&)=default
 
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port.
 
unsigned outletPort () const
 Returns the outlet port.
 
bool removeFromLoop ()
 
 StraightComponent (const StraightComponent &other)=default
 
 StraightComponent (IddObjectType type, const Model &model)
 
 StraightComponent (StraightComponent &&other)=default
 
virtual ~StraightComponent () override=default
 
- 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.
 
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch.
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to.
 
boost::optional< AirLoopHVACOutdoorAirSystem > airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to.
 
std::vector< AppGFuelTypeappGHeatingFuelTypes () const
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port.
 
ComponentType componentType () const
 
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components.
 
boost::optional< StraightComponentcontainingStraightComponent () const
 
boost::optional< ZoneHVACComponentcontainingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent.
 
std::vector< FuelTypecoolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects.
 
std::vector< FuelTypeheatingFuelTypes () const
 
 HVACComponent (const HVACComponent &other)=default
 
 HVACComponent (HVACComponent &&other)=default
 
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model.
 
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to.
 
HVACComponentoperator= (const HVACComponent &)=default
 
HVACComponentoperator= (HVACComponent &&)=default
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to.
 
std::vector< IdfObjectremove ()
 Removes the HVACComponent from the model only if isRemovable() return true.
 
virtual ~HVACComponent () override=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject () override=default
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model.
 
std::vector< IddObjectTypeallowableChildTypes () const
 Returns a vector of allowable children types.
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject () override=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model().
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model.
 
Component createComponent () const
 Method for creating sharable Model snippets.
 
Model model () const
 Returns the Model that contains this object.
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one.
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject.
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object.
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object.
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index.
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points.
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object.
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data.
 
boost::optional< openstudio::TimeSeriesgetData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object.
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object.
 
std::vector< IdfObjectremoveLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object.
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with.
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary.
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties.
 
std::vector< IdfObjectremoveAdditionalProperties ()
 Removes all additional properties that refer to this object.
 
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
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test
 
bool operator!= (const ModelObject &other) const
 inequality test
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object.
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) const
 Gets the autosized component value from the sql file.
 
virtual std::vector< EMSActuatorNamesemsActuatorNames () const
 Return the names of the available ems actuators.
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables.
 
boost::optional< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool initialized () const
 
bool isSource () const
 
bool isSource () const
 
bool isTarget () const
 
bool isTarget () const
 
unsigned numSources () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
std::vector< openstudio::IdfObjectremove ()
 
std::vector< openstudio::IdfObjectremove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
Workspace workspace () const
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
virtual ~WorkspaceObject () override=default
 
virtual ~WorkspaceObject () override=default
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector< std::string > > clearExtensibleGroups ()
 
std::vector< std::vector< std::string > > clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) const
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< int > getInt (unsigned index, bool returnDefault=false) const
 
boost::optional< int > getInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
Handle handle () const
 
IddObject iddObject () const
 
IddObject iddObject () const
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (IdfObject &&other) noexcept
 
 IdfObject (IdfObject &&other) noexcept
 
void initializeFields (bool fill_default=false)
 
void initializeFields (bool fill_default=false)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
bool operator== (const IdfObject &other) const
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
virtual ~IdfObject ()=default
 
virtual ~IdfObject ()=default
 

Related Symbols

(Note that these are not member symbols.)

using OptionalPumpVariableSpeed = boost::optional<PumpVariableSpeed>
 
using PumpVariableSpeedVector = std::vector<PumpVariableSpeed>
 

Constructors and Destructors

 PumpVariableSpeed (const Model &model)
 
virtual ~PumpVariableSpeed () override=default
 
 PumpVariableSpeed (const PumpVariableSpeed &other)=default
 
 PumpVariableSpeed (PumpVariableSpeed &&other)=default
 
PumpVariableSpeedoperator= (const PumpVariableSpeed &)=default
 
PumpVariableSpeedoperator= (PumpVariableSpeed &&)=default
 
static IddObjectType iddObjectType ()
 
static std::vector< std::string > pumpControlTypeValues ()
 
static std::vector< std::string > designPowerSizingMethodValues ()
 
static std::vector< std::string > validPumpControlTypeValues ()
 
static std::vector< std::string > vfdControlTypeValues ()
 

Setters

bool setRatedFlowRate (double ratedFlowRate)
 
void resetRatedFlowRate ()
 
void autosizeRatedFlowRate ()
 
bool setRatedPumpHead (double ratedPumpHead)
 
void resetRatedPumpHead ()
 
bool setRatedPowerConsumption (double ratedPowerConsumption)
 
void resetRatedPowerConsumption ()
 
void autosizeRatedPowerConsumption ()
 
bool setMotorEfficiency (double motorEfficiency)
 
void resetMotorEfficiency ()
 
bool setFractionofMotorInefficienciestoFluidStream (double fractionofMotorInefficienciestoFluidStream)
 
void resetFractionofMotorInefficienciestoFluidStream ()
 
bool setCoefficient1ofthePartLoadPerformanceCurve (double coefficient1ofthePartLoadPerformanceCurve)
 
void resetCoefficient1ofthePartLoadPerformanceCurve ()
 
bool setCoefficient2ofthePartLoadPerformanceCurve (double coefficient2ofthePartLoadPerformanceCurve)
 
void resetCoefficient2ofthePartLoadPerformanceCurve ()
 
bool setCoefficient3ofthePartLoadPerformanceCurve (double coefficient3ofthePartLoadPerformanceCurve)
 
void resetCoefficient3ofthePartLoadPerformanceCurve ()
 
bool setCoefficient4ofthePartLoadPerformanceCurve (double coefficient4ofthePartLoadPerformanceCurve)
 
void resetCoefficient4ofthePartLoadPerformanceCurve ()
 
bool setMinimumFlowRate (double minimumFlowRate)
 
void resetMinimumFlowRate ()
 
bool setPumpControlType (const std::string &pumpControlType)
 
void resetPumpControlType ()
 
bool setPumpFlowRateSchedule (Schedule &schedule)
 
void resetPumpFlowRateSchedule ()
 
bool setPumpCurve (const Curve &curve)
 Returns false if curve is not a CurveLinear, CurveQuadratic, CurveCubic or CurveQuartic.
 
void resetPumpCurve ()
 
bool setImpellerDiameter (double impellerDiameter)
 
void resetImpellerDiameter ()
 
bool setVFDControlType (const std::string &vFDControlType)
 
void resetVFDControlType ()
 
bool setPumpRPMSchedule (Schedule &schedule)
 
void resetPumpRPMSchedule ()
 
bool setMinimumPressureSchedule (Schedule &schedule)
 
void resetMinimumPressureSchedule ()
 
bool setMaximumPressureSchedule (Schedule &schedule)
 
void resetMaximumPressureSchedule ()
 
bool setMinimumRPMSchedule (Schedule &schedule)
 
void resetMinimumRPMSchedule ()
 
bool setMaximumRPMSchedule (Schedule &schedule)
 
void resetMaximumRPMSchedule ()
 
boost::optional< double > autosizedRatedFlowRate () const
 
boost::optional< double > autosizedRatedPowerConsumption () const
 
std::string designPowerSizingMethod () const
 
bool setDesignPowerSizingMethod (const std::string &designPowerSizingMethod)
 
double designElectricPowerPerUnitFlowRate () const
 
bool setDesignElectricPowerPerUnitFlowRate (double designElectricPowerPerUnitFlowRate)
 
double designShaftPowerPerUnitFlowRatePerUnitHead () const
 
bool setDesignShaftPowerPerUnitFlowRatePerUnitHead (double designShaftPowerPerUnitFlowRatePerUnitHead)
 
boost::optional< ThermalZonezone () const
 
bool setZone (const ThermalZone &thermalZone)
 
void resetZone ()
 
double skinLossRadiativeFraction () const
 
bool setSkinLossRadiativeFraction (double skinLossRadiativeFraction)
 
double designMinimumFlowRateFraction () const
 
bool setDesignMinimumFlowRateFraction (double designMinimumFlowRateFraction)
 
bool setEndUseSubcategory (const std::string &endUseSubcategory)
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObjectOptionalWorkspaceObject
 
typedef std::vector< WorkspaceObjectWorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObjectIdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional< IdfObjectOptionalIdfObject
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 
- Protected Types inherited from openstudio::model::HVACComponent
using ImplType = detail::HVACComponent_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 
- 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.
 
- 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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Detailed Description

PumpVariableSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:Pump:VariableSpeed'.

Constructor & Destructor Documentation

◆ PumpVariableSpeed() [1/3]

openstudio::model::PumpVariableSpeed::PumpVariableSpeed ( const Model & model)
explicit

◆ ~PumpVariableSpeed()

virtual openstudio::model::PumpVariableSpeed::~PumpVariableSpeed ( )
overridevirtualdefault

◆ PumpVariableSpeed() [2/3]

openstudio::model::PumpVariableSpeed::PumpVariableSpeed ( const PumpVariableSpeed & other)
default

◆ PumpVariableSpeed() [3/3]

openstudio::model::PumpVariableSpeed::PumpVariableSpeed ( PumpVariableSpeed && other)
default

Member Function Documentation

◆ autosizedRatedFlowRate()

boost::optional< double > openstudio::model::PumpVariableSpeed::autosizedRatedFlowRate ( ) const

◆ autosizedRatedPowerConsumption()

boost::optional< double > openstudio::model::PumpVariableSpeed::autosizedRatedPowerConsumption ( ) const

◆ autosizeRatedFlowRate()

void openstudio::model::PumpVariableSpeed::autosizeRatedFlowRate ( )

◆ autosizeRatedPowerConsumption()

void openstudio::model::PumpVariableSpeed::autosizeRatedPowerConsumption ( )

◆ coefficient1ofthePartLoadPerformanceCurve()

double openstudio::model::PumpVariableSpeed::coefficient1ofthePartLoadPerformanceCurve ( ) const

◆ coefficient2ofthePartLoadPerformanceCurve()

double openstudio::model::PumpVariableSpeed::coefficient2ofthePartLoadPerformanceCurve ( ) const

◆ coefficient3ofthePartLoadPerformanceCurve()

double openstudio::model::PumpVariableSpeed::coefficient3ofthePartLoadPerformanceCurve ( ) const

◆ coefficient4ofthePartLoadPerformanceCurve()

double openstudio::model::PumpVariableSpeed::coefficient4ofthePartLoadPerformanceCurve ( ) const

◆ designElectricPowerPerUnitFlowRate()

double openstudio::model::PumpVariableSpeed::designElectricPowerPerUnitFlowRate ( ) const

◆ designMinimumFlowRateFraction()

double openstudio::model::PumpVariableSpeed::designMinimumFlowRateFraction ( ) const

◆ designPowerSizingMethod()

std::string openstudio::model::PumpVariableSpeed::designPowerSizingMethod ( ) const

◆ designPowerSizingMethodValues()

static std::vector< std::string > openstudio::model::PumpVariableSpeed::designPowerSizingMethodValues ( )
static

◆ designShaftPowerPerUnitFlowRatePerUnitHead()

double openstudio::model::PumpVariableSpeed::designShaftPowerPerUnitFlowRatePerUnitHead ( ) const

◆ endUseSubcategory()

std::string openstudio::model::PumpVariableSpeed::endUseSubcategory ( ) const

◆ fractionofMotorInefficienciestoFluidStream()

double openstudio::model::PumpVariableSpeed::fractionofMotorInefficienciestoFluidStream ( ) const

◆ iddObjectType()

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

◆ impellerDiameter()

boost::optional< double > openstudio::model::PumpVariableSpeed::impellerDiameter ( ) const

◆ isCoefficient1ofthePartLoadPerformanceCurveDefaulted()

bool openstudio::model::PumpVariableSpeed::isCoefficient1ofthePartLoadPerformanceCurveDefaulted ( ) const

◆ isCoefficient2ofthePartLoadPerformanceCurveDefaulted()

bool openstudio::model::PumpVariableSpeed::isCoefficient2ofthePartLoadPerformanceCurveDefaulted ( ) const

◆ isCoefficient3ofthePartLoadPerformanceCurveDefaulted()

bool openstudio::model::PumpVariableSpeed::isCoefficient3ofthePartLoadPerformanceCurveDefaulted ( ) const

◆ isCoefficient4ofthePartLoadPerformanceCurveDefaulted()

bool openstudio::model::PumpVariableSpeed::isCoefficient4ofthePartLoadPerformanceCurveDefaulted ( ) const

◆ isFractionofMotorInefficienciestoFluidStreamDefaulted()

bool openstudio::model::PumpVariableSpeed::isFractionofMotorInefficienciestoFluidStreamDefaulted ( ) const

◆ isMinimumFlowRateDefaulted()

bool openstudio::model::PumpVariableSpeed::isMinimumFlowRateDefaulted ( ) const

◆ isMotorEfficiencyDefaulted()

bool openstudio::model::PumpVariableSpeed::isMotorEfficiencyDefaulted ( ) const

◆ isPumpControlTypeDefaulted()

bool openstudio::model::PumpVariableSpeed::isPumpControlTypeDefaulted ( ) const

◆ isRatedFlowRateAutosized()

bool openstudio::model::PumpVariableSpeed::isRatedFlowRateAutosized ( ) const

◆ isRatedFlowRateDefaulted()

bool openstudio::model::PumpVariableSpeed::isRatedFlowRateDefaulted ( ) const

◆ isRatedPowerConsumptionAutosized()

bool openstudio::model::PumpVariableSpeed::isRatedPowerConsumptionAutosized ( ) const

◆ isRatedPowerConsumptionDefaulted()

bool openstudio::model::PumpVariableSpeed::isRatedPowerConsumptionDefaulted ( ) const

◆ isRatedPumpHeadDefaulted()

bool openstudio::model::PumpVariableSpeed::isRatedPumpHeadDefaulted ( ) const

◆ maximumPressureSchedule()

boost::optional< Schedule > openstudio::model::PumpVariableSpeed::maximumPressureSchedule ( ) const

◆ maximumRPMSchedule()

boost::optional< Schedule > openstudio::model::PumpVariableSpeed::maximumRPMSchedule ( ) const

◆ minimumFlowRate()

double openstudio::model::PumpVariableSpeed::minimumFlowRate ( ) const

In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Minimum Flow Rate".

◆ minimumPressureSchedule()

boost::optional< Schedule > openstudio::model::PumpVariableSpeed::minimumPressureSchedule ( ) const

◆ minimumRPMSchedule()

boost::optional< Schedule > openstudio::model::PumpVariableSpeed::minimumRPMSchedule ( ) const

◆ motorEfficiency()

double openstudio::model::PumpVariableSpeed::motorEfficiency ( ) const

◆ operator=() [1/2]

PumpVariableSpeed & openstudio::model::PumpVariableSpeed::operator= ( const PumpVariableSpeed & )
default

◆ operator=() [2/2]

PumpVariableSpeed & openstudio::model::PumpVariableSpeed::operator= ( PumpVariableSpeed && )
default

◆ pumpControlType()

std::string openstudio::model::PumpVariableSpeed::pumpControlType ( ) const

◆ pumpControlTypeValues()

static std::vector< std::string > openstudio::model::PumpVariableSpeed::pumpControlTypeValues ( )
static

◆ pumpCurve()

boost::optional< Curve > openstudio::model::PumpVariableSpeed::pumpCurve ( ) const

◆ pumpFlowRateSchedule()

boost::optional< Schedule > openstudio::model::PumpVariableSpeed::pumpFlowRateSchedule ( ) const

◆ pumpRPMSchedule()

boost::optional< Schedule > openstudio::model::PumpVariableSpeed::pumpRPMSchedule ( ) const

◆ ratedFlowRate()

boost::optional< double > openstudio::model::PumpVariableSpeed::ratedFlowRate ( ) const

In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Maximum Flow Rate".

◆ ratedPowerConsumption()

boost::optional< double > openstudio::model::PumpVariableSpeed::ratedPowerConsumption ( ) const

In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Power Consumption".

◆ ratedPumpHead()

double openstudio::model::PumpVariableSpeed::ratedPumpHead ( ) const

In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Pump Head".

◆ resetCoefficient1ofthePartLoadPerformanceCurve()

void openstudio::model::PumpVariableSpeed::resetCoefficient1ofthePartLoadPerformanceCurve ( )

◆ resetCoefficient2ofthePartLoadPerformanceCurve()

void openstudio::model::PumpVariableSpeed::resetCoefficient2ofthePartLoadPerformanceCurve ( )

◆ resetCoefficient3ofthePartLoadPerformanceCurve()

void openstudio::model::PumpVariableSpeed::resetCoefficient3ofthePartLoadPerformanceCurve ( )

◆ resetCoefficient4ofthePartLoadPerformanceCurve()

void openstudio::model::PumpVariableSpeed::resetCoefficient4ofthePartLoadPerformanceCurve ( )

◆ resetFractionofMotorInefficienciestoFluidStream()

void openstudio::model::PumpVariableSpeed::resetFractionofMotorInefficienciestoFluidStream ( )

◆ resetImpellerDiameter()

void openstudio::model::PumpVariableSpeed::resetImpellerDiameter ( )

◆ resetMaximumPressureSchedule()

void openstudio::model::PumpVariableSpeed::resetMaximumPressureSchedule ( )

◆ resetMaximumRPMSchedule()

void openstudio::model::PumpVariableSpeed::resetMaximumRPMSchedule ( )

◆ resetMinimumFlowRate()

void openstudio::model::PumpVariableSpeed::resetMinimumFlowRate ( )

◆ resetMinimumPressureSchedule()

void openstudio::model::PumpVariableSpeed::resetMinimumPressureSchedule ( )

◆ resetMinimumRPMSchedule()

void openstudio::model::PumpVariableSpeed::resetMinimumRPMSchedule ( )

◆ resetMotorEfficiency()

void openstudio::model::PumpVariableSpeed::resetMotorEfficiency ( )

◆ resetPumpControlType()

void openstudio::model::PumpVariableSpeed::resetPumpControlType ( )

◆ resetPumpCurve()

void openstudio::model::PumpVariableSpeed::resetPumpCurve ( )

◆ resetPumpFlowRateSchedule()

void openstudio::model::PumpVariableSpeed::resetPumpFlowRateSchedule ( )

◆ resetPumpRPMSchedule()

void openstudio::model::PumpVariableSpeed::resetPumpRPMSchedule ( )

◆ resetRatedFlowRate()

void openstudio::model::PumpVariableSpeed::resetRatedFlowRate ( )

◆ resetRatedPowerConsumption()

void openstudio::model::PumpVariableSpeed::resetRatedPowerConsumption ( )

◆ resetRatedPumpHead()

void openstudio::model::PumpVariableSpeed::resetRatedPumpHead ( )

◆ resetVFDControlType()

void openstudio::model::PumpVariableSpeed::resetVFDControlType ( )

◆ resetZone()

void openstudio::model::PumpVariableSpeed::resetZone ( )

◆ setCoefficient1ofthePartLoadPerformanceCurve()

bool openstudio::model::PumpVariableSpeed::setCoefficient1ofthePartLoadPerformanceCurve ( double coefficient1ofthePartLoadPerformanceCurve)

◆ setCoefficient2ofthePartLoadPerformanceCurve()

bool openstudio::model::PumpVariableSpeed::setCoefficient2ofthePartLoadPerformanceCurve ( double coefficient2ofthePartLoadPerformanceCurve)

◆ setCoefficient3ofthePartLoadPerformanceCurve()

bool openstudio::model::PumpVariableSpeed::setCoefficient3ofthePartLoadPerformanceCurve ( double coefficient3ofthePartLoadPerformanceCurve)

◆ setCoefficient4ofthePartLoadPerformanceCurve()

bool openstudio::model::PumpVariableSpeed::setCoefficient4ofthePartLoadPerformanceCurve ( double coefficient4ofthePartLoadPerformanceCurve)

◆ setDesignElectricPowerPerUnitFlowRate()

bool openstudio::model::PumpVariableSpeed::setDesignElectricPowerPerUnitFlowRate ( double designElectricPowerPerUnitFlowRate)

◆ setDesignMinimumFlowRateFraction()

bool openstudio::model::PumpVariableSpeed::setDesignMinimumFlowRateFraction ( double designMinimumFlowRateFraction)

◆ setDesignPowerSizingMethod()

bool openstudio::model::PumpVariableSpeed::setDesignPowerSizingMethod ( const std::string & designPowerSizingMethod)

◆ setDesignShaftPowerPerUnitFlowRatePerUnitHead()

bool openstudio::model::PumpVariableSpeed::setDesignShaftPowerPerUnitFlowRatePerUnitHead ( double designShaftPowerPerUnitFlowRatePerUnitHead)

◆ setEndUseSubcategory()

bool openstudio::model::PumpVariableSpeed::setEndUseSubcategory ( const std::string & endUseSubcategory)

◆ setFractionofMotorInefficienciestoFluidStream()

bool openstudio::model::PumpVariableSpeed::setFractionofMotorInefficienciestoFluidStream ( double fractionofMotorInefficienciestoFluidStream)

◆ setImpellerDiameter()

bool openstudio::model::PumpVariableSpeed::setImpellerDiameter ( double impellerDiameter)

◆ setMaximumPressureSchedule()

bool openstudio::model::PumpVariableSpeed::setMaximumPressureSchedule ( Schedule & schedule)

◆ setMaximumRPMSchedule()

bool openstudio::model::PumpVariableSpeed::setMaximumRPMSchedule ( Schedule & schedule)

◆ setMinimumFlowRate()

bool openstudio::model::PumpVariableSpeed::setMinimumFlowRate ( double minimumFlowRate)

◆ setMinimumPressureSchedule()

bool openstudio::model::PumpVariableSpeed::setMinimumPressureSchedule ( Schedule & schedule)

◆ setMinimumRPMSchedule()

bool openstudio::model::PumpVariableSpeed::setMinimumRPMSchedule ( Schedule & schedule)

◆ setMotorEfficiency()

bool openstudio::model::PumpVariableSpeed::setMotorEfficiency ( double motorEfficiency)

◆ setPumpControlType()

bool openstudio::model::PumpVariableSpeed::setPumpControlType ( const std::string & pumpControlType)

◆ setPumpCurve()

bool openstudio::model::PumpVariableSpeed::setPumpCurve ( const Curve & curve)

Returns false if curve is not a CurveLinear, CurveQuadratic, CurveCubic or CurveQuartic.

◆ setPumpFlowRateSchedule()

bool openstudio::model::PumpVariableSpeed::setPumpFlowRateSchedule ( Schedule & schedule)

◆ setPumpRPMSchedule()

bool openstudio::model::PumpVariableSpeed::setPumpRPMSchedule ( Schedule & schedule)

◆ setRatedFlowRate()

bool openstudio::model::PumpVariableSpeed::setRatedFlowRate ( double ratedFlowRate)

◆ setRatedPowerConsumption()

bool openstudio::model::PumpVariableSpeed::setRatedPowerConsumption ( double ratedPowerConsumption)

◆ setRatedPumpHead()

bool openstudio::model::PumpVariableSpeed::setRatedPumpHead ( double ratedPumpHead)

◆ setSkinLossRadiativeFraction()

bool openstudio::model::PumpVariableSpeed::setSkinLossRadiativeFraction ( double skinLossRadiativeFraction)

◆ setVFDControlType()

bool openstudio::model::PumpVariableSpeed::setVFDControlType ( const std::string & vFDControlType)

◆ setZone()

bool openstudio::model::PumpVariableSpeed::setZone ( const ThermalZone & thermalZone)

◆ skinLossRadiativeFraction()

double openstudio::model::PumpVariableSpeed::skinLossRadiativeFraction ( ) const

◆ validPumpControlTypeValues()

static std::vector< std::string > openstudio::model::PumpVariableSpeed::validPumpControlTypeValues ( )
static

◆ vFDControlType()

boost::optional< std::string > openstudio::model::PumpVariableSpeed::vFDControlType ( ) const

◆ vfdControlTypeValues()

static std::vector< std::string > openstudio::model::PumpVariableSpeed::vfdControlTypeValues ( )
static

◆ zone()

boost::optional< ThermalZone > openstudio::model::PumpVariableSpeed::zone ( ) const

Friends And Related Symbol Documentation

◆ OptionalPumpVariableSpeed

using OptionalPumpVariableSpeed = boost::optional<PumpVariableSpeed>
related

◆ PumpVariableSpeedVector

using PumpVariableSpeedVector = std::vector<PumpVariableSpeed>
related