#include <PrjAirflowElements.hpp>

Inheritance diagram for openstudio::contam::PlrOrf:

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...

virtual	~PlrOrf () override=default
	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 ()=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 AirflowElement *	readElement (Reader &input)
	Read an airflow element from a Reader object. More...

Detailed Description

The PlrOrj object is an airflow element representing an orifice.

Constructor & Destructor Documentation

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.

virtual openstudio::contam::PlrOrf::~PlrOrf ( )

overridevirtualdefault

Destroy the object.

Member Function Documentation

double openstudio::contam::PlrOrf::area ( ) const

Returns the actual area [m^2].

double openstudio::contam::PlrOrf::coef ( ) const

Returns the flow coefficient.

std::string openstudio::contam::PlrOrf::dataType ( ) const

inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

std::string openstudio::contam::PlrOrf::desc ( ) const

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.

int openstudio::contam::PlrOrf::icon ( ) const

overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the laminar flow coefficient.

std::string openstudio::contam::PlrOrf::name ( ) const

overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

int openstudio::contam::PlrOrf::nr ( ) const

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.

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

Copy 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.

void openstudio::contam::PlrOrf::read ( Reader & input )

Read an object from a Reader.

void openstudio::contam::PlrOrf::readDetails ( Reader & input )

Read object details from a Reader.

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.

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

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.

void openstudio::contam::PlrOrf::setIcon ( const int icon )

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.

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

overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::PlrOrf::setNr ( const int nr )

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.

std::string openstudio::contam::PlrOrf::write ( )

overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation