openstudio::contam::PlrFcn Class Reference

#include <PrjAirflowElements.hpp>

Inheritance diagram for openstudio::contam::PlrFcn:

Public Member Functions
Constructors and Destructors
	PlrFcn ()
	Create a new object with default values. More...
	PlrFcn (int nr, int icon, std::string name, std::string desc)
	Create a new object. More...
	PlrFcn (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt)
	Create a new object. More...
	PlrFcn (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt)
	Create a new object. More...
virtual	~PlrFcn () override=default
	Destroy the object. More...
Getters and Setters
std::string	dataType () const override
	Returns the element data type. More...
Public Member Functions inherited from openstudio::contam::PlrGeneral
	PlrGeneral ()
	Create a new object with default values. More...
	PlrGeneral (int nr, int icon, std::string name, std::string desc)
	Create a new object. More...
	PlrGeneral (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt)
	Create a new object. More...
	PlrGeneral (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt)
	Create a new object. More...
	PlrGeneral (const PlrGeneral &other)
	Create a new object from another object. More...
virtual	~PlrGeneral () override=default
	Destroy the object. More...
PlrGeneral &	operator= (const PlrGeneral &other)
	Copy operator. More...
bool	operator== (const PlrGeneral &other) const
	Equality operator. More...
bool	operator!= (const PlrGeneral &other) const
	Inequality operator. More...
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...
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	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...
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 PlrQcn object is an airflow element representing mass flow rate power law leakage.

Constructor & Destructor Documentation

openstudio::contam::PlrFcn::PlrFcn

(

)

Create a new object with default values.

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

Create a new object.

openstudio::contam::PlrFcn::PlrFcn	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		double	lam,
		double	turb,
		double	expt
	)

Create a new object.

openstudio::contam::PlrFcn::PlrFcn	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		std::string	lam,
		std::string	turb,
		std::string	expt
	)

Create a new object.

virtual openstudio::contam::PlrFcn::~PlrFcn ( )

overridevirtualdefault

Destroy the object.

Member Function Documentation

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

inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::PlrGeneral.