OpenStudio:airflow
 All Classes Namespaces Functions Typedefs Enumerations Enumerator
List of all members
openstudio::contam::PlrStair Class Reference

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::PlrStair:

Public Member Functions

Constructors and Destructors
 PlrStair ()
 Create a new object with default values. More...
 
 PlrStair (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 PlrStair (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double Ht, double Area, double peo, int tread, int u_A, int u_D)
 Create a new object. More...
 
 PlrStair (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string Ht, std::string Area, std::string peo, int tread, int u_A, int u_D)
 Create a new object. More...
 
 PlrStair (const PlrStair &other)
 Create a new object from another object. More...
 
 ~PlrStair ()=default
 Destroy the object. More...
 
Operators
PlrStairoperator= (const PlrStair &other)
 Copy operator. More...
 
bool operator== (const PlrStair &other) const
 Equality operator. More...
 
bool operator!= (const PlrStair &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 Ht () const
 Returns the distance between levels [m]. More...
 
bool setHt (const double Ht)
 Sets the distance between levels [m]. More...
 
bool setHt (const std::string &Ht)
 Sets the distance between levels [m]. More...
 
double area () const
 Returns the cross-sectional area [m^2]. More...
 
bool setArea (const double Area)
 Sets the cross-sectional area [m^2]. More...
 
bool setArea (const std::string &Area)
 Sets the cross-sectional area [m^2]. More...
 
double people () const
 Returns the density of people [pers/m^2]. More...
 
bool setPeople (const double peo)
 Sets the density of people [pers/m^2]. More...
 
bool setPeople (const std::string &peo)
 Sets the density of people [pers/m^2]. More...
 
int tread () const
 Returns the tread type: 1 = open tread 0 = closed. More...
 
void setTread (const int tread)
 Sets the tread type: 1 = open tread 0 = closed. More...
 
int u_A () const
 Returns the display units of area. More...
 
void setU_A (const int u_A)
 Sets the display units of area. More...
 
int u_D () const
 Returns the display units of distance. More...
 
void setU_D (const int u_D)
 Sets the display units of distance. More...
 
- Public Member Functions inherited from openstudio::contam::AirflowElement
virtual ~AirflowElement ()=default
 Destroy the object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from openstudio::contam::AirflowElement
static AirflowElementType convertTag (const std::string &tag)
 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 PlrStair object is an airflow element representing level-to-level power law leakage in stairwells.

Constructor & Destructor Documentation

openstudio::contam::PlrStair::PlrStair ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::PlrStair::PlrStair ( int  nr,
int  icon,
std::string  name,
std::string  desc,
double  lam,
double  turb,
double  expt,
double  Ht,
double  Area,
double  peo,
int  tread,
int  u_A,
int  u_D 
)

Create a new object.

openstudio::contam::PlrStair::PlrStair ( int  nr,
int  icon,
std::string  name,
std::string  desc,
std::string  lam,
std::string  turb,
std::string  expt,
std::string  Ht,
std::string  Area,
std::string  peo,
int  tread,
int  u_A,
int  u_D 
)

Create a new object.

openstudio::contam::PlrStair::PlrStair ( const PlrStair other)

Create a new object from another object.

openstudio::contam::PlrStair::~PlrStair ( )
default

Destroy the object.

Member Function Documentation

double openstudio::contam::PlrStair::area ( ) const

Returns the cross-sectional area [m^2].

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

Returns the element data type.

Implements openstudio::contam::AirflowElement.

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

Returns the element description.

Implements openstudio::contam::AirflowElement.

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

Returns the pressure exponent.

double openstudio::contam::PlrStair::Ht ( ) const

Returns the distance between levels [m].

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

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the laminar flow coefficient.

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

Returns the element name.

Implements openstudio::contam::AirflowElement.

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

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

Implements openstudio::contam::AirflowElement.

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

Inequality operator.

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

Copy operator.

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

Equality operator.

double openstudio::contam::PlrStair::people ( ) const

Returns the density of people [pers/m^2].

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

Read an object from a Reader.

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

Read object details from a Reader.

bool openstudio::contam::PlrStair::setArea ( const double  Area)

Sets the cross-sectional area [m^2].

bool openstudio::contam::PlrStair::setArea ( const std::string &  Area)

Sets the cross-sectional area [m^2].

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

Sets the element description.

Implements openstudio::contam::AirflowElement.

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

Sets the pressure exponent.

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

Sets the pressure exponent.

bool openstudio::contam::PlrStair::setHt ( const double  Ht)

Sets the distance between levels [m].

bool openstudio::contam::PlrStair::setHt ( const std::string &  Ht)

Sets the distance between levels [m].

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

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the laminar flow coefficient.

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

Sets the laminar flow coefficient.

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

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::PlrStair::setPeople ( const double  peo)

Sets the density of people [pers/m^2].

bool openstudio::contam::PlrStair::setPeople ( const std::string &  peo)

Sets the density of people [pers/m^2].

void openstudio::contam::PlrStair::setTread ( const int  tread)

Sets the tread type: 1 = open tread 0 = closed.

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

Sets the turbulent flow coefficient.

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

Sets the turbulent flow coefficient.

void openstudio::contam::PlrStair::setU_A ( const int  u_A)

Sets the display units of area.

void openstudio::contam::PlrStair::setU_D ( const int  u_D)

Sets the display units of distance.

int openstudio::contam::PlrStair::tread ( ) const

Returns the tread type: 1 = open tread 0 = closed.

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

Returns the turbulent flow coefficient.

int openstudio::contam::PlrStair::u_A ( ) const

Returns the display units of area.

int openstudio::contam::PlrStair::u_D ( ) const

Returns the display units of distance.

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

Write the object to a string.

Implements openstudio::contam::AirflowElement.