#include <PrjAirflowElements.hpp>

Inheritance diagram for openstudio::contam::PlrShaft:

Public Member Functions
Constructors and Destructors
	PlrShaft ()
	Create a new object with default values. More...

	PlrShaft (int nr, int icon, std::string name, std::string desc)
	Create a new object. More...

	PlrShaft (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double Ht, double area, double perim, double rough, int u_A, int u_D, int u_P, int u_R)
	Create a new object. More...

	PlrShaft (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string Ht, std::string area, std::string perim, std::string rough, int u_A, int u_D, int u_P, int u_R)
	Create a new object. More...

	PlrShaft (const PlrShaft &other)
	Create a new object from another object. More...

virtual	~PlrShaft () override=default
	Destroy the object. More...

Operators
PlrShaft &	operator= (const PlrShaft &other)
	Copy operator. More...

bool	operator== (const PlrShaft &other) const
	Equality operator. More...

bool	operator!= (const PlrShaft &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	Ht () const
	Returns the distance between levels [m]. More...

bool	setHt (const double Ht)
	Sets the distance between levels [m]. More...

bool	setHt (const std::string &Ht)
	Sets the distance between levels [m]. More...

double	area () const
	Returns the cross-sectional area [m^2]. More...

bool	setArea (const double Area)
	Sets the cross-sectional area [m^2]. More...

bool	setArea (const std::string &Area)
	Sets the cross-sectional area [m^2]. More...

double	perim () const
	Returns the perimeter [m]. More...

bool	setPerim (const double perim)
	Sets the perimeter [m]. More...

bool	setPerim (const std::string &perim)
	Sets the perimeter [m]. More...

double	rough () const
	Returns the roughness [m]. More...

bool	setRough (const double rough)
	Sets the roughness [m]. More...

bool	setRough (const std::string &rough)
	Sets the roughness [m]. More...

int	u_A () const
	Returns the display units of area. More...

void	setU_A (const int u_A)
	Sets the display units of area. More...

int	u_D () const
	Returns the display units of distance. More...

void	setU_D (const int u_D)
	Sets the display units of distance. More...

int	u_P () const
	Returns the display units of perimeter. More...

void	setU_P (const int u_P)
	Sets the display units of perimeter. More...

int	u_R () const
	Returns the display units of roughness. More...

void	setU_R (const int u_R)
	Sets the display units of roughness. 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 PlrShaft object is an airflow element representing level-to-level power law leakage in shafts.

Constructor & Destructor Documentation

openstudio::contam::PlrShaft::PlrShaft ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::PlrShaft::PlrShaft	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		double	lam,
		double	turb,
		double	expt,
		double	Ht,
		double	area,
		double	perim,
		double	rough,
		int	u_A,
		int	u_D,
		int	u_P,
		int	u_R
	)

Create a new object.

openstudio::contam::PlrShaft::PlrShaft	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		std::string	lam,
		std::string	turb,
		std::string	expt,
		std::string	Ht,
		std::string	area,
		std::string	perim,
		std::string	rough,
		int	u_A,
		int	u_D,
		int	u_P,
		int	u_R
	)

Create a new object.

openstudio::contam::PlrShaft::PlrShaft ( const PlrShaft & other )

Create a new object from another object.

virtual openstudio::contam::PlrShaft::~PlrShaft ( )

overridevirtualdefault

Destroy the object.

Member Function Documentation

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

Returns the cross-sectional area [m^2].

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

inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

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

Returns the pressure exponent.

double openstudio::contam::PlrShaft::Ht ( ) const

Returns the distance between levels [m].

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

overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the laminar flow coefficient.

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

overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

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

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::PlrShaft::operator!= ( const PlrShaft & other ) const

Inequality operator.

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

Copy operator.

bool openstudio::contam::PlrShaft::operator== ( const PlrShaft & other ) const

Equality operator.

double openstudio::contam::PlrShaft::perim ( ) const

Returns the perimeter [m].

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

Read an object from a Reader.

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

Read object details from a Reader.

double openstudio::contam::PlrShaft::rough ( ) const

Returns the roughness [m].

bool openstudio::contam::PlrShaft::setArea ( const double Area )

Sets the cross-sectional area [m^2].

bool openstudio::contam::PlrShaft::setArea ( const std::string & Area )

Sets the cross-sectional area [m^2].

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

overridevirtual

Sets the element description.

Implements openstudio::contam::AirflowElement.

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

Sets the pressure exponent.

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

Sets the pressure exponent.

bool openstudio::contam::PlrShaft::setHt ( const double Ht )

Sets the distance between levels [m].

bool openstudio::contam::PlrShaft::setHt ( const std::string & Ht )

Sets the distance between levels [m].

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

overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the laminar flow coefficient.

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

Sets the laminar flow coefficient.

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

overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::PlrShaft::setPerim ( const double perim )

Sets the perimeter [m].

bool openstudio::contam::PlrShaft::setPerim ( const std::string & perim )

Sets the perimeter [m].

bool openstudio::contam::PlrShaft::setRough ( const double rough )

Sets the roughness [m].

bool openstudio::contam::PlrShaft::setRough ( const std::string & rough )

Sets the roughness [m].

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

Sets the turbulent flow coefficient.

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

Sets the turbulent flow coefficient.

void openstudio::contam::PlrShaft::setU_A ( const int u_A )

Sets the display units of area.

void openstudio::contam::PlrShaft::setU_D ( const int u_D )

Sets the display units of distance.

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

Sets the display units of perimeter.

void openstudio::contam::PlrShaft::setU_R ( const int u_R )

Sets the display units of roughness.

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

Returns the turbulent flow coefficient.

int openstudio::contam::PlrShaft::u_A ( ) const

Returns the display units of area.

int openstudio::contam::PlrShaft::u_D ( ) const

Returns the display units of distance.

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

Returns the display units of perimeter.

int openstudio::contam::PlrShaft::u_R ( ) const

Returns the display units of roughness.

std::string openstudio::contam::PlrShaft::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