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

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::PlrTest1:

Public Member Functions

Constructors and Destructors
 PlrTest1 ()
 Create a new object with default values. More...
 
 PlrTest1 (int nr, int icon, std::string name, std::string desc)
 Create a new object. More...
 
 PlrTest1 (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double dP, double Flow, int u_P, int u_F)
 Create a new object. More...
 
 PlrTest1 (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string dP, std::string Flow, int u_P, int u_F)
 Create a new object. More...
 
 PlrTest1 (int icon, std::string name, std::string desc, double lam, double turb, double expt, double dP, double Flow)
 Create a new object. More...
 
 PlrTest1 (int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string dP, std::string Flow)
 Create a new object. More...
 
 PlrTest1 (const PlrTest1 &other)
 Create a new object from another object. More...
 
 ~PlrTest1 ()
 Destroy the object. More...
 
Operators
PlrTest1operator= (const PlrTest1 &other)
 Copy operator. More...
 
bool operator== (const PlrTest1 &other) const
 Equality operator. More...
 
bool operator!= (const PlrTest1 &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 dP () const
 Returns the pressure drop [Pa]. More...
 
bool setDP (const double dP)
 Sets the pressure drop [Pa]. More...
 
bool setDP (const std::string &dP)
 Sets the pressure drop [Pa]. More...
 
double Flow () const
 Returns the flow rate [kg/s]. More...
 
bool setFlow (const double Flow)
 Sets the flow rate [kg/s]. More...
 
bool setFlow (const std::string &Flow)
 Sets the flow rate [kg/s]. More...
 
int u_P () const
 Returns the display units of pressure drop. More...
 
void setU_P (const int u_P)
 Sets the display units of pressure drop. More...
 
int u_F () const
 Returns the display units of flow. More...
 
void setU_F (const int u_F)
 Sets the display units of 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 PlrTest1 object is an airflow element representing 1-point test data power law leakage.

Constructor & Destructor Documentation

openstudio::contam::PlrTest1::PlrTest1 ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::PlrTest1::PlrTest1 ( int  nr,
int  icon,
std::string  name,
std::string  desc,
double  lam,
double  turb,
double  expt,
double  dP,
double  Flow,
int  u_P,
int  u_F 
)

Create a new object.

openstudio::contam::PlrTest1::PlrTest1 ( int  nr,
int  icon,
std::string  name,
std::string  desc,
std::string  lam,
std::string  turb,
std::string  expt,
std::string  dP,
std::string  Flow,
int  u_P,
int  u_F 
)

Create a new object.

openstudio::contam::PlrTest1::PlrTest1 ( int  icon,
std::string  name,
std::string  desc,
double  lam,
double  turb,
double  expt,
double  dP,
double  Flow 
)

Create a new object.

openstudio::contam::PlrTest1::PlrTest1 ( int  icon,
std::string  name,
std::string  desc,
std::string  lam,
std::string  turb,
std::string  expt,
std::string  dP,
std::string  Flow 
)

Create a new object.

openstudio::contam::PlrTest1::PlrTest1 ( const PlrTest1 other)

Create a new object from another object.

openstudio::contam::PlrTest1::~PlrTest1 ( )

Destroy the object.

Member Function Documentation

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

Returns the element data type.

Implements openstudio::contam::AirflowElement.

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

Returns the element description.

Implements openstudio::contam::AirflowElement.

double openstudio::contam::PlrTest1::dP ( ) const

Returns the pressure drop [Pa].

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

Returns the pressure exponent.

double openstudio::contam::PlrTest1::Flow ( ) const

Returns the flow rate [kg/s].

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

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the laminar flow coefficient.

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

Returns the element name.

Implements openstudio::contam::AirflowElement.

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

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

Implements openstudio::contam::AirflowElement.

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

Inequality operator.

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

Copy operator.

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

Equality operator.

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

Read an object from a Reader.

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

Read object details from a Reader.

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

Sets the element description.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::PlrTest1::setDP ( const double  dP)

Sets the pressure drop [Pa].

bool openstudio::contam::PlrTest1::setDP ( const std::string &  dP)

Sets the pressure drop [Pa].

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

Sets the pressure exponent.

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

Sets the pressure exponent.

bool openstudio::contam::PlrTest1::setFlow ( const double  Flow)

Sets the flow rate [kg/s].

bool openstudio::contam::PlrTest1::setFlow ( const std::string &  Flow)

Sets the flow rate [kg/s].

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

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the laminar flow coefficient.

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

Sets the laminar flow coefficient.

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

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

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

Sets the turbulent flow coefficient.

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

Sets the turbulent flow coefficient.

void openstudio::contam::PlrTest1::setU_F ( const int  u_F)

Sets the display units of flow.

void openstudio::contam::PlrTest1::setU_P ( const int  u_P)

Sets the display units of pressure drop.

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

Returns the turbulent flow coefficient.

int openstudio::contam::PlrTest1::u_F ( ) const

Returns the display units of flow.

int openstudio::contam::PlrTest1::u_P ( ) const

Returns the display units of pressure drop.

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

Write the object to a string.

Implements openstudio::contam::AirflowElement.