#include <PrjAirflowElements.hpp>
Public Member Functions | |
Constructors and Destructors | |
PlrLeak () | |
Create a new object with default values. More... | |
PlrLeak (int nr, int icon, std::string name, std::string desc) | |
Create a new object. More... | |
PlrLeak (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double coef, double pres, double area1, double area2, double area3, int u_A1, int u_A2, int u_A3, int u_dP) | |
Create a new object. More... | |
PlrLeak (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string coef, std::string pres, std::string area1, std::string area2, std::string area3, int u_A1, int u_A2, int u_A3, int u_dP) | |
Create a new object. More... | |
PlrLeak (const PlrLeak &other) | |
Create a new object from another object. More... | |
~PlrLeak () | |
Destroy the object. More... | |
Operators | |
PlrLeak & | operator= (const PlrLeak &other) |
Copy operator. More... | |
bool | operator== (const PlrLeak &other) const |
Equality operator. More... | |
bool | operator!= (const PlrLeak &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... | |
virtual std::string | dataType () const override=0 |
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 | 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 | pres () const |
Returns the reference pressure drop [Pa]. More... | |
bool | setPres (const double pres) |
Sets the reference pressure drop [Pa]. More... | |
bool | setPres (const std::string &pres) |
Sets the reference pressure drop [Pa]. More... | |
double | area1 () const |
Returns the leakage area per item [m^2]. More... | |
bool | setArea1 (const double area1) |
Sets the leakage area per item [m^2]. More... | |
bool | setArea1 (const std::string &area1) |
Sets the leakage area per item [m^2]. More... | |
double | area2 () const |
Returns the leakage area per unit length [m^2/m]. More... | |
bool | setArea2 (const double area2) |
Sets the leakage area per unit length [m^2/m]. More... | |
bool | setArea2 (const std::string &area2) |
Sets the leakage area per unit length [m^2/m]. More... | |
double | area3 () const |
Returns the leakage area per unit area [m^2/m^2]. More... | |
bool | setArea3 (const double area3) |
Sets the leakage area per unit area [m^2/m^2]. More... | |
bool | setArea3 (const std::string &area3) |
Sets the leakage area per unit area [m^2/m^2]. More... | |
int | u_A1 () const |
Returns the display units of area 1. More... | |
void | setU_A1 (const int u_A1) |
Sets the display units of area 1. More... | |
int | u_A2 () const |
Returns the display units of area 2. More... | |
void | setU_A2 (const int u_A2) |
Sets the display units of area 2. More... | |
int | u_A3 () const |
Returns the display units of area 3. More... | |
void | setU_A3 (const int u_A3) |
Sets the display units of area 3. More... | |
int | u_dP () const |
Returns the display units of pressure. More... | |
void | setU_dP (const int u_dP) |
Sets the display units of pressure. 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 PlrLeak object is the base class of the leakage area airflow elements.
openstudio::contam::PlrLeak::PlrLeak | ( | ) |
Create a new object with default values.
openstudio::contam::PlrLeak::PlrLeak | ( | int | nr, |
int | icon, | ||
std::string | name, | ||
std::string | desc | ||
) |
Create a new object.
openstudio::contam::PlrLeak::PlrLeak | ( | int | nr, |
int | icon, | ||
std::string | name, | ||
std::string | desc, | ||
double | lam, | ||
double | turb, | ||
double | expt, | ||
double | coef, | ||
double | pres, | ||
double | area1, | ||
double | area2, | ||
double | area3, | ||
int | u_A1, | ||
int | u_A2, | ||
int | u_A3, | ||
int | u_dP | ||
) |
Create a new object.
openstudio::contam::PlrLeak::PlrLeak | ( | int | nr, |
int | icon, | ||
std::string | name, | ||
std::string | desc, | ||
std::string | lam, | ||
std::string | turb, | ||
std::string | expt, | ||
std::string | coef, | ||
std::string | pres, | ||
std::string | area1, | ||
std::string | area2, | ||
std::string | area3, | ||
int | u_A1, | ||
int | u_A2, | ||
int | u_A3, | ||
int | u_dP | ||
) |
Create a new object.
openstudio::contam::PlrLeak::PlrLeak | ( | const PlrLeak & | other | ) |
Create a new object from another object.
openstudio::contam::PlrLeak::~PlrLeak | ( | ) |
Destroy the object.
double openstudio::contam::PlrLeak::area1 | ( | ) | const |
Returns the leakage area per item [m^2].
double openstudio::contam::PlrLeak::area2 | ( | ) | const |
Returns the leakage area per unit length [m^2/m].
double openstudio::contam::PlrLeak::area3 | ( | ) | const |
Returns the leakage area per unit area [m^2/m^2].
double openstudio::contam::PlrLeak::coef | ( | ) | const |
Returns the flow coefficient.
|
overridepure virtual |
Returns the element data type.
Implements openstudio::contam::AirflowElement.
Implemented in openstudio::contam::PlrLeak3, openstudio::contam::PlrLeak2, and openstudio::contam::PlrLeak1.
|
overridevirtual |
Returns the element description.
Implements openstudio::contam::AirflowElement.
double openstudio::contam::PlrLeak::expt | ( | ) | const |
Returns the pressure exponent.
|
overridevirtual |
Returns the icon used to represent flow path.
Implements openstudio::contam::AirflowElement.
double openstudio::contam::PlrLeak::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::PlrLeak::operator!= | ( | const PlrLeak & | other | ) | const |
Inequality operator.
bool openstudio::contam::PlrLeak::operator== | ( | const PlrLeak & | other | ) | const |
Equality operator.
double openstudio::contam::PlrLeak::pres | ( | ) | const |
Returns the reference pressure drop [Pa].
bool openstudio::contam::PlrLeak::setArea1 | ( | const double | area1 | ) |
Sets the leakage area per item [m^2].
bool openstudio::contam::PlrLeak::setArea1 | ( | const std::string & | area1 | ) |
Sets the leakage area per item [m^2].
bool openstudio::contam::PlrLeak::setArea2 | ( | const double | area2 | ) |
Sets the leakage area per unit length [m^2/m].
bool openstudio::contam::PlrLeak::setArea2 | ( | const std::string & | area2 | ) |
Sets the leakage area per unit length [m^2/m].
bool openstudio::contam::PlrLeak::setArea3 | ( | const double | area3 | ) |
Sets the leakage area per unit area [m^2/m^2].
bool openstudio::contam::PlrLeak::setArea3 | ( | const std::string & | area3 | ) |
Sets the leakage area per unit area [m^2/m^2].
bool openstudio::contam::PlrLeak::setCoef | ( | const double | coef | ) |
Sets the flow coefficient.
bool openstudio::contam::PlrLeak::setCoef | ( | const std::string & | coef | ) |
Sets the flow coefficient.
|
overridevirtual |
Sets the element description.
Implements openstudio::contam::AirflowElement.
bool openstudio::contam::PlrLeak::setExpt | ( | const double | expt | ) |
Sets the pressure exponent.
bool openstudio::contam::PlrLeak::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::PlrLeak::setLam | ( | const double | lam | ) |
Sets the laminar flow coefficient.
bool openstudio::contam::PlrLeak::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::PlrLeak::setPres | ( | const double | pres | ) |
Sets the reference pressure drop [Pa].
bool openstudio::contam::PlrLeak::setPres | ( | const std::string & | pres | ) |
Sets the reference pressure drop [Pa].
bool openstudio::contam::PlrLeak::setTurb | ( | const double | turb | ) |
Sets the turbulent flow coefficient.
bool openstudio::contam::PlrLeak::setTurb | ( | const std::string & | turb | ) |
Sets the turbulent flow coefficient.
void openstudio::contam::PlrLeak::setU_A1 | ( | const int | u_A1 | ) |
Sets the display units of area 1.
void openstudio::contam::PlrLeak::setU_A2 | ( | const int | u_A2 | ) |
Sets the display units of area 2.
void openstudio::contam::PlrLeak::setU_A3 | ( | const int | u_A3 | ) |
Sets the display units of area 3.
void openstudio::contam::PlrLeak::setU_dP | ( | const int | u_dP | ) |
Sets the display units of pressure.
double openstudio::contam::PlrLeak::turb | ( | ) | const |
Returns the turbulent flow coefficient.
int openstudio::contam::PlrLeak::u_A1 | ( | ) | const |
Returns the display units of area 1.
int openstudio::contam::PlrLeak::u_A2 | ( | ) | const |
Returns the display units of area 2.
int openstudio::contam::PlrLeak::u_A3 | ( | ) | const |
Returns the display units of area 3.
int openstudio::contam::PlrLeak::u_dP | ( | ) | const |
Returns the display units of pressure.
|
overridevirtual |
Write the object to a string.
Implements openstudio::contam::AirflowElement.