openstudio::contam::AfeFan Class Reference

#include <PrjAirflowElements.hpp>

Inheritance diagram for openstudio::contam::AfeFan:

Public Member Functions
Constructors and Destructors
	AfeFan ()
	Create a new object with default values.
	AfeFan (int nr, int icon, std::string name, std::string desc)
	Create a new object.
	AfeFan (int nr, int icon, std::string name, std::string desc, double lam, double turb, double expt, double rdens, double fdf, double sop, double off, std::vector< double > fpc, double Sarea, int u_Sa, std::vector< FanDataPoint > data)
	Create a new object.
	AfeFan (int nr, int icon, std::string name, std::string desc, std::string lam, std::string turb, std::string expt, std::string rdens, std::string fdf, std::string sop, std::string off, std::vector< std::string > fpc, std::string Sarea, int u_Sa, std::vector< FanDataPoint > data)
	Create a new object.
	AfeFan (const AfeFan &other)
	Create a new object from another object.
virtual	~AfeFan () override=default
	Destroy the object.
Operators
AfeFan &	operator= (const AfeFan &other)
	Copy operator.
bool	operator== (const AfeFan &other) const
	Equality operator.
bool	operator!= (const AfeFan &other) const
	Inequality operator.
Input and Output
void	read (Reader &input)
	Read an object from a Reader.
void	readDetails (Reader &input)
	Read object details from a Reader.
std::string	write () override
	Write the object to a string.
Getters and Setters
int	nr () const override
	Returns the element number, in order from 1 to the number of airflow elements.
void	setNr (const int nr) override
	Sets the element number.
int	icon () const override
	Returns the icon used to represent flow path.
void	setIcon (const int icon) override
	Sets the icon used to represent flow path.
std::string	dataType () const override
	Returns the element data type.
std::string	name () const override
	Returns the element name.
void	setName (const std::string &name) override
	Sets the element name.
std::string	desc () const override
	Returns the element description.
void	setDesc (const std::string &desc) override
	Sets the element description.
double	lam () const
	Returns the laminar flow coefficient.
bool	setLam (const double lam)
	Sets the laminar flow coefficient.
bool	setLam (const std::string &lam)
	Sets the laminar flow coefficient.
double	turb () const
	Returns the turbulent flow coefficient.
bool	setTurb (const double turb)
	Sets the turbulent flow coefficient.
bool	setTurb (const std::string &turb)
	Sets the turbulent flow coefficient.
double	expt () const
	Returns the pressure exponent.
bool	setExpt (const double expt)
	Sets the pressure exponent.
bool	setExpt (const std::string &expt)
	Sets the pressure exponent.
double	rdens () const
	Returns the reference fluid density [kg/m^3].
bool	setRdens (const double rdens)
	Sets the reference fluid density [kg/m^3].
bool	setRdens (const std::string &rdens)
	Sets the reference fluid density [kg/m^3].
double	fdf () const
	Returns the free delivery flow (prise = 0) [kg/s].
bool	setFdf (const double fdf)
	Returns the free delivery flow (prise = 0) [kg/s].
bool	setFdf (const std::string &fdf)
	Returns the free delivery flow (prise = 0) [kg/s].
double	sop () const
	Returns the shut-off pressure (flow = 0) [Pa].
bool	setSop (const double sop)
	Sets the shut-off pressure (flow = 0) [Pa].
bool	setSop (const std::string &sop)
	Sets the shut-off pressure (flow = 0) [Pa].
double	off () const
	Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.
bool	setOff (const double off)
	Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.
bool	setOff (const std::string &off)
	Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.
std::vector< double >	fpc () const
	Returns the fan performance polynomial coefficients.
bool	setFpc (const std::vector< double > &fpc)
	Sets the fan performance polynomial coefficients.
bool	setFpc (const std::vector< std::string > &fpc)
	Sets the fan performance polynomial coefficients.
double	Sarea () const
	Returns the shut-off orifice area [m^2].
bool	setSarea (const double Sarea)
	Returns the shut-off orifice area [m^2].
bool	setSarea (const std::string &Sarea)
	Returns the shut-off orifice area [m^2].
int	u_Sa () const
	Returns the display units of shut-off orifice area.
void	setU_Sa (const int u_Sa)
	Sets the display units of shut-off orifice area.
std::vector< FanDataPoint >	data () const
	Returns the vector of fan data points.
void	setData (const std::vector< FanDataPoint > &data)
	Sets the vector of fan data points.
Public Member Functions inherited from openstudio::contam::AirflowElement
virtual	~AirflowElement ()=default
	Destroy the object.

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.
static AirflowElement *	readElement (Reader &input)
	Read an airflow element from a Reader object.

Detailed Description

The AfeFan object is an airflow element representing a fan with performance data.

Constructor & Destructor Documentation

AfeFan() [1/5]

openstudio::contam::AfeFan::AfeFan

(

)

Create a new object with default values.

AfeFan() [2/5]

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

Create a new object.

AfeFan() [3/5]

openstudio::contam::AfeFan::AfeFan	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		double	lam,
		double	turb,
		double	expt,
		double	rdens,
		double	fdf,
		double	sop,
		double	off,
		std::vector< double >	fpc,
		double	Sarea,
		int	u_Sa,
		std::vector< FanDataPoint >	data )

Create a new object.

AfeFan() [4/5]

openstudio::contam::AfeFan::AfeFan	(	int	nr,
		int	icon,
		std::string	name,
		std::string	desc,
		std::string	lam,
		std::string	turb,
		std::string	expt,
		std::string	rdens,
		std::string	fdf,
		std::string	sop,
		std::string	off,
		std::vector< std::string >	fpc,
		std::string	Sarea,
		int	u_Sa,
		std::vector< FanDataPoint >	data )

Create a new object.

AfeFan() [5/5]

openstudio::contam::AfeFan::AfeFan

(

const AfeFan &

other

)

Create a new object from another object.

~AfeFan()

virtual openstudio::contam::AfeFan::~AfeFan ( )

overridevirtualdefault

Destroy the object.

Member Function Documentation

data()

std::vector< FanDataPoint > openstudio::contam::AfeFan::data

(

)

const

Returns the vector of fan data points.

dataType()

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

inlineoverridevirtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

desc()

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

overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

expt()

double openstudio::contam::AfeFan::expt

(

)

const

Returns the pressure exponent.

fdf()

double openstudio::contam::AfeFan::fdf

(

)

const

Returns the free delivery flow (prise = 0) [kg/s].

fpc()

std::vector< double > openstudio::contam::AfeFan::fpc

(

)

const

Returns the fan performance polynomial coefficients.

icon()

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

overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

lam()

double openstudio::contam::AfeFan::lam

(

)

const

Returns the laminar flow coefficient.

name()

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

overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

nr()

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

overridevirtual

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

Implements openstudio::contam::AirflowElement.

off()

double openstudio::contam::AfeFan::off

(

)

const

Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.

operator!=()

bool openstudio::contam::AfeFan::operator!=

(

const AfeFan &

other

)

const

Inequality operator.

operator=()

AfeFan & openstudio::contam::AfeFan::operator=

(

const AfeFan &

other

)

Copy operator.

operator==()

bool openstudio::contam::AfeFan::operator==

(

const AfeFan &

other

)

const

Equality operator.

rdens()

double openstudio::contam::AfeFan::rdens

(

)

const

Returns the reference fluid density [kg/m^3].

read()

void openstudio::contam::AfeFan::read

(

Reader &

input

)

Read an object from a Reader.

readDetails()

void openstudio::contam::AfeFan::readDetails

(

Reader &

input

)

Read object details from a Reader.

Sarea()

double openstudio::contam::AfeFan::Sarea

(

)

const

Returns the shut-off orifice area [m^2].

setData()

void openstudio::contam::AfeFan::setData

(

const std::vector< FanDataPoint > &

data

)

Sets the vector of fan data points.

setDesc()

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

overridevirtual

Sets the element description.

Implements openstudio::contam::AirflowElement.

setExpt() [1/2]

bool openstudio::contam::AfeFan::setExpt

(

const double

expt

)

Sets the pressure exponent.

setExpt() [2/2]

bool openstudio::contam::AfeFan::setExpt

(

const std::string &

expt

)

Sets the pressure exponent.

setFdf() [1/2]

bool openstudio::contam::AfeFan::setFdf

(

const double

fdf

)

Returns the free delivery flow (prise = 0) [kg/s].

setFdf() [2/2]

bool openstudio::contam::AfeFan::setFdf

(

const std::string &

fdf

)

Returns the free delivery flow (prise = 0) [kg/s].

setFpc() [1/2]

bool openstudio::contam::AfeFan::setFpc

(

const std::vector< double > &

fpc

)

Sets the fan performance polynomial coefficients.

setFpc() [2/2]

bool openstudio::contam::AfeFan::setFpc

(

const std::vector< std::string > &

fpc

)

Sets the fan performance polynomial coefficients.

setIcon()

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

overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

setLam() [1/2]

bool openstudio::contam::AfeFan::setLam

(

const double

lam

)

Sets the laminar flow coefficient.

setLam() [2/2]

bool openstudio::contam::AfeFan::setLam

(

const std::string &

lam

)

Sets the laminar flow coefficient.

setName()

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

overridevirtual

Sets the element name.

Implements openstudio::contam::AirflowElement.

setNr()

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

overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

setOff() [1/2]

bool openstudio::contam::AfeFan::setOff

(

const double

off

)

Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.

setOff() [2/2]

bool openstudio::contam::AfeFan::setOff

(

const std::string &

off

)

Returns the minimum RPM fraction: fan is off if (RPM/rated RPM) < off.

setRdens() [1/2]

bool openstudio::contam::AfeFan::setRdens

(

const double

rdens

)

Sets the reference fluid density [kg/m^3].

setRdens() [2/2]

bool openstudio::contam::AfeFan::setRdens

(

const std::string &

rdens

)

Sets the reference fluid density [kg/m^3].

setSarea() [1/2]

bool openstudio::contam::AfeFan::setSarea

(

const double

Sarea

)

Returns the shut-off orifice area [m^2].

setSarea() [2/2]

bool openstudio::contam::AfeFan::setSarea

(

const std::string &

Sarea

)

Returns the shut-off orifice area [m^2].

setSop() [1/2]

bool openstudio::contam::AfeFan::setSop

(

const double

sop

)

Sets the shut-off pressure (flow = 0) [Pa].

setSop() [2/2]

bool openstudio::contam::AfeFan::setSop

(

const std::string &

sop

)

Sets the shut-off pressure (flow = 0) [Pa].

setTurb() [1/2]

bool openstudio::contam::AfeFan::setTurb

(

const double

turb

)

Sets the turbulent flow coefficient.

setTurb() [2/2]

bool openstudio::contam::AfeFan::setTurb

(

const std::string &

turb

)

Sets the turbulent flow coefficient.

setU_Sa()

void openstudio::contam::AfeFan::setU_Sa

(

const int

u_Sa

)

Sets the display units of shut-off orifice area.

sop()

double openstudio::contam::AfeFan::sop

(

)

const

Returns the shut-off pressure (flow = 0) [Pa].

turb()

double openstudio::contam::AfeFan::turb

(

)

const

Returns the turbulent flow coefficient.

u_Sa()

int openstudio::contam::AfeFan::u_Sa

(

)

const

Returns the display units of shut-off orifice area.

write()

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

overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.