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

#include <FanSystemModel.hpp>

+ Inheritance diagram for openstudio::model::FanSystemModel:

Public Member Functions

Constructors and Destructors
 FanSystemModel (const Model &model)
virtual ~FanSystemModel ()
Schedule availabilitySchedule () const
boost::optional< double > designMaximumAirFlowRate () const
bool isDesignMaximumAirFlowRateAutosized () const
boost::optional< double > autosizedDesignMaximumAirFlowRate ()
std::string speedControlMethod () const
double electricPowerMinimumFlowRateFraction () const
double designPressureRise () const
double motorEfficiency () const
double motorInAirStreamFraction () const
boost::optional< double > designElectricPowerConsumption () const
bool isDesignElectricPowerConsumptionAutosized () const
boost::optional< double > autosizedDesignElectricPowerConsumption ()
std::string designPowerSizingMethod () const
double electricPowerPerUnitFlowRate () const
double electricPowerPerUnitFlowRatePerUnitPressure () const
double fanTotalEfficiency () const
boost::optional< CurveelectricPowerFunctionofFlowFractionCurve () const
boost::optional< double > nightVentilationModePressureRise () const
boost::optional< double > nightVentilationModeFlowFraction () const
boost::optional< ThermalZonemotorLossZone () const
double motorLossRadiativeFraction () const
std::string endUseSubcategory () const
unsigned numberofSpeeds () const
std::vector< FanSystemModelSpeedspeeds () const
boost::optional< unsigned > speedIndex (const FanSystemModelSpeed &speed) const
 Find a given speed by the flowFraction (key) More...
< FanSystemModelSpeed
getSpeed (unsigned speedIndex) const
bool addSpeed (const FanSystemModelSpeed &speed)
 If a speed group is already present (= the flowFraction already exists) (cf speedIndex()), it will Warn and override the electricPowerFraction value. More...
bool addSpeed (double flowFraction, double electricPowerFraction)
bool removeSpeed (unsigned speedIndex)
void removeAllSpeeds ()
bool setSpeeds (const std::vector< FanSystemModelSpeed > &speeds)
bool setAvailabilitySchedule (Schedule &schedule)
bool setDesignMaximumAirFlowRate (double designMaximumAirFlowRate)
void autosizeDesignMaximumAirFlowRate ()
bool setSpeedControlMethod (const std::string &speedControlMethod)
bool setElectricPowerMinimumFlowRateFraction (double electricPowerMinimumFlowRateFraction)
bool setDesignPressureRise (double designPressureRise)
bool setMotorEfficiency (double motorEfficiency)
bool setMotorInAirStreamFraction (double motorInAirStreamFraction)
bool setDesignElectricPowerConsumption (double designElectricPowerConsumption)
void autosizeDesignElectricPowerConsumption ()
bool setDesignPowerSizingMethod (const std::string &designPowerSizingMethod)
bool setElectricPowerPerUnitFlowRate (double electricPowerPerUnitFlowRate)
bool setElectricPowerPerUnitFlowRatePerUnitPressure (double electricPowerPerUnitFlowRatePerUnitPressure)
bool setFanTotalEfficiency (double fanTotalEfficiency)
bool setElectricPowerFunctionofFlowFractionCurve (const Curve &univariateFunctions)
void resetElectricPowerFunctionofFlowFractionCurve ()
bool setNightVentilationModePressureRise (double nightVentilationModePressureRise)
void resetNightVentilationModePressureRise ()
bool setNightVentilationModeFlowFraction (double nightVentilationModeFlowFraction)
void resetNightVentilationModeFlowFraction ()
bool setMotorLossZone (const ThermalZone &thermalZone)
void resetMotorLossZone ()
bool setMotorLossRadiativeFraction (double motorLossRadiativeFraction)
bool setEndUseSubcategory (const std::string &endUseSubcategory)
AirflowNetworkFan getAirflowNetworkFan ()
< AirflowNetworkFan
airflowNetworkFan () 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 > designPowerSizingMethodValues ()
static IddObjectType iddObjectType ()
static std::vector< std::string > speedControlMethodValues ()

Related Functions

(Note that these are not member functions.)

typedef std::vector
< FanSystemModel
typedef boost::optional
< FanSystemModel

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

FanSystemModel is a StraightComponent that wraps the OpenStudio IDD object 'OS:Fan:SystemModel'.

Constructor & Destructor Documentation

openstudio::model::FanSystemModel::FanSystemModel ( const Model model)
virtual openstudio::model::FanSystemModel::~FanSystemModel ( )

Member Function Documentation

bool openstudio::model::FanSystemModel::addSpeed ( const FanSystemModelSpeed speed)

If a speed group is already present (= the flowFraction already exists) (cf speedIndex()), it will Warn and override the electricPowerFraction value.

bool openstudio::model::FanSystemModel::addSpeed ( double  flowFraction,
double  electricPowerFraction 
boost::optional<AirflowNetworkFan> openstudio::model::FanSystemModel::airflowNetworkFan ( ) const
boost::optional<double> openstudio::model::FanSystemModel::autosizedDesignElectricPowerConsumption ( )
boost::optional<double> openstudio::model::FanSystemModel::autosizedDesignMaximumAirFlowRate ( )
void openstudio::model::FanSystemModel::autosizeDesignElectricPowerConsumption ( )
void openstudio::model::FanSystemModel::autosizeDesignMaximumAirFlowRate ( )
Schedule openstudio::model::FanSystemModel::availabilitySchedule ( ) const
boost::optional<double> openstudio::model::FanSystemModel::designElectricPowerConsumption ( ) const
boost::optional<double> openstudio::model::FanSystemModel::designMaximumAirFlowRate ( ) const
std::string openstudio::model::FanSystemModel::designPowerSizingMethod ( ) const
static std::vector<std::string> openstudio::model::FanSystemModel::designPowerSizingMethodValues ( )
double openstudio::model::FanSystemModel::designPressureRise ( ) const
boost::optional<Curve> openstudio::model::FanSystemModel::electricPowerFunctionofFlowFractionCurve ( ) const
double openstudio::model::FanSystemModel::electricPowerMinimumFlowRateFraction ( ) const
double openstudio::model::FanSystemModel::electricPowerPerUnitFlowRate ( ) const
double openstudio::model::FanSystemModel::electricPowerPerUnitFlowRatePerUnitPressure ( ) const
std::string openstudio::model::FanSystemModel::endUseSubcategory ( ) const
double openstudio::model::FanSystemModel::fanTotalEfficiency ( ) const
AirflowNetworkFan openstudio::model::FanSystemModel::getAirflowNetworkFan ( )
boost::optional<FanSystemModelSpeed> openstudio::model::FanSystemModel::getSpeed ( unsigned  speedIndex) const
static IddObjectType openstudio::model::FanSystemModel::iddObjectType ( )
bool openstudio::model::FanSystemModel::isDesignElectricPowerConsumptionAutosized ( ) const
bool openstudio::model::FanSystemModel::isDesignMaximumAirFlowRateAutosized ( ) const
double openstudio::model::FanSystemModel::motorEfficiency ( ) const
double openstudio::model::FanSystemModel::motorInAirStreamFraction ( ) const
double openstudio::model::FanSystemModel::motorLossRadiativeFraction ( ) const
boost::optional<ThermalZone> openstudio::model::FanSystemModel::motorLossZone ( ) const
boost::optional<double> openstudio::model::FanSystemModel::nightVentilationModeFlowFraction ( ) const
boost::optional<double> openstudio::model::FanSystemModel::nightVentilationModePressureRise ( ) const
unsigned openstudio::model::FanSystemModel::numberofSpeeds ( ) const
void openstudio::model::FanSystemModel::removeAllSpeeds ( )
bool openstudio::model::FanSystemModel::removeSpeed ( unsigned  speedIndex)
void openstudio::model::FanSystemModel::resetElectricPowerFunctionofFlowFractionCurve ( )
void openstudio::model::FanSystemModel::resetMotorLossZone ( )
void openstudio::model::FanSystemModel::resetNightVentilationModeFlowFraction ( )
void openstudio::model::FanSystemModel::resetNightVentilationModePressureRise ( )
bool openstudio::model::FanSystemModel::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::FanSystemModel::setDesignElectricPowerConsumption ( double  designElectricPowerConsumption)
bool openstudio::model::FanSystemModel::setDesignMaximumAirFlowRate ( double  designMaximumAirFlowRate)
bool openstudio::model::FanSystemModel::setDesignPowerSizingMethod ( const std::string &  designPowerSizingMethod)
bool openstudio::model::FanSystemModel::setDesignPressureRise ( double  designPressureRise)
bool openstudio::model::FanSystemModel::setElectricPowerFunctionofFlowFractionCurve ( const Curve univariateFunctions)
bool openstudio::model::FanSystemModel::setElectricPowerMinimumFlowRateFraction ( double  electricPowerMinimumFlowRateFraction)
bool openstudio::model::FanSystemModel::setElectricPowerPerUnitFlowRate ( double  electricPowerPerUnitFlowRate)
bool openstudio::model::FanSystemModel::setElectricPowerPerUnitFlowRatePerUnitPressure ( double  electricPowerPerUnitFlowRatePerUnitPressure)
bool openstudio::model::FanSystemModel::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::FanSystemModel::setFanTotalEfficiency ( double  fanTotalEfficiency)
bool openstudio::model::FanSystemModel::setMotorEfficiency ( double  motorEfficiency)
bool openstudio::model::FanSystemModel::setMotorInAirStreamFraction ( double  motorInAirStreamFraction)
bool openstudio::model::FanSystemModel::setMotorLossRadiativeFraction ( double  motorLossRadiativeFraction)
bool openstudio::model::FanSystemModel::setMotorLossZone ( const ThermalZone thermalZone)
bool openstudio::model::FanSystemModel::setNightVentilationModeFlowFraction ( double  nightVentilationModeFlowFraction)
bool openstudio::model::FanSystemModel::setNightVentilationModePressureRise ( double  nightVentilationModePressureRise)
bool openstudio::model::FanSystemModel::setSpeedControlMethod ( const std::string &  speedControlMethod)
bool openstudio::model::FanSystemModel::setSpeeds ( const std::vector< FanSystemModelSpeed > &  speeds)
std::string openstudio::model::FanSystemModel::speedControlMethod ( ) const
static std::vector<std::string> openstudio::model::FanSystemModel::speedControlMethodValues ( )
boost::optional<unsigned> openstudio::model::FanSystemModel::speedIndex ( const FanSystemModelSpeed speed) const

Find a given speed by the flowFraction (key)

std::vector<FanSystemModelSpeed> openstudio::model::FanSystemModel::speeds ( ) const

Friends And Related Function Documentation

typedef std::vector<FanSystemModel> FanSystemModelVector
typedef boost::optional<FanSystemModel> OptionalFanSystemModel