FanSystemModel Class Reference

#include "FanSystemModel.hpp"

Inheritance diagram for openstudio::model::FanSystemModel:

Public Member Functions
	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< Curve >	electricPowerFunctionofFlowFractionCurve () const
boost::optional< double >	nightVentilationModePressureRise () const
boost::optional< double >	nightVentilationModeFlowFraction () const
boost::optional< ThermalZone >	motorLossZone () const
double	motorLossRadiativeFraction () const
std::string	endUseSubcategory () const
unsigned	numberofSpeeds () const
std::vector< FanSystemModelSpeed >	speeds () const
boost::optional< unsigned >	speedIndex (const FanSystemModelSpeed &speed) const
boost::optional < FanSystemModelSpeed >	getSpeed (unsigned speedIndex) const
bool	addSpeed (const FanSystemModelSpeed &speed)
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 ()
boost::optional < AirflowNetworkFan >	airflowNetworkFan () const

Static Public Member Functions
static std::vector< std::string >	designPowerSizingMethodValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	speedControlMethodValues ()

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

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 )

explicit

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

inlinevirtual

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

static

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

static

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

static

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

related

typedef boost::optional<FanSystemModel> OptionalFanSystemModel

related