OpenStudioCore:airflow
 All Classes Namespaces Functions Enumerations Enumerator
List of all members
openstudio::contam::AfeFan Class Reference

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::AfeFan:

Public Member Functions

Constructors and Destructors
 AfeFan ()
 Create a new object with default values. More...
 
 AfeFan (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 AfeFan (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double rdens, double fdf, double sop, double off, std::vector< double > fpc, double Sarea, int u_Sa, std::vector< FanDataPoint > data)
 Create a new object. More...
 
 AfeFan (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string rdens, std::string fdf, std::string sop, std::string off, std::vector< std::string > fpc, std::string Sarea, int u_Sa, std::vector< FanDataPoint > data)
 Create a new object. More...
 
 AfeFan (const AfeFan &other)
 Create a new object from another object. More...
 
 ~AfeFan ()
 Destroy the object. More...
 
Operators
AfeFanoperator= (const AfeFan &other)
 Copy operator. More...
 
bool operator== (const AfeFan &other) const
 Equality operator. More...
 
bool operator!= (const AfeFan &other) const
 Inequality operator. More...
 
Input and Output
void read (Reader &input)
 Read an object from a Reader. More...
 
void readDetails (Reader &input)
 Read object details from a Reader. More...
 
std::string write () override
 Write the object to a string. More...
 
Getters and Setters
int nr () const override
 Returns the element number, in order from 1 to the number of airflow elements. More...
 
void setNr (const int nr) override
 Sets the element number. More...
 
int icon () const override
 Returns the icon used to represent flow path. More...
 
void setIcon (const int icon) override
 Sets the icon used to represent flow path. More...
 
std::string dataType () const override
 Returns the element data type. More...
 
std::string name () const override
 Returns the element name. More...
 
void setName (const std::string &name) override
 Sets the element name. More...
 
std::string desc () const override
 Returns the element description. More...
 
void setDesc (const std::string &desc) override
 Sets the element description. More...
 
double lam () const
 Returns the laminar flow coefficient. More...
 
bool setLam (const double lam)
 Sets the laminar flow coefficient. More...
 
bool setLam (const std::string &lam)
 Sets the laminar flow coefficient. More...
 
double turb () const
 Returns the turbulent flow coefficient. More...
 
bool setTurb (const double turb)
 Sets the turbulent flow coefficient. More...
 
bool setTurb (const std::string &turb)
 Sets the turbulent flow coefficient. More...
 
double expt () const
 Returns the pressure exponent. More...
 
bool setExpt (const double expt)
 Sets the pressure exponent. More...
 
bool setExpt (const std::string &expt)
 Sets the pressure exponent. More...
 
double rdens () const
 Returns the reference fluid density [kg/m^3]. More...
 
bool setRdens (const double rdens)
 Sets the reference fluid density [kg/m^3]. More...
 
bool setRdens (const std::string &rdens)
 Sets the reference fluid density [kg/m^3]. More...
 
double fdf () const
 Returns the free delivery flow (prise = 0) [kg/s]. More...
 
bool setFdf (const double fdf)
 Returns the free delivery flow (prise = 0) [kg/s]. More...
 
bool setFdf (const std::string &fdf)
 Returns the free delivery flow (prise = 0) [kg/s]. More...
 
double sop () const
 Returns the shut-off pressure (flow = 0) [Pa]. More...
 
bool setSop (const double sop)
 Sets the shut-off pressure (flow = 0) [Pa]. More...
 
bool setSop (const std::string &sop)
 Sets the shut-off pressure (flow = 0) [Pa]. More...
 
double off () const
 Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off. More...
 
bool setOff (const double off)
 Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off. More...
 
bool setOff (const std::string &off)
 Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off. More...
 
std::vector< double > fpc () const
 Returns the fan performance polynomial coefficients. More...
 
bool setFpc (const std::vector< double > &fpc)
 Sets the fan performance polynomial coefficients. More...
 
bool setFpc (const std::vector< std::string > &fpc)
 Sets the fan performance polynomial coefficients. More...
 
double Sarea () const
 Returns the shut-off orifice area [m^2]. More...
 
bool setSarea (const double Sarea)
 Returns the shut-off orifice area [m^2]. More...
 
bool setSarea (const std::string &Sarea)
 Returns the shut-off orifice area [m^2]. More...
 
int u_Sa () const
 Returns the display units of shut-off orifice area. More...
 
void setU_Sa (const int u_Sa)
 Sets the display units of shut-off orifice area. More...
 
std::vector< FanDataPointdata () const
 Returns the vector of fan data points. More...
 
void setData (const std::vector< FanDataPoint > &data)
 Sets the vector of fan data points. More...
 
- Public Member Functions inherited from openstudio::contam::AirflowElement
virtual ~AirflowElement ()
 Destroy the object. More...
 

Additional Inherited Members

- Public Types inherited from openstudio::contam::AirflowElement
enum  Type {
  PL_ORFC =0, PL_LEAK1 =1, PL_LEAK2 =2, PL_LEAK3 =3,
  PL_CONN =4, PL_QCN =5, PL_FCN =6, PL_TEST1 =7,
  PL_TEST2 =8, PL_CRACK =9, PL_STAIR =10, PL_SHAFT =11,
  PL_BDQ =12, PL_BDF =13, QFR_QAB =14, QFR_QAF =15,
  QFR_CRACK =16, QFR_TEST2 =17, DR_DOOR =18, DR_PL2 =19,
  FN_CMF =20, FN_CVF =21, FN_FAN =22, CS_FSP =23,
  CS_QSP =24, CS_PSF =25, CS_PSQ =26, AF_SUP =27,
  UNKNOWN
}
 The Type enumeration is used to identify the various airflow element types. More...
 
- Static Public Member Functions inherited from openstudio::contam::AirflowElement
static Type convertTag (std::string string)
 Convert an input string into an airflow element type enum. More...
 
static AirflowElementreadElement (Reader &input)
 Read an airflow element from a Reader object. More...
 

Detailed Description

The AfeFan object is an airflow element representing a fan with performance data.

Constructor & Destructor Documentation

openstudio::contam::AfeFan::AfeFan ( )

Create a new object with default values.

openstudio::contam::AfeFan::AfeFan ( int  nr,
int  icon,
std::string  name,
std::string  desc 
)

Create a new object.

openstudio::contam::AfeFan::AfeFan ( int  nr,
int  icon,
std::string  name,
std::string  desc,
double  lam,
double  turb,
double  expt,
double  rdens,
double  fdf,
double  sop,
double  off,
std::vector< double >  fpc,
double  Sarea,
int  u_Sa,
std::vector< FanDataPoint data 
)

Create a new object.

openstudio::contam::AfeFan::AfeFan ( int  nr,
int  icon,
std::string  name,
std::string  desc,
std::string  lam,
std::string  turb,
std::string  expt,
std::string  rdens,
std::string  fdf,
std::string  sop,
std::string  off,
std::vector< std::string >  fpc,
std::string  Sarea,
int  u_Sa,
std::vector< FanDataPoint data 
)

Create a new object.

openstudio::contam::AfeFan::AfeFan ( const AfeFan other)

Create a new object from another object.

openstudio::contam::AfeFan::~AfeFan ( )

Destroy the object.

Member Function Documentation

std::vector<FanDataPoint> openstudio::contam::AfeFan::data ( ) const

Returns the vector of fan data points.

std::string openstudio::contam::AfeFan::dataType ( ) const
inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

std::string openstudio::contam::AfeFan::desc ( ) const
overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::AfeFan::expt ( ) const

Returns the pressure exponent.

double openstudio::contam::AfeFan::fdf ( ) const

Returns the free delivery flow (prise = 0) [kg/s].

std::vector<double> openstudio::contam::AfeFan::fpc ( ) const

Returns the fan performance polynomial coefficients.

int openstudio::contam::AfeFan::icon ( ) const
overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::AfeFan::lam ( ) const

Returns the laminar flow coefficient.

std::string openstudio::contam::AfeFan::name ( ) const
overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

int openstudio::contam::AfeFan::nr ( ) const
overridevirtual

Returns the element number, in order from 1 to the number of airflow elements.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::AfeFan::off ( ) const

Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.

bool openstudio::contam::AfeFan::operator!= ( const AfeFan other) const

Inequality operator.

AfeFan& openstudio::contam::AfeFan::operator= ( const AfeFan other)

Copy operator.

bool openstudio::contam::AfeFan::operator== ( const AfeFan other) const

Equality operator.

double openstudio::contam::AfeFan::rdens ( ) const

Returns the reference fluid density [kg/m^3].

void openstudio::contam::AfeFan::read ( Reader input)

Read an object from a Reader.

void openstudio::contam::AfeFan::readDetails ( Reader input)

Read object details from a Reader.

double openstudio::contam::AfeFan::Sarea ( ) const

Returns the shut-off orifice area [m^2].

void openstudio::contam::AfeFan::setData ( const std::vector< FanDataPoint > &  data)

Sets the vector of fan data points.

void openstudio::contam::AfeFan::setDesc ( const std::string &  desc)
overridevirtual

Sets the element description.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::AfeFan::setExpt ( const double  expt)

Sets the pressure exponent.

bool openstudio::contam::AfeFan::setExpt ( const std::string &  expt)

Sets the pressure exponent.

bool openstudio::contam::AfeFan::setFdf ( const double  fdf)

Returns the free delivery flow (prise = 0) [kg/s].

bool openstudio::contam::AfeFan::setFdf ( const std::string &  fdf)

Returns the free delivery flow (prise = 0) [kg/s].

bool openstudio::contam::AfeFan::setFpc ( const std::vector< double > &  fpc)

Sets the fan performance polynomial coefficients.

bool openstudio::contam::AfeFan::setFpc ( const std::vector< std::string > &  fpc)

Sets the fan performance polynomial coefficients.

void openstudio::contam::AfeFan::setIcon ( const int  icon)
overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::AfeFan::setLam ( const double  lam)

Sets the laminar flow coefficient.

bool openstudio::contam::AfeFan::setLam ( const std::string &  lam)

Sets the laminar flow coefficient.

void openstudio::contam::AfeFan::setName ( const std::string &  name)
overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::AfeFan::setNr ( const int  nr)
overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::AfeFan::setOff ( const double  off)

Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.

bool openstudio::contam::AfeFan::setOff ( const std::string &  off)

Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.

bool openstudio::contam::AfeFan::setRdens ( const double  rdens)

Sets the reference fluid density [kg/m^3].

bool openstudio::contam::AfeFan::setRdens ( const std::string &  rdens)

Sets the reference fluid density [kg/m^3].

bool openstudio::contam::AfeFan::setSarea ( const double  Sarea)

Returns the shut-off orifice area [m^2].

bool openstudio::contam::AfeFan::setSarea ( const std::string &  Sarea)

Returns the shut-off orifice area [m^2].

bool openstudio::contam::AfeFan::setSop ( const double  sop)

Sets the shut-off pressure (flow = 0) [Pa].

bool openstudio::contam::AfeFan::setSop ( const std::string &  sop)

Sets the shut-off pressure (flow = 0) [Pa].

bool openstudio::contam::AfeFan::setTurb ( const double  turb)

Sets the turbulent flow coefficient.

bool openstudio::contam::AfeFan::setTurb ( const std::string &  turb)

Sets the turbulent flow coefficient.

void openstudio::contam::AfeFan::setU_Sa ( const int  u_Sa)

Sets the display units of shut-off orifice area.

double openstudio::contam::AfeFan::sop ( ) const

Returns the shut-off pressure (flow = 0) [Pa].

double openstudio::contam::AfeFan::turb ( ) const

Returns the turbulent flow coefficient.

int openstudio::contam::AfeFan::u_Sa ( ) const

Returns the display units of shut-off orifice area.

std::string openstudio::contam::AfeFan::write ( )
overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.