#include <PrjAirflowElements.hpp>

Inheritance diagram for openstudio::contam::PlrCrack:

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

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

	PlrCrack (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double length, double width, int u_L, int u_W)
	Create a new object. More...

	PlrCrack (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string length, std::string width, int u_L, int u_W)
	Create a new object. More...

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

	~PlrCrack ()=default
	Destroy the object. More...

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

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

bool	operator!= (const PlrCrack &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	length () const
	Returns the crack length [m]. More...

bool	setLength (const double length)
	Sets the crack length [m]. More...

bool	setLength (const std::string &length)
	Sets the crack length [m]. More...

double	width () const
	Returns the crack width [m]. More...

bool	setWidth (const double width)
	Sets the crack width [m]. More...

bool	setWidth (const std::string &width)
	Sets the crack width [m]. More...

int	u_L () const
	Returns the display units of length. More...

void	setU_L (const int u_L)
	Sets the display units of length. More...

int	u_W () const
	Returns the display units of width. More...

void	setU_W (const int u_W)
	Sets the display units of width. 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 PlrCrack object is an airflow element representing power law leakage through a crack.

Constructor & Destructor Documentation

openstudio::contam::PlrCrack::PlrCrack ( )

Create a new object with default values.

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

Create a new object.

openstudio::contam::PlrCrack::PlrCrack	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		double	lam,
		double	turb,
		double	expt,
		double	length,
		double	width,
		int	u_L,
		int	u_W
	)

Create a new object.

openstudio::contam::PlrCrack::PlrCrack	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		std::string	lam,
		std::string	turb,
		std::string	expt,
		std::string	length,
		std::string	width,
		int	u_L,
		int	u_W
	)

Create a new object.

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

Create a new object from another object.

openstudio::contam::PlrCrack::~PlrCrack ( )

default

Destroy the object.

Member Function Documentation

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

inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

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

Returns the pressure exponent.

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

overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the laminar flow coefficient.

double openstudio::contam::PlrCrack::length ( ) const

Returns the crack length [m].

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

overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

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

Implements openstudio::contam::AirflowElement.

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

Inequality operator.

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

Copy operator.

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

Equality operator.

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

Read an object from a Reader.

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

Read object details from a Reader.

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

overridevirtual

Sets the element description.

Implements openstudio::contam::AirflowElement.

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

Sets the pressure exponent.

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

Sets the pressure exponent.

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

overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the laminar flow coefficient.

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

Sets the laminar flow coefficient.

bool openstudio::contam::PlrCrack::setLength ( const double length )

Sets the crack length [m].

bool openstudio::contam::PlrCrack::setLength ( const std::string & length )

Sets the crack length [m].

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

overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

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

overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

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

Sets the turbulent flow coefficient.

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

Sets the turbulent flow coefficient.

void openstudio::contam::PlrCrack::setU_L ( const int u_L )

Sets the display units of length.

void openstudio::contam::PlrCrack::setU_W ( const int u_W )

Sets the display units of width.

bool openstudio::contam::PlrCrack::setWidth ( const double width )

Sets the crack width [m].

bool openstudio::contam::PlrCrack::setWidth ( const std::string & width )

Sets the crack width [m].

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

Returns the turbulent flow coefficient.

int openstudio::contam::PlrCrack::u_L ( ) const

Returns the display units of length.

int openstudio::contam::PlrCrack::u_W ( ) const

Returns the display units of width.

double openstudio::contam::PlrCrack::width ( ) const

Returns the crack width [m].

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