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

#include <FanVariableVolume.hpp>

+ Inheritance diagram for openstudio::model::FanVariableVolume:

Public Member Functions

Constructors and Destructors
 FanVariableVolume (const Model &model, Schedule &schedule)
 FanVariableVolume (const Model &model)
virtual ~FanVariableVolume ()
Schedule availabilitySchedule () const
double fanTotalEfficiency () const
double fanEfficiency () const
bool isFanTotalEfficiencyDefaulted () const
bool isFanEfficiencyDefaulted () const
double pressureRise () const
boost::optional< double > maximumFlowRate () const
bool isMaximumFlowRateAutosized () const
std::string fanPowerMinimumFlowRateInputMethod () const
bool isFanPowerMinimumFlowRateInputMethodDefaulted () const
double fanPowerMinimumFlowFraction () const
bool isFanPowerMinimumFlowFractionDefaulted () const
boost::optional< double > fanPowerMinimumAirFlowRate () const
double motorEfficiency () const
bool isMotorEfficiencyDefaulted () const
double motorInAirstreamFraction () const
bool isMotorInAirstreamFractionDefaulted () const
boost::optional< double > fanPowerCoefficient1 () const
boost::optional< double > fanPowerCoefficient2 () const
boost::optional< double > fanPowerCoefficient3 () const
boost::optional< double > fanPowerCoefficient4 () const
boost::optional< double > fanPowerCoefficient5 () const
std::string endUseSubcategory () const
bool isEndUseSubcategoryDefaulted () const
bool setAvailabilitySchedule (Schedule &schedule)
bool setFanTotalEfficiency (double fanTotalEfficiency)
void resetFanTotalEfficiency ()
bool setFanEfficiency (double fanTotalEfficiency)
void resetFanEfficiency ()
bool setPressureRise (double pressureRise)
bool setMaximumFlowRate (double maximumFlowRate)
void resetMaximumFlowRate ()
void autosizeMaximumFlowRate ()
bool setFanPowerMinimumFlowRateInputMethod (std::string fanPowerMinimumFlowRateInputMethod)
void resetFanPowerMinimumFlowRateInputMethod ()
bool setFanPowerMinimumFlowFraction (double fanPowerMinimumFlowFraction)
void resetFanPowerMinimumFlowFraction ()
bool setFanPowerMinimumAirFlowRate (double fanPowerMinimumAirFlowRate)
void resetFanPowerMinimumAirFlowRate ()
bool setMotorEfficiency (double motorEfficiency)
void resetMotorEfficiency ()
bool setMotorInAirstreamFraction (double motorInAirstreamFraction)
void resetMotorInAirstreamFraction ()
bool setFanPowerCoefficient1 (double fanPowerCoefficient1)
void resetFanPowerCoefficient1 ()
bool setFanPowerCoefficient2 (double fanPowerCoefficient2)
void resetFanPowerCoefficient2 ()
bool setFanPowerCoefficient3 (double fanPowerCoefficient3)
void resetFanPowerCoefficient3 ()
bool setFanPowerCoefficient4 (double fanPowerCoefficient4)
void resetFanPowerCoefficient4 ()
bool setFanPowerCoefficient5 (double fanPowerCoefficient5)
void resetFanPowerCoefficient5 ()
bool setEndUseSubcategory (std::string endUseSubcategory)
void resetEndUseSubcategory ()
AirflowNetworkFan getAirflowNetworkFan ()
< AirflowNetworkFan
airflowNetworkFan () const
boost::optional< double > autosizedMaximumFlowRate () const
- Public Member Functions inherited from openstudio::model::StraightComponent
bool addToNode (Node &node)
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
ModelObject clone (Model model) const
void disconnect ()
boost::optional< ModelObjectinletModelObject () const
 Returns the optional ModelObject connected to the inlet port. More...
unsigned inletPort () const
 Returns the inlet port. More...
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
unsigned outletPort () const
 Returns the outlet port. More...
< openstudio::IdfObject > 
remove ()
bool removeFromLoop ()
 StraightComponent (IddObjectType type, const Model &model)
virtual ~StraightComponent ()
- 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...
< 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...
< StraightComponent
containingStraightComponent () const
< 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...
< 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 std::vector< std::string > fanPowerMinimumFlowRateInputMethodValues ()
static IddObjectType iddObjectType ()
static std::vector< std::string > validFanPowerMinimumFlowRateInputMethodValues ()

Related Functions

(Note that these are not member functions.)

typedef std::vector
< FanVariableVolume
typedef boost::optional
< FanVariableVolume

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

FanVariableVolume is a StraightComponent that wraps the OpenStudio IDD object 'OS:Fan:VariableVolume'.

Constructor & Destructor Documentation

openstudio::model::FanVariableVolume::FanVariableVolume ( const Model model,
Schedule schedule 
openstudio::model::FanVariableVolume::FanVariableVolume ( const Model model)
virtual openstudio::model::FanVariableVolume::~FanVariableVolume ( )

Member Function Documentation

boost::optional<AirflowNetworkFan> openstudio::model::FanVariableVolume::airflowNetworkFan ( ) const
boost::optional<double> openstudio::model::FanVariableVolume::autosizedMaximumFlowRate ( ) const
void openstudio::model::FanVariableVolume::autosizeMaximumFlowRate ( )
Schedule openstudio::model::FanVariableVolume::availabilitySchedule ( ) const
std::string openstudio::model::FanVariableVolume::endUseSubcategory ( ) const
double openstudio::model::FanVariableVolume::fanEfficiency ( ) const
boost::optional<double> openstudio::model::FanVariableVolume::fanPowerCoefficient1 ( ) const
boost::optional<double> openstudio::model::FanVariableVolume::fanPowerCoefficient2 ( ) const
boost::optional<double> openstudio::model::FanVariableVolume::fanPowerCoefficient3 ( ) const
boost::optional<double> openstudio::model::FanVariableVolume::fanPowerCoefficient4 ( ) const
boost::optional<double> openstudio::model::FanVariableVolume::fanPowerCoefficient5 ( ) const
boost::optional<double> openstudio::model::FanVariableVolume::fanPowerMinimumAirFlowRate ( ) const
double openstudio::model::FanVariableVolume::fanPowerMinimumFlowFraction ( ) const
std::string openstudio::model::FanVariableVolume::fanPowerMinimumFlowRateInputMethod ( ) const
static std::vector<std::string> openstudio::model::FanVariableVolume::fanPowerMinimumFlowRateInputMethodValues ( )
double openstudio::model::FanVariableVolume::fanTotalEfficiency ( ) const
AirflowNetworkFan openstudio::model::FanVariableVolume::getAirflowNetworkFan ( )
static IddObjectType openstudio::model::FanVariableVolume::iddObjectType ( )
bool openstudio::model::FanVariableVolume::isEndUseSubcategoryDefaulted ( ) const
bool openstudio::model::FanVariableVolume::isFanEfficiencyDefaulted ( ) const
bool openstudio::model::FanVariableVolume::isFanPowerMinimumFlowFractionDefaulted ( ) const
bool openstudio::model::FanVariableVolume::isFanPowerMinimumFlowRateInputMethodDefaulted ( ) const
bool openstudio::model::FanVariableVolume::isFanTotalEfficiencyDefaulted ( ) const
bool openstudio::model::FanVariableVolume::isMaximumFlowRateAutosized ( ) const
bool openstudio::model::FanVariableVolume::isMotorEfficiencyDefaulted ( ) const
bool openstudio::model::FanVariableVolume::isMotorInAirstreamFractionDefaulted ( ) const
boost::optional<double> openstudio::model::FanVariableVolume::maximumFlowRate ( ) const
double openstudio::model::FanVariableVolume::motorEfficiency ( ) const
double openstudio::model::FanVariableVolume::motorInAirstreamFraction ( ) const
double openstudio::model::FanVariableVolume::pressureRise ( ) const
void openstudio::model::FanVariableVolume::resetEndUseSubcategory ( )
void openstudio::model::FanVariableVolume::resetFanEfficiency ( )
void openstudio::model::FanVariableVolume::resetFanPowerCoefficient1 ( )
void openstudio::model::FanVariableVolume::resetFanPowerCoefficient2 ( )
void openstudio::model::FanVariableVolume::resetFanPowerCoefficient3 ( )
void openstudio::model::FanVariableVolume::resetFanPowerCoefficient4 ( )
void openstudio::model::FanVariableVolume::resetFanPowerCoefficient5 ( )
void openstudio::model::FanVariableVolume::resetFanPowerMinimumAirFlowRate ( )
void openstudio::model::FanVariableVolume::resetFanPowerMinimumFlowFraction ( )
void openstudio::model::FanVariableVolume::resetFanPowerMinimumFlowRateInputMethod ( )
void openstudio::model::FanVariableVolume::resetFanTotalEfficiency ( )
void openstudio::model::FanVariableVolume::resetMaximumFlowRate ( )
void openstudio::model::FanVariableVolume::resetMotorEfficiency ( )
void openstudio::model::FanVariableVolume::resetMotorInAirstreamFraction ( )
bool openstudio::model::FanVariableVolume::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::FanVariableVolume::setEndUseSubcategory ( std::string  endUseSubcategory)
bool openstudio::model::FanVariableVolume::setFanEfficiency ( double  fanTotalEfficiency)
bool openstudio::model::FanVariableVolume::setFanPowerCoefficient1 ( double  fanPowerCoefficient1)
bool openstudio::model::FanVariableVolume::setFanPowerCoefficient2 ( double  fanPowerCoefficient2)
bool openstudio::model::FanVariableVolume::setFanPowerCoefficient3 ( double  fanPowerCoefficient3)
bool openstudio::model::FanVariableVolume::setFanPowerCoefficient4 ( double  fanPowerCoefficient4)
bool openstudio::model::FanVariableVolume::setFanPowerCoefficient5 ( double  fanPowerCoefficient5)
bool openstudio::model::FanVariableVolume::setFanPowerMinimumAirFlowRate ( double  fanPowerMinimumAirFlowRate)
bool openstudio::model::FanVariableVolume::setFanPowerMinimumFlowFraction ( double  fanPowerMinimumFlowFraction)
bool openstudio::model::FanVariableVolume::setFanPowerMinimumFlowRateInputMethod ( std::string  fanPowerMinimumFlowRateInputMethod)
bool openstudio::model::FanVariableVolume::setFanTotalEfficiency ( double  fanTotalEfficiency)
bool openstudio::model::FanVariableVolume::setMaximumFlowRate ( double  maximumFlowRate)
bool openstudio::model::FanVariableVolume::setMotorEfficiency ( double  motorEfficiency)
bool openstudio::model::FanVariableVolume::setMotorInAirstreamFraction ( double  motorInAirstreamFraction)
bool openstudio::model::FanVariableVolume::setPressureRise ( double  pressureRise)
static std::vector<std::string> openstudio::model::FanVariableVolume::validFanPowerMinimumFlowRateInputMethodValues ( )

Friends And Related Function Documentation

typedef std::vector<FanVariableVolume> FanVariableVolumeVector
typedef boost::optional<FanVariableVolume> OptionalFanVariableVolume