#include <PrjAirflowElements.hpp>
Public Member Functions | |
Constructors and Destructors | |
PlrOrf () | |
Create a new object with default values. More... | |
PlrOrf (int nr, int icon, std::string name, std::string desc) | |
Create a new object. More... | |
PlrOrf (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double area, double dia, double coef, double Re, int u_A, int u_D) | |
Create a new object. More... | |
PlrOrf (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string area, std::string dia, std::string coef, std::string Re, int u_A, int u_D) | |
Create a new object. More... | |
PlrOrf (const PlrOrf &other) | |
Create a new object from another object. More... | |
~PlrOrf () | |
Destroy the object. More... | |
Operators | |
PlrOrf & | operator= (const PlrOrf &other) |
Copy operator. More... | |
bool | operator== (const PlrOrf &other) const |
Equality operator. More... | |
bool | operator!= (const PlrOrf &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 | area () const |
Returns the actual area [m^2]. More... | |
bool | setArea (const double area) |
Sets the actual area [m^2]. More... | |
bool | setArea (const std::string &area) |
Sets the actual area [m^2]. More... | |
double | dia () const |
Returns the hydraulic diameter [m]. More... | |
bool | setDia (const double dia) |
Sets the hydraulic diameter [m]. More... | |
bool | setDia (const std::string &dia) |
Sets the hydraulic diameter [m]. More... | |
double | coef () const |
Returns the flow coefficient. More... | |
bool | setCoef (const double coef) |
Sets the flow coefficient. More... | |
bool | setCoef (const std::string &coef) |
Sets the flow coefficient. More... | |
double | Re () const |
Returns the laminar/turbulet transition Reynolds number. More... | |
bool | setRe (const double Re) |
Sets the laminar/turbulet transition Reynolds number. More... | |
bool | setRe (const std::string &Re) |
Sets the laminar/turbulet transition Reynolds number. More... | |
int | u_A () const |
Returns the display units for area. More... | |
void | setU_A (const int u_A) |
Sets the display units for area. More... | |
int | u_D () const |
Returns the display units for diameter. More... | |
void | setU_D (const int u_D) |
Sets the display units for diameter. 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 AirflowElement * | readElement (Reader &input) |
Read an airflow element from a Reader object. More... | |
The PlrOrj object is an airflow element representing an orifice.
openstudio::contam::PlrOrf::PlrOrf | ( | ) |
Create a new object with default values.
openstudio::contam::PlrOrf::PlrOrf | ( | int | nr, |
int | icon, | ||
std::string | name, | ||
std::string | desc | ||
) |
Create a new object.
openstudio::contam::PlrOrf::PlrOrf | ( | int | nr, |
int | icon, | ||
std::string | name, | ||
std::string | desc, | ||
double | lam, | ||
double | turb, | ||
double | expt, | ||
double | area, | ||
double | dia, | ||
double | coef, | ||
double | Re, | ||
int | u_A, | ||
int | u_D | ||
) |
Create a new object.
openstudio::contam::PlrOrf::PlrOrf | ( | int | nr, |
int | icon, | ||
std::string | name, | ||
std::string | desc, | ||
std::string | lam, | ||
std::string | turb, | ||
std::string | expt, | ||
std::string | area, | ||
std::string | dia, | ||
std::string | coef, | ||
std::string | Re, | ||
int | u_A, | ||
int | u_D | ||
) |
Create a new object.
openstudio::contam::PlrOrf::PlrOrf | ( | const PlrOrf & | other | ) |
Create a new object from another object.
openstudio::contam::PlrOrf::~PlrOrf | ( | ) |
Destroy the object.
double openstudio::contam::PlrOrf::area | ( | ) | const |
Returns the actual area [m^2].
double openstudio::contam::PlrOrf::coef | ( | ) | const |
Returns the flow coefficient.
|
inlineoverridevirtual |
Returns the element data type.
Implements openstudio::contam::AirflowElement.
|
overridevirtual |
Returns the element description.
Implements openstudio::contam::AirflowElement.
double openstudio::contam::PlrOrf::dia | ( | ) | const |
Returns the hydraulic diameter [m].
double openstudio::contam::PlrOrf::expt | ( | ) | const |
Returns the pressure exponent.
|
overridevirtual |
Returns the icon used to represent flow path.
Implements openstudio::contam::AirflowElement.
double openstudio::contam::PlrOrf::lam | ( | ) | const |
Returns the laminar flow coefficient.
|
overridevirtual |
Returns the element name.
Implements openstudio::contam::AirflowElement.
|
overridevirtual |
Returns the element number, in order from 1 to the number of airflow elements.
Implements openstudio::contam::AirflowElement.
bool openstudio::contam::PlrOrf::operator!= | ( | const PlrOrf & | other | ) | const |
Inequality operator.
bool openstudio::contam::PlrOrf::operator== | ( | const PlrOrf & | other | ) | const |
Equality operator.
double openstudio::contam::PlrOrf::Re | ( | ) | const |
Returns the laminar/turbulet transition Reynolds number.
bool openstudio::contam::PlrOrf::setArea | ( | const double | area | ) |
Sets the actual area [m^2].
bool openstudio::contam::PlrOrf::setArea | ( | const std::string & | area | ) |
Sets the actual area [m^2].
bool openstudio::contam::PlrOrf::setCoef | ( | const double | coef | ) |
Sets the flow coefficient.
bool openstudio::contam::PlrOrf::setCoef | ( | const std::string & | coef | ) |
Sets the flow coefficient.
|
overridevirtual |
Sets the element description.
Implements openstudio::contam::AirflowElement.
bool openstudio::contam::PlrOrf::setDia | ( | const double | dia | ) |
Sets the hydraulic diameter [m].
bool openstudio::contam::PlrOrf::setDia | ( | const std::string & | dia | ) |
Sets the hydraulic diameter [m].
bool openstudio::contam::PlrOrf::setExpt | ( | const double | expt | ) |
Sets the pressure exponent.
bool openstudio::contam::PlrOrf::setExpt | ( | const std::string & | expt | ) |
Sets the pressure exponent.
|
overridevirtual |
Sets the icon used to represent flow path.
Implements openstudio::contam::AirflowElement.
bool openstudio::contam::PlrOrf::setLam | ( | const double | lam | ) |
Sets the laminar flow coefficient.
bool openstudio::contam::PlrOrf::setLam | ( | const std::string & | lam | ) |
Sets the laminar flow coefficient.
|
overridevirtual |
Sets the element name.
Implements openstudio::contam::AirflowElement.
|
overridevirtual |
Sets the element number.
This should only be done with care.
Implements openstudio::contam::AirflowElement.
bool openstudio::contam::PlrOrf::setRe | ( | const double | Re | ) |
Sets the laminar/turbulet transition Reynolds number.
bool openstudio::contam::PlrOrf::setRe | ( | const std::string & | Re | ) |
Sets the laminar/turbulet transition Reynolds number.
bool openstudio::contam::PlrOrf::setTurb | ( | const double | turb | ) |
Sets the turbulent flow coefficient.
bool openstudio::contam::PlrOrf::setTurb | ( | const std::string & | turb | ) |
Sets the turbulent flow coefficient.
void openstudio::contam::PlrOrf::setU_A | ( | const int | u_A | ) |
Sets the display units for area.
void openstudio::contam::PlrOrf::setU_D | ( | const int | u_D | ) |
Sets the display units for diameter.
double openstudio::contam::PlrOrf::turb | ( | ) | const |
Returns the turbulent flow coefficient.
int openstudio::contam::PlrOrf::u_A | ( | ) | const |
Returns the display units for area.
int openstudio::contam::PlrOrf::u_D | ( | ) | const |
Returns the display units for diameter.
|
overridevirtual |
Write the object to a string.
Implements openstudio::contam::AirflowElement.