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

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::PlrTest2:

Public Member Functions

Constructors and Destructors
 PlrTest2 ()
 Create a new object with default values. More...
 
 PlrTest2 (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 PlrTest2 (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double dP1, double F1, double dP2, double F2, int u_P1, int u_F1, int u_P2, int u_F2)
 Create a new object. More...
 
 PlrTest2 (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string dP1, std::string F1, std::string dP2, std::string F2, int u_P1, int u_F1, int u_P2, int u_F2)
 Create a new object. More...
 
 PlrTest2 (const PlrTest2 &other)
 Create a new object from another object. More...
 
 ~PlrTest2 ()
 Destroy the object. More...
 
Operators
PlrTest2operator= (const PlrTest2 &other)
 Copy operator. More...
 
bool operator== (const PlrTest2 &other) const
 Equality operator. More...
 
bool operator!= (const PlrTest2 &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 dP1 () const
 Returns the point 1 pressure drop [Pa]. More...
 
bool setDP1 (const double dP)
 Sets the point 1 pressure drop [Pa]. More...
 
bool setDP1 (const std::string &dP)
 Sets the point 1 pressure drop [Pa]. More...
 
double F1 () const
 Returns the point 1 flow rate [kg/s]. More...
 
bool setF1 (const double Flow)
 Sets the point 1 flow rate [kg/s]. More...
 
bool setF1 (const std::string &Flow)
 Sets the point 1 flow rate [kg/s]. More...
 
double dP2 () const
 Returns the point 2 pressure drop [Pa]. More...
 
bool setDP2 (const double dP)
 Sets the point 2 pressure drop [Pa]. More...
 
bool setDP2 (const std::string &dP)
 Sets the point 2 pressure drop [Pa]. More...
 
double F2 () const
 Returns the point 2 flow rate [kg/s]. More...
 
bool setF2 (const double Flow)
 Sets the point 2 flow rate [kg/s]. More...
 
bool setF2 (const std::string &Flow)
 Sets the point 2 flow rate [kg/s]. More...
 
int u_P1 () const
 Returns the display units of point 1 pressure drop. More...
 
void setU_P1 (const int u_P)
 Sets the display units of point 1 pressure drop. More...
 
int u_F1 () const
 Returns the display units of point 1 flow. More...
 
void setU_F1 (const int u_F)
 Sets the display units of point 1 flow. More...
 
int u_P2 () const
 Returns the display units of point 2 pressure drop. More...
 
void setU_P2 (const int u_P)
 Sets the display units of point 2 pressure drop. More...
 
int u_F2 () const
 Returns the display units of point 2 flow. More...
 
void setU_F2 (const int u_F)
 Sets the display units of point 2 flow. 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 PlrTest2 object is an airflow element representing 2-point test data power law leakage.

Constructor & Destructor Documentation

openstudio::contam::PlrTest2::PlrTest2 ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::PlrTest2::PlrTest2 ( int  nr,
int  icon,
std::string  name,
std::string  desc,
double  lam,
double  turb,
double  expt,
double  dP1,
double  F1,
double  dP2,
double  F2,
int  u_P1,
int  u_F1,
int  u_P2,
int  u_F2 
)

Create a new object.

openstudio::contam::PlrTest2::PlrTest2 ( int  nr,
int  icon,
std::string  name,
std::string  desc,
std::string  lam,
std::string  turb,
std::string  expt,
std::string  dP1,
std::string  F1,
std::string  dP2,
std::string  F2,
int  u_P1,
int  u_F1,
int  u_P2,
int  u_F2 
)

Create a new object.

openstudio::contam::PlrTest2::PlrTest2 ( const PlrTest2 other)

Create a new object from another object.

openstudio::contam::PlrTest2::~PlrTest2 ( )

Destroy the object.

Member Function Documentation

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

Returns the element data type.

Implements openstudio::contam::AirflowElement.

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

Returns the element description.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::PlrTest2::dP1 ( ) const

Returns the point 1 pressure drop [Pa].

double openstudio::contam::PlrTest2::dP2 ( ) const

Returns the point 2 pressure drop [Pa].

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

Returns the pressure exponent.

double openstudio::contam::PlrTest2::F1 ( ) const

Returns the point 1 flow rate [kg/s].

double openstudio::contam::PlrTest2::F2 ( ) const

Returns the point 2 flow rate [kg/s].

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

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the laminar flow coefficient.

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

Returns the element name.

Implements openstudio::contam::AirflowElement.

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

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

Implements openstudio::contam::AirflowElement.

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

Inequality operator.

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

Copy operator.

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

Equality operator.

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

Read an object from a Reader.

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

Read object details from a Reader.

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

Sets the element description.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::PlrTest2::setDP1 ( const double  dP)

Sets the point 1 pressure drop [Pa].

bool openstudio::contam::PlrTest2::setDP1 ( const std::string &  dP)

Sets the point 1 pressure drop [Pa].

bool openstudio::contam::PlrTest2::setDP2 ( const double  dP)

Sets the point 2 pressure drop [Pa].

bool openstudio::contam::PlrTest2::setDP2 ( const std::string &  dP)

Sets the point 2 pressure drop [Pa].

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

Sets the pressure exponent.

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

Sets the pressure exponent.

bool openstudio::contam::PlrTest2::setF1 ( const double  Flow)

Sets the point 1 flow rate [kg/s].

bool openstudio::contam::PlrTest2::setF1 ( const std::string &  Flow)

Sets the point 1 flow rate [kg/s].

bool openstudio::contam::PlrTest2::setF2 ( const double  Flow)

Sets the point 2 flow rate [kg/s].

bool openstudio::contam::PlrTest2::setF2 ( const std::string &  Flow)

Sets the point 2 flow rate [kg/s].

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

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the laminar flow coefficient.

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

Sets the laminar flow coefficient.

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

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

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

Sets the turbulent flow coefficient.

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

Sets the turbulent flow coefficient.

void openstudio::contam::PlrTest2::setU_F1 ( const int  u_F)

Sets the display units of point 1 flow.

void openstudio::contam::PlrTest2::setU_F2 ( const int  u_F)

Sets the display units of point 2 flow.

void openstudio::contam::PlrTest2::setU_P1 ( const int  u_P)

Sets the display units of point 1 pressure drop.

void openstudio::contam::PlrTest2::setU_P2 ( const int  u_P)

Sets the display units of point 2 pressure drop.

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

Returns the turbulent flow coefficient.

int openstudio::contam::PlrTest2::u_F1 ( ) const

Returns the display units of point 1 flow.

int openstudio::contam::PlrTest2::u_F2 ( ) const

Returns the display units of point 2 flow.

int openstudio::contam::PlrTest2::u_P1 ( ) const

Returns the display units of point 1 pressure drop.

int openstudio::contam::PlrTest2::u_P2 ( ) const

Returns the display units of point 2 pressure drop.

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

Write the object to a string.

Implements openstudio::contam::AirflowElement.