openstudio::contam::Species Class Reference

#include <PrjObjects.hpp>

Public Member Functions
Constructors and Destructors
	Species ()
	Create a new object with default values.
	Species (std::string molwt, std::string Dm, std::string ccdef, std::string Cp, std::string name, std::string desc)
	Create a new gaseous species object.
	Species (double molwt, double Dm, double ccdef, double Cp, std::string name, std::string desc)
	Create a new gaseous species object.
	Species (int nr, int sflag, int ntflag, std::string molwt, std::string mdiam, std::string edens, std::string decay, std::string Dm, std::string ccdef, std::string Cp, int uc, int umd, int ued, int udm, int ucp, std::string name, std::string desc)
	Create a new object.
	Species (int nr, int sflag, int ntflag, double molwt, double mdiam, double edens, double decay, double Dm, double ccdef, double Cp, int ucc, int umd, int ued, int udm, int ucp, std::string name, std::string desc)
	Create a new object.
	Species (const Species &other)
	Create a new object from another object.
	~Species ()=default
	Destroy the object.
Operators
Species &	operator= (const Species &other)
	Copy operator.
bool	operator== (const Species &other) const
	Equality operator.
bool	operator!= (const Species &other) const
	Inequality operator.
Input and Output
void	read (Reader &input)
	Read an object from a Reader.
std::string	write ()
	Write the object to a string.
Getters and Setters
int	nr () const
	Returns the species number, in order from 1 to the number of species.
void	setNr (const int nr)
	Sets the species number.
bool	sflag () const
	Returns the simulation flag: true = simulated, false = unsimulated species.
void	setSflag (const bool sflag)
	Sets the simulation flag: true = simulated, false = unsimulated species.
bool	ntflag () const
	Returns the non-trace contaminant flag: true = non-trace, false = trace species.
void	setNtflag (const bool ntflag)
	Sets the non-trace contaminant flag: true = non-trace, false = trace species.
double	molwt () const
	Returns the molar mass [kg/kmol] for gas contaminants.
bool	setMolwt (const double molwt)
	Sets the molar mass [kg/kmol] for gas contaminants.
bool	setMolwt (const std::string &molwt)
	Sets the molar mass [kg/kmol] for gas contaminants.
double	mdiam () const
	Returns the mean diameter [m] for particle contaminants.
bool	setMdiam (const double mdiam)
	Sets the mean diameter [m] for particle contaminants.
bool	setMdiam (const std::string &mdiam)
	Sets the mean diameter [m] for particle contaminants.
double	edens () const
	Returns the effective density [kg/m^3] for particle contaminants.
bool	setEdens (const double edens)
	Sets the effective density [kg/m^3] for particle contaminants.
bool	setEdens (const std::string &edens)
	Sets the effective density [kg/m^3] for particle contaminants.
double	decay () const
	Returns the contaminant decay constant [1/s].
bool	setDecay (const double decay)
	Sets the contaminant decay constant [1/s].
bool	setDecay (const std::string &decay)
	Sets the contaminant decay constant [1/s].
double	Dm () const
	Returns the contaminant molecular diffusion coefficient [m^2/s].
bool	setDm (const double Dm)
	Sets the contaminant molecular diffusion coefficient [m^2/s].
bool	setDm (const std::string &Dm)
	Sets the contaminant molecular diffusion coefficient [m^2/s].
double	ccdef () const
	Returns the default contaminant concentration [kg/kg air].
bool	setCcdef (const double ccdef)
	Sets the default contaminant concentration [kg/kg air].
bool	setCcdef (const std::string &ccdef)
	Sets the default contaminant concentration [kg/kg air].
double	Cp () const
	Returns the contaminant specific heat at constant pressure [J/kgK].
bool	setCp (const double Cp)
	Sets the contaminant specific heat at constant pressure [J/kgK].
bool	setCp (const std::string &Cp)
	Sets the contaminant specific heat at constant pressure [J/kgK].
int	ucc () const
	Returns the concentration display units.
void	setUcc (const int ucc)
	Sets the concentration display units.
int	umd () const
	Returns the mean diameter display units.
void	setUmd (const int umd)
	Sets the mean diameter display units.
int	ued () const
	Returns the effective density display units.
void	setUed (const int ued)
	Sets the effective density display units.
int	udm () const
	Returns the diffusion coefficient display units.
void	setUdm (const int udm)
	Sets the diffusion coefficient display units.
int	ucp () const
	Returns the specific heat display units.
void	setUcp (const int ucp)
	Sets the specific heat display units.
std::string	name () const
	Returns the species name.
void	setName (const std::string &name)
	Sets the species name.
std::string	desc () const
	Returns the species description.
void	setDesc (const std::string &desc)
	Sets the species description.

Detailed Description

The Species object contains descriptive information about contaminants in a CONTAM model.

Constructor & Destructor Documentation

Species() [1/6]

openstudio::contam::Species::Species

(

)

Create a new object with default values.

Species() [2/6]

openstudio::contam::Species::Species	(	std::string	molwt,
		std::string	Dm,
		std::string	ccdef,
		std::string	Cp,
		std::string	name,
		std::string	desc )

Create a new gaseous species object.

Species() [3/6]

openstudio::contam::Species::Species	(	double	molwt,
		double	Dm,
		double	ccdef,
		double	Cp,
		std::string	name,
		std::string	desc )

Create a new gaseous species object.

Species() [4/6]

openstudio::contam::Species::Species	(	int	nr,
		int	sflag,
		int	ntflag,
		std::string	molwt,
		std::string	mdiam,
		std::string	edens,
		std::string	decay,
		std::string	Dm,
		std::string	ccdef,
		std::string	Cp,
		int	uc,
		int	umd,
		int	ued,
		int	udm,
		int	ucp,
		std::string	name,
		std::string	desc )

Create a new object.

Species() [5/6]

openstudio::contam::Species::Species	(	int	nr,
		int	sflag,
		int	ntflag,
		double	molwt,
		double	mdiam,
		double	edens,
		double	decay,
		double	Dm,
		double	ccdef,
		double	Cp,
		int	ucc,
		int	umd,
		int	ued,
		int	udm,
		int	ucp,
		std::string	name,
		std::string	desc )

Create a new object.

Species() [6/6]

openstudio::contam::Species::Species

(

const Species &

other

)

Create a new object from another object.

~Species()

openstudio::contam::Species::~Species ( )

default

Destroy the object.

Member Function Documentation

ccdef()

double openstudio::contam::Species::ccdef

(

)

const

Returns the default contaminant concentration [kg/kg air].

Cp()

double openstudio::contam::Species::Cp

(

)

const

Returns the contaminant specific heat at constant pressure [J/kgK].

This is not used by CONTAM.

decay()

double openstudio::contam::Species::decay

(

)

const

Returns the contaminant decay constant [1/s].

desc()

std::string openstudio::contam::Species::desc

(

)

const

Returns the species description.

Dm()

double openstudio::contam::Species::Dm

(

)

const

Returns the contaminant molecular diffusion coefficient [m^2/s].

edens()

double openstudio::contam::Species::edens

(

)

const

Returns the effective density [kg/m^3] for particle contaminants.

mdiam()

double openstudio::contam::Species::mdiam

(

)

const

Returns the mean diameter [m] for particle contaminants.

molwt()

double openstudio::contam::Species::molwt

(

)

const

Returns the molar mass [kg/kmol] for gas contaminants.

name()

std::string openstudio::contam::Species::name

(

)

const

Returns the species name.

nr()

int openstudio::contam::Species::nr

(

)

const

Returns the species number, in order from 1 to the number of species.

ntflag()

bool openstudio::contam::Species::ntflag

(

)

const

Returns the non-trace contaminant flag: true = non-trace, false = trace species.

operator!=()

bool openstudio::contam::Species::operator!=

(

const Species &

other

)

const

Inequality operator.

operator=()

Species & openstudio::contam::Species::operator=

(

const Species &

other

)

Copy operator.

operator==()

bool openstudio::contam::Species::operator==

(

const Species &

other

)

const

Equality operator.

read()

void openstudio::contam::Species::read

(

Reader &

input

)

Read an object from a Reader.

setCcdef() [1/2]

bool openstudio::contam::Species::setCcdef

(

const double

ccdef

)

Sets the default contaminant concentration [kg/kg air].

setCcdef() [2/2]

bool openstudio::contam::Species::setCcdef

(

const std::string &

ccdef

)

Sets the default contaminant concentration [kg/kg air].

setCp() [1/2]

bool openstudio::contam::Species::setCp

(

const double

Cp

)

Sets the contaminant specific heat at constant pressure [J/kgK].

This is not used by CONTAM.

setCp() [2/2]

bool openstudio::contam::Species::setCp

(

const std::string &

Cp

)

Sets the contaminant specific heat at constant pressure [J/kgK].

This is not used by CONTAM.

setDecay() [1/2]

bool openstudio::contam::Species::setDecay

(

const double

decay

)

Sets the contaminant decay constant [1/s].

setDecay() [2/2]

bool openstudio::contam::Species::setDecay

(

const std::string &

decay

)

Sets the contaminant decay constant [1/s].

setDesc()

void openstudio::contam::Species::setDesc

(

const std::string &

desc

)

Sets the species description.

setDm() [1/2]

bool openstudio::contam::Species::setDm

(

const double

Dm

)

Sets the contaminant molecular diffusion coefficient [m^2/s].

setDm() [2/2]

bool openstudio::contam::Species::setDm

(

const std::string &

Dm

)

Sets the contaminant molecular diffusion coefficient [m^2/s].

setEdens() [1/2]

bool openstudio::contam::Species::setEdens

(

const double

edens

)

Sets the effective density [kg/m^3] for particle contaminants.

setEdens() [2/2]

bool openstudio::contam::Species::setEdens

(

const std::string &

edens

)

Sets the effective density [kg/m^3] for particle contaminants.

setMdiam() [1/2]

bool openstudio::contam::Species::setMdiam

(

const double

mdiam

)

Sets the mean diameter [m] for particle contaminants.

setMdiam() [2/2]

bool openstudio::contam::Species::setMdiam

(

const std::string &

mdiam

)

Sets the mean diameter [m] for particle contaminants.

setMolwt() [1/2]

bool openstudio::contam::Species::setMolwt

(

const double

molwt

)

Sets the molar mass [kg/kmol] for gas contaminants.

setMolwt() [2/2]

bool openstudio::contam::Species::setMolwt

(

const std::string &

molwt

)

Sets the molar mass [kg/kmol] for gas contaminants.

setName()

void openstudio::contam::Species::setName

(

const std::string &

name

)

Sets the species name.

setNr()

void openstudio::contam::Species::setNr

(

const int

nr

)

Sets the species number.

This should only be done with care.

setNtflag()

void openstudio::contam::Species::setNtflag

(

const bool

ntflag

)

Sets the non-trace contaminant flag: true = non-trace, false = trace species.

setSflag()

void openstudio::contam::Species::setSflag

(

const bool

sflag

)

Sets the simulation flag: true = simulated, false = unsimulated species.

setUcc()

void openstudio::contam::Species::setUcc

(

const int

ucc

)

Sets the concentration display units.

setUcp()

void openstudio::contam::Species::setUcp

(

const int

ucp

)

Sets the specific heat display units.

setUdm()

void openstudio::contam::Species::setUdm

(

const int

udm

)

Sets the diffusion coefficient display units.

setUed()

void openstudio::contam::Species::setUed

(

const int

ued

)

Sets the effective density display units.

setUmd()

void openstudio::contam::Species::setUmd

(

const int

umd

)

Sets the mean diameter display units.

sflag()

bool openstudio::contam::Species::sflag

(

)

const

Returns the simulation flag: true = simulated, false = unsimulated species.

ucc()

int openstudio::contam::Species::ucc

(

)

const

Returns the concentration display units.

ucp()

int openstudio::contam::Species::ucp

(

)

const

Returns the specific heat display units.

udm()

int openstudio::contam::Species::udm

(

)

const

Returns the diffusion coefficient display units.

ued()

int openstudio::contam::Species::ued

(

)

const

Returns the effective density display units.

umd()

int openstudio::contam::Species::umd

(

)

const

Returns the mean diameter display units.

write()

std::string openstudio::contam::Species::write

(

)

Write the object to a string.