OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "PumpVariableSpeed.hpp"

Inheritance diagram for openstudio::model::PumpVariableSpeed:

Public Member Functions

 PumpVariableSpeed (const Model &model)
virtual ~PumpVariableSpeed () override=default
 PumpVariableSpeed (const PumpVariableSpeed &other)=default
 PumpVariableSpeed (PumpVariableSpeed &&other)=default
PumpVariableSpeedoperator= (const PumpVariableSpeed &)=default
PumpVariableSpeedoperator= (PumpVariableSpeed &&)=default
boost::optional< double > ratedFlowRate () const
bool isRatedFlowRateDefaulted () const
bool isRatedFlowRateAutosized () const
double ratedPumpHead () const
bool isRatedPumpHeadDefaulted () const
boost::optional< double > ratedPowerConsumption () const
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
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
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)
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)

Static Public Member Functions

static std::vector< std::string > designPowerSizingMethodValues ()
static IddObjectType iddObjectType ()
static std::vector< std::string > pumpControlTypeValues ()
static std::vector< std::string > validPumpControlTypeValues ()
static std::vector< std::string > vfdControlTypeValues ()

Related Functions

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

Detailed Description

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

Constructor & Destructor Documentation

openstudio::model::PumpVariableSpeed::PumpVariableSpeed ( const Model model)
explicit
virtual openstudio::model::PumpVariableSpeed::~PumpVariableSpeed ( )
overridevirtualdefault
openstudio::model::PumpVariableSpeed::PumpVariableSpeed ( const PumpVariableSpeed other)
default
openstudio::model::PumpVariableSpeed::PumpVariableSpeed ( PumpVariableSpeed &&  other)
default

Member Function Documentation

boost::optional<double> openstudio::model::PumpVariableSpeed::autosizedRatedFlowRate ( ) const
boost::optional<double> openstudio::model::PumpVariableSpeed::autosizedRatedPowerConsumption ( ) const
void openstudio::model::PumpVariableSpeed::autosizeRatedFlowRate ( )
void openstudio::model::PumpVariableSpeed::autosizeRatedPowerConsumption ( )
double openstudio::model::PumpVariableSpeed::coefficient1ofthePartLoadPerformanceCurve ( ) const
double openstudio::model::PumpVariableSpeed::coefficient2ofthePartLoadPerformanceCurve ( ) const
double openstudio::model::PumpVariableSpeed::coefficient3ofthePartLoadPerformanceCurve ( ) const
double openstudio::model::PumpVariableSpeed::coefficient4ofthePartLoadPerformanceCurve ( ) const
double openstudio::model::PumpVariableSpeed::designElectricPowerPerUnitFlowRate ( ) const
double openstudio::model::PumpVariableSpeed::designMinimumFlowRateFraction ( ) const
std::string openstudio::model::PumpVariableSpeed::designPowerSizingMethod ( ) const
static std::vector<std::string> openstudio::model::PumpVariableSpeed::designPowerSizingMethodValues ( )
static
double openstudio::model::PumpVariableSpeed::designShaftPowerPerUnitFlowRatePerUnitHead ( ) const
std::string openstudio::model::PumpVariableSpeed::endUseSubcategory ( ) const
double openstudio::model::PumpVariableSpeed::fractionofMotorInefficienciestoFluidStream ( ) const
static IddObjectType openstudio::model::PumpVariableSpeed::iddObjectType ( )
static
boost::optional<double> openstudio::model::PumpVariableSpeed::impellerDiameter ( ) const
bool openstudio::model::PumpVariableSpeed::isCoefficient1ofthePartLoadPerformanceCurveDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isCoefficient2ofthePartLoadPerformanceCurveDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isCoefficient3ofthePartLoadPerformanceCurveDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isCoefficient4ofthePartLoadPerformanceCurveDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isFractionofMotorInefficienciestoFluidStreamDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isMinimumFlowRateDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isMotorEfficiencyDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isPumpControlTypeDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isRatedFlowRateAutosized ( ) const
bool openstudio::model::PumpVariableSpeed::isRatedFlowRateDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isRatedPowerConsumptionAutosized ( ) const
bool openstudio::model::PumpVariableSpeed::isRatedPowerConsumptionDefaulted ( ) const
bool openstudio::model::PumpVariableSpeed::isRatedPumpHeadDefaulted ( ) const
boost::optional<Schedule> openstudio::model::PumpVariableSpeed::maximumPressureSchedule ( ) const
boost::optional<Schedule> openstudio::model::PumpVariableSpeed::maximumRPMSchedule ( ) const
double openstudio::model::PumpVariableSpeed::minimumFlowRate ( ) const

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

boost::optional<Schedule> openstudio::model::PumpVariableSpeed::minimumPressureSchedule ( ) const
boost::optional<Schedule> openstudio::model::PumpVariableSpeed::minimumRPMSchedule ( ) const
double openstudio::model::PumpVariableSpeed::motorEfficiency ( ) const
PumpVariableSpeed& openstudio::model::PumpVariableSpeed::operator= ( const PumpVariableSpeed )
default
PumpVariableSpeed& openstudio::model::PumpVariableSpeed::operator= ( PumpVariableSpeed &&  )
default
std::string openstudio::model::PumpVariableSpeed::pumpControlType ( ) const
static std::vector<std::string> openstudio::model::PumpVariableSpeed::pumpControlTypeValues ( )
static
boost::optional<Curve> openstudio::model::PumpVariableSpeed::pumpCurve ( ) const
boost::optional<Schedule> openstudio::model::PumpVariableSpeed::pumpFlowRateSchedule ( ) const
boost::optional<Schedule> openstudio::model::PumpVariableSpeed::pumpRPMSchedule ( ) const
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".

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".

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

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

void openstudio::model::PumpVariableSpeed::resetCoefficient1ofthePartLoadPerformanceCurve ( )
void openstudio::model::PumpVariableSpeed::resetCoefficient2ofthePartLoadPerformanceCurve ( )
void openstudio::model::PumpVariableSpeed::resetCoefficient3ofthePartLoadPerformanceCurve ( )
void openstudio::model::PumpVariableSpeed::resetCoefficient4ofthePartLoadPerformanceCurve ( )
void openstudio::model::PumpVariableSpeed::resetFractionofMotorInefficienciestoFluidStream ( )
void openstudio::model::PumpVariableSpeed::resetImpellerDiameter ( )
void openstudio::model::PumpVariableSpeed::resetMaximumPressureSchedule ( )
void openstudio::model::PumpVariableSpeed::resetMaximumRPMSchedule ( )
void openstudio::model::PumpVariableSpeed::resetMinimumFlowRate ( )
void openstudio::model::PumpVariableSpeed::resetMinimumPressureSchedule ( )
void openstudio::model::PumpVariableSpeed::resetMinimumRPMSchedule ( )
void openstudio::model::PumpVariableSpeed::resetMotorEfficiency ( )
void openstudio::model::PumpVariableSpeed::resetPumpControlType ( )
void openstudio::model::PumpVariableSpeed::resetPumpCurve ( )
void openstudio::model::PumpVariableSpeed::resetPumpFlowRateSchedule ( )
void openstudio::model::PumpVariableSpeed::resetPumpRPMSchedule ( )
void openstudio::model::PumpVariableSpeed::resetRatedFlowRate ( )
void openstudio::model::PumpVariableSpeed::resetRatedPowerConsumption ( )
void openstudio::model::PumpVariableSpeed::resetRatedPumpHead ( )
void openstudio::model::PumpVariableSpeed::resetVFDControlType ( )
void openstudio::model::PumpVariableSpeed::resetZone ( )
bool openstudio::model::PumpVariableSpeed::setCoefficient1ofthePartLoadPerformanceCurve ( double  coefficient1ofthePartLoadPerformanceCurve)
bool openstudio::model::PumpVariableSpeed::setCoefficient2ofthePartLoadPerformanceCurve ( double  coefficient2ofthePartLoadPerformanceCurve)
bool openstudio::model::PumpVariableSpeed::setCoefficient3ofthePartLoadPerformanceCurve ( double  coefficient3ofthePartLoadPerformanceCurve)
bool openstudio::model::PumpVariableSpeed::setCoefficient4ofthePartLoadPerformanceCurve ( double  coefficient4ofthePartLoadPerformanceCurve)
bool openstudio::model::PumpVariableSpeed::setDesignElectricPowerPerUnitFlowRate ( double  designElectricPowerPerUnitFlowRate)
bool openstudio::model::PumpVariableSpeed::setDesignMinimumFlowRateFraction ( double  designMinimumFlowRateFraction)
bool openstudio::model::PumpVariableSpeed::setDesignPowerSizingMethod ( const std::string &  designPowerSizingMethod)
bool openstudio::model::PumpVariableSpeed::setDesignShaftPowerPerUnitFlowRatePerUnitHead ( double  designShaftPowerPerUnitFlowRatePerUnitHead)
bool openstudio::model::PumpVariableSpeed::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::PumpVariableSpeed::setFractionofMotorInefficienciestoFluidStream ( double  fractionofMotorInefficienciestoFluidStream)
bool openstudio::model::PumpVariableSpeed::setImpellerDiameter ( double  impellerDiameter)
bool openstudio::model::PumpVariableSpeed::setMaximumPressureSchedule ( Schedule schedule)
bool openstudio::model::PumpVariableSpeed::setMaximumRPMSchedule ( Schedule schedule)
bool openstudio::model::PumpVariableSpeed::setMinimumFlowRate ( double  minimumFlowRate)
bool openstudio::model::PumpVariableSpeed::setMinimumPressureSchedule ( Schedule schedule)
bool openstudio::model::PumpVariableSpeed::setMinimumRPMSchedule ( Schedule schedule)
bool openstudio::model::PumpVariableSpeed::setMotorEfficiency ( double  motorEfficiency)
bool openstudio::model::PumpVariableSpeed::setPumpControlType ( const std::string &  pumpControlType)
bool openstudio::model::PumpVariableSpeed::setPumpCurve ( const Curve curve)

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

bool openstudio::model::PumpVariableSpeed::setPumpFlowRateSchedule ( Schedule schedule)
bool openstudio::model::PumpVariableSpeed::setPumpRPMSchedule ( Schedule schedule)
bool openstudio::model::PumpVariableSpeed::setRatedFlowRate ( double  ratedFlowRate)
bool openstudio::model::PumpVariableSpeed::setRatedPowerConsumption ( double  ratedPowerConsumption)
bool openstudio::model::PumpVariableSpeed::setRatedPumpHead ( double  ratedPumpHead)
bool openstudio::model::PumpVariableSpeed::setSkinLossRadiativeFraction ( double  skinLossRadiativeFraction)
bool openstudio::model::PumpVariableSpeed::setVFDControlType ( const std::string &  vFDControlType)
bool openstudio::model::PumpVariableSpeed::setZone ( const ThermalZone thermalZone)
double openstudio::model::PumpVariableSpeed::skinLossRadiativeFraction ( ) const
static std::vector<std::string> openstudio::model::PumpVariableSpeed::validPumpControlTypeValues ( )
static
boost::optional<std::string> openstudio::model::PumpVariableSpeed::vFDControlType ( ) const
static std::vector<std::string> openstudio::model::PumpVariableSpeed::vfdControlTypeValues ( )
static
boost::optional<ThermalZone> openstudio::model::PumpVariableSpeed::zone ( ) const

Friends And Related Function Documentation

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