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

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::DrPl2:

Public Member Functions

Constructors and Destructors
 DrPl2 ()
 Create a new object with default values. More...
 
 DrPl2 (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 DrPl2 (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double dH, double ht, double wd, double cd, int u_H, int u_W)
 Create a new object. More...
 
 DrPl2 (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string dH, std::string ht, std::string wd, std::string cd, int u_H, int u_W)
 Create a new object. More...
 
 DrPl2 (const DrPl2 &other)
 Create a new object from another object. More...
 
 ~DrPl2 ()=default
 Destroy the object. More...
 
Operators
DrPl2operator= (const DrPl2 &other)
 Copy operator. More...
 
bool operator== (const DrPl2 &other) const
 Equality operator. More...
 
bool operator!= (const DrPl2 &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 dH () const
 Returns the distance above/below midpoint [m]. More...
 
bool setDH (const double dH)
 Sets the distance above/below midpoint [m]. More...
 
bool setDH (const std::string &dH)
 Sets the distance above/below midpoint [m]. More...
 
double height () const
 Returns the height of doorway [m]. More...
 
bool setHeight (const double ht)
 Sets the height of doorway [m]. More...
 
bool setHeight (const std::string &ht)
 Sets the height of doorway [m]. More...
 
double width () const
 Sets the width of doorway [m]. More...
 
bool setWidth (const double wd)
 Sets the width of doorway [m]. More...
 
bool setWidth (const std::string &wd)
 Sets the width of doorway [m]. More...
 
double cd () const
 Returns the discharge coefficient. More...
 
bool setCd (const double cd)
 Sets the discharge coefficient. More...
 
bool setCd (const std::string &cd)
 Sets the discharge coefficient. More...
 
int u_H () const
 Returns the display units of height. More...
 
void setU_H (const int u_H)
 Sets the display units of height. More...
 
int u_W () const
 Returns the display units of width. More...
 
void setU_W (const int u_W)
 Sets the display units of width. 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 DrPl2 object is an airflow element representing 2-way flow through an opening using two power law models.

Constructor & Destructor Documentation

openstudio::contam::DrPl2::DrPl2 ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::DrPl2::DrPl2 ( int  nr,
int  icon,
std::string  name,
std::string  desc,
double  lam,
double  turb,
double  expt,
double  dH,
double  ht,
double  wd,
double  cd,
int  u_H,
int  u_W 
)

Create a new object.

openstudio::contam::DrPl2::DrPl2 ( int  nr,
int  icon,
std::string  name,
std::string  desc,
std::string  lam,
std::string  turb,
std::string  expt,
std::string  dH,
std::string  ht,
std::string  wd,
std::string  cd,
int  u_H,
int  u_W 
)

Create a new object.

openstudio::contam::DrPl2::DrPl2 ( const DrPl2 other)

Create a new object from another object.

openstudio::contam::DrPl2::~DrPl2 ( )
default

Destroy the object.

Member Function Documentation

double openstudio::contam::DrPl2::cd ( ) const

Returns the discharge coefficient.

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

Returns the element data type.

Implements openstudio::contam::AirflowElement.

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

Returns the element description.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::DrPl2::dH ( ) const

Returns the distance above/below midpoint [m].

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

Returns the pressure exponent.

double openstudio::contam::DrPl2::height ( ) const

Returns the height of doorway [m].

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

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the laminar flow coefficient.

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

Returns the element name.

Implements openstudio::contam::AirflowElement.

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

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

Implements openstudio::contam::AirflowElement.

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

Inequality operator.

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

Copy operator.

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

Equality operator.

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

Read an object from a Reader.

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

Read object details from a Reader.

bool openstudio::contam::DrPl2::setCd ( const double  cd)

Sets the discharge coefficient.

bool openstudio::contam::DrPl2::setCd ( const std::string &  cd)

Sets the discharge coefficient.

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

Sets the element description.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::DrPl2::setDH ( const double  dH)

Sets the distance above/below midpoint [m].

bool openstudio::contam::DrPl2::setDH ( const std::string &  dH)

Sets the distance above/below midpoint [m].

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

Sets the pressure exponent.

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

Sets the pressure exponent.

bool openstudio::contam::DrPl2::setHeight ( const double  ht)

Sets the height of doorway [m].

bool openstudio::contam::DrPl2::setHeight ( const std::string &  ht)

Sets the height of doorway [m].

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

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the laminar flow coefficient.

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

Sets the laminar flow coefficient.

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

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

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

Sets the turbulent flow coefficient.

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

Sets the turbulent flow coefficient.

void openstudio::contam::DrPl2::setU_H ( const int  u_H)

Sets the display units of height.

void openstudio::contam::DrPl2::setU_W ( const int  u_W)

Sets the display units of width.

bool openstudio::contam::DrPl2::setWidth ( const double  wd)

Sets the width of doorway [m].

bool openstudio::contam::DrPl2::setWidth ( const std::string &  wd)

Sets the width of doorway [m].

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

Returns the turbulent flow coefficient.

int openstudio::contam::DrPl2::u_H ( ) const

Returns the display units of height.

int openstudio::contam::DrPl2::u_W ( ) const

Returns the display units of width.

double openstudio::contam::DrPl2::width ( ) const

Sets the width of doorway [m].

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

Write the object to a string.

Implements openstudio::contam::AirflowElement.