#include <PrjObjects.hpp>
Public Member Functions | |
Constructors and Destructors | |
Zone () | |
Create a new object with default values. More... | |
Zone (unsigned flags, std::string Vol, std::string T0, std::string name) | |
Create a new object. More... | |
Zone (unsigned flags, double Vol, double T0, std::string name) | |
Create a new object. More... | |
Zone (int nr, unsigned int flags, int ps, int pc, int pk, int pl, std::string relHt, std::string Vol, std::string T0, std::string P0, std::string name, int color, int u_Ht, int u_V, int u_T, int u_P, int cdaxis, int cfd, std::string cfdname, std::string X1, std::string Y1, std::string H1, std::string X2, std::string Y2, std::string H2, std::string celldx, std::string axialD, int u_aD, int u_L) | |
Create a new object. More... | |
Zone (int nr, unsigned int flags, int ps, int pc, int pk, int pl, double relHt, double Vol, double T0, double P0, std::string name, int color, int u_Ht, int u_V, int u_T, int u_P, int cdaxis, int cfd, std::string cfdname, double X1, double Y1, double H1, double X2, double Y2, double H2, double celldx, double axialD, int u_aD, int u_L) | |
Create a new object. More... | |
Zone (const Zone &other) | |
Create a new object from another object. More... | |
~Zone () | |
Destroy the object. More... | |
Operators | |
Zone & | operator= (const Zone &other) |
Copy operator. More... | |
bool | operator== (const Zone &other) const |
Equality operator. More... | |
bool | operator!= (const Zone &other) const |
Inequality operator. More... | |
Input and Output | |
void | read (Reader &input) |
Read an object from a Reader. More... | |
std::string | write () |
Write the object to a string. More... | |
Getters and Setters | |
int | nr () const |
Returns the zone number, in order from 1 to the number of zones. More... | |
void | setNr (const int nr) |
Sets the zone number. More... | |
unsigned int | flags () const |
Returns the zones flags. More... | |
void | setFlags (const unsigned int flags) |
Set the zones flags. More... | |
int | ps () const |
Returns the week schedule index. More... | |
void | setPs (const int ps) |
Sets the week schedule index. More... | |
int | pc () const |
Returns the control node index. More... | |
void | setPc (const int pc) |
Sets the control node index. More... | |
int | pk () const |
Returns the kinetic reaction index. More... | |
void | setPk (const int pk) |
Sets the kinetic reaction index. More... | |
int | pl () const |
Returns the building level index. More... | |
void | setPl (const int pl) |
Sets the building level index. More... | |
double | relHt () const |
Returns the zone height [m]. More... | |
bool | setRelHt (const double relHt) |
Sets the zone height [m]. More... | |
bool | setRelHt (const std::string &relHt) |
Sets the zone height [m]. More... | |
double | Vol () const |
Returns the zone volume [m^3]. More... | |
bool | setVol (const double Vol) |
Sets the zone volume [m^3]. More... | |
bool | setVol (const std::string &Vol) |
Sets the zone volume [m^3]. More... | |
double | T0 () const |
Returns the initial zone temperature [K]. More... | |
bool | setT0 (const double T0) |
Sets the initial zone temperature [K]. More... | |
bool | setT0 (const std::string &T0) |
Sets the initial zone temperature [K]. More... | |
double | P0 () const |
Returns the initial zone pressure [Pa]. More... | |
bool | setP0 (const double P0) |
Sets the initial zone pressure [Pa]. More... | |
bool | setP0 (const std::string &P0) |
Sets the initial zone pressure [Pa]. More... | |
std::string | name () const |
Returns the zone name. More... | |
void | setName (const std::string &name) |
Sets the zone name. More... | |
int | color () const |
Returns the zone fill color. More... | |
void | setColor (const int color) |
Sets the zone fill color. More... | |
int | u_Ht () const |
Returns the units of height. More... | |
void | setU_Ht (const int u_Ht) |
Sets the units of height. More... | |
int | u_V () const |
Returns the units of volume. More... | |
void | setU_V (const int u_V) |
Sets the units of volume. More... | |
int | u_T () const |
Returns the units of temperature. More... | |
void | setU_T (const int u_T) |
Sets the units of temperature. More... | |
int | u_P () const |
Returns the units of pressure. More... | |
void | setU_P (const int u_P) |
sets the units of pressure. More... | |
int | cdaxis () const |
Returns the convection/diffusion axis flag (0=no cd, 1-4 => cd axis direction). More... | |
void | setCdaxis (const int cdaxis) |
Sets the convection/diffusion axis flag (0=no cd, 1-4 => cd axis direction). More... | |
int | cfd () const |
Returns the CFD zone flag (0=no, 1=yes). More... | |
void | setCfd (const int cfd) |
Sets the cfd zone flag (0=no, 1=yes). More... | |
std::string | cfdname () const |
Returns the CFD zone name. More... | |
void | setCfdname (const std::string &cfdname) |
Sets the CFD zone name. More... | |
double | X1 () const |
Returns the X coordinate of one end of the cdaxis. More... | |
bool | setX1 (const double X1) |
Sets the X coordinate of one end of the cdaxis. More... | |
bool | setX1 (const std::string &X1) |
Sets the X coordinate of one end of the cdaxis. More... | |
double | Y1 () const |
Returns the Y coordinate of one end of the cdaxis. More... | |
bool | setY1 (const double Y1) |
Sets the Y coordinate of one end of the cdaxis. More... | |
bool | setY1 (const std::string &Y1) |
Sets the Y coordinate of one end of the cdaxis. More... | |
double | H1 () const |
Returns the relative height of one end of the cdaxis. More... | |
bool | setH1 (const double H1) |
Sets the relative height of one end of the cdaxis. More... | |
bool | setH1 (const std::string &H1) |
Sets the relative height of one end of the cdaxis. More... | |
double | X2 () const |
Returns the X coordinate of the other end of the cdaxis. More... | |
bool | setX2 (const double X2) |
Sets the X coordinate of the other end of the cdaxis. More... | |
bool | setX2 (const std::string &X2) |
Sets the X coordinate of the other end of the cdaxis. More... | |
double | Y2 () const |
Returns the Y coordinate of the other end of the cdaxis. More... | |
bool | setY2 (const double Y2) |
Sets the Y coordinate of the other end of the cdaxis. More... | |
bool | setY2 (const std::string &Y2) |
Sets the Y coordinate of the other end of the cdaxis. More... | |
double | H2 () const |
Returns the relative height of the other end of the cdaxis. More... | |
bool | setH2 (const double H2) |
Sets the relative height of the other end of the cdaxis. More... | |
bool | setH2 (const std::string &H2) |
Sets the relative height of the other end of the cdaxis. More... | |
double | celldx () const |
Returns the convection/diffusion cell length [m]. More... | |
bool | setCelldx (const double celldx) |
Returns the convection/diffusion cell length [m]. More... | |
bool | setCelldx (const std::string &celldx) |
Returns the convection/diffusion cell length [m]. More... | |
double | axialD () const |
Returns the axial diffusion coeff [m^2/s]. More... | |
bool | setAxialD (const double axialD) |
Sets the axial diffusion coeff [m^2/s]. More... | |
bool | setAxialD (const std::string &axialD) |
Sets the axial diffusion coeff [m^2/s]. More... | |
int | u_aD () const |
Returns the display units of axial diffusion. More... | |
void | setU_aD (const int u_aD) |
Sets the display units of axial diffusion. More... | |
int | u_L () const |
Returns the c/d axis limit display units. More... | |
void | setU_L (const int u_L) |
Sets the c/d axis limit display units. More... | |
bool | variablePressure () const |
Returns true if the zone is a variable pressure zone. More... | |
void | setVariablePressure (bool b) |
Set the zone pressure behavior. More... | |
bool | variableContaminants () const |
Returns true if the zone is a variable contaminant zone. More... | |
void | setVariableContaminants (bool b) |
Set the zone contaminant behavior. More... | |
bool | system () const |
Returns true if the zone is a system zone. More... | |
void | setSystem (bool b) |
Set the zone system flag. More... | |
double | ic (const int i) const |
Returns the initial condition of contaminant i. More... | |
std::vector< double > | ic () const |
Returns the contaminant initial conditions as a vector. More... | |
bool | setIc (const int i, const double value) |
Sets the initial condition of contaminant i. More... | |
bool | setIc (const int i, const std::string &value) |
Sets the initial condition of contaminant i. More... | |
bool | setIc (std::vector< double > &ic) |
Sets the contaminant initial condition vector. More... | |
bool | setIc (std::vector< std::string > &ic) |
Sets the contaminant initial condition vector. More... | |
The Zone object stores the data that describes an airflow zone.
openstudio::contam::Zone::Zone | ( | ) |
Create a new object with default values.
openstudio::contam::Zone::Zone | ( | unsigned | flags, |
std::string | Vol, | ||
std::string | T0, | ||
std::string | name | ||
) |
Create a new object.
openstudio::contam::Zone::Zone | ( | unsigned | flags, |
double | Vol, | ||
double | T0, | ||
std::string | name | ||
) |
Create a new object.
openstudio::contam::Zone::Zone | ( | int | nr, |
unsigned int | flags, | ||
int | ps, | ||
int | pc, | ||
int | pk, | ||
int | pl, | ||
std::string | relHt, | ||
std::string | Vol, | ||
std::string | T0, | ||
std::string | P0, | ||
std::string | name, | ||
int | color, | ||
int | u_Ht, | ||
int | u_V, | ||
int | u_T, | ||
int | u_P, | ||
int | cdaxis, | ||
int | cfd, | ||
std::string | cfdname, | ||
std::string | X1, | ||
std::string | Y1, | ||
std::string | H1, | ||
std::string | X2, | ||
std::string | Y2, | ||
std::string | H2, | ||
std::string | celldx, | ||
std::string | axialD, | ||
int | u_aD, | ||
int | u_L | ||
) |
Create a new object.
openstudio::contam::Zone::Zone | ( | int | nr, |
unsigned int | flags, | ||
int | ps, | ||
int | pc, | ||
int | pk, | ||
int | pl, | ||
double | relHt, | ||
double | Vol, | ||
double | T0, | ||
double | P0, | ||
std::string | name, | ||
int | color, | ||
int | u_Ht, | ||
int | u_V, | ||
int | u_T, | ||
int | u_P, | ||
int | cdaxis, | ||
int | cfd, | ||
std::string | cfdname, | ||
double | X1, | ||
double | Y1, | ||
double | H1, | ||
double | X2, | ||
double | Y2, | ||
double | H2, | ||
double | celldx, | ||
double | axialD, | ||
int | u_aD, | ||
int | u_L | ||
) |
Create a new object.
openstudio::contam::Zone::Zone | ( | const Zone & | other | ) |
Create a new object from another object.
openstudio::contam::Zone::~Zone | ( | ) |
Destroy the object.
double openstudio::contam::Zone::axialD | ( | ) | const |
Returns the axial diffusion coeff [m^2/s].
int openstudio::contam::Zone::cdaxis | ( | ) | const |
Returns the convection/diffusion axis flag (0=no cd, 1-4 => cd axis direction).
double openstudio::contam::Zone::celldx | ( | ) | const |
Returns the convection/diffusion cell length [m].
int openstudio::contam::Zone::cfd | ( | ) | const |
Returns the CFD zone flag (0=no, 1=yes).
std::string openstudio::contam::Zone::cfdname | ( | ) | const |
Returns the CFD zone name.
int openstudio::contam::Zone::color | ( | ) | const |
Returns the zone fill color.
unsigned int openstudio::contam::Zone::flags | ( | ) | const |
Returns the zones flags.
See the ZoneFlags enum for more information.
double openstudio::contam::Zone::H1 | ( | ) | const |
Returns the relative height of one end of the cdaxis.
double openstudio::contam::Zone::H2 | ( | ) | const |
Returns the relative height of the other end of the cdaxis.
double openstudio::contam::Zone::ic | ( | const int | i | ) | const |
Returns the initial condition of contaminant i.
std::vector<double> openstudio::contam::Zone::ic | ( | ) | const |
Returns the contaminant initial conditions as a vector.
std::string openstudio::contam::Zone::name | ( | ) | const |
Returns the zone name.
int openstudio::contam::Zone::nr | ( | ) | const |
Returns the zone number, in order from 1 to the number of zones.
bool openstudio::contam::Zone::operator!= | ( | const Zone & | other | ) | const |
Inequality operator.
bool openstudio::contam::Zone::operator== | ( | const Zone & | other | ) | const |
Equality operator.
double openstudio::contam::Zone::P0 | ( | ) | const |
Returns the initial zone pressure [Pa].
int openstudio::contam::Zone::pc | ( | ) | const |
Returns the control node index.
It is converted to pointer by CONTAM.
int openstudio::contam::Zone::pk | ( | ) | const |
Returns the kinetic reaction index.
It is converted to pointer by CONTAM.
int openstudio::contam::Zone::pl | ( | ) | const |
Returns the building level index.
It is converted to pointer by CONTAM.
int openstudio::contam::Zone::ps | ( | ) | const |
Returns the week schedule index.
It is converted to pointer by CONTAM.
double openstudio::contam::Zone::relHt | ( | ) | const |
Returns the zone height [m].
bool openstudio::contam::Zone::setAxialD | ( | const double | axialD | ) |
Sets the axial diffusion coeff [m^2/s].
bool openstudio::contam::Zone::setAxialD | ( | const std::string & | axialD | ) |
Sets the axial diffusion coeff [m^2/s].
void openstudio::contam::Zone::setCdaxis | ( | const int | cdaxis | ) |
Sets the convection/diffusion axis flag (0=no cd, 1-4 => cd axis direction).
bool openstudio::contam::Zone::setCelldx | ( | const double | celldx | ) |
Returns the convection/diffusion cell length [m].
bool openstudio::contam::Zone::setCelldx | ( | const std::string & | celldx | ) |
Returns the convection/diffusion cell length [m].
void openstudio::contam::Zone::setCfd | ( | const int | cfd | ) |
Sets the cfd zone flag (0=no, 1=yes).
void openstudio::contam::Zone::setCfdname | ( | const std::string & | cfdname | ) |
Sets the CFD zone name.
void openstudio::contam::Zone::setColor | ( | const int | color | ) |
Sets the zone fill color.
void openstudio::contam::Zone::setFlags | ( | const unsigned int | flags | ) |
Set the zones flags.
See the ZoneFlags enum for more information.
bool openstudio::contam::Zone::setH1 | ( | const double | H1 | ) |
Sets the relative height of one end of the cdaxis.
bool openstudio::contam::Zone::setH1 | ( | const std::string & | H1 | ) |
Sets the relative height of one end of the cdaxis.
bool openstudio::contam::Zone::setH2 | ( | const double | H2 | ) |
Sets the relative height of the other end of the cdaxis.
bool openstudio::contam::Zone::setH2 | ( | const std::string & | H2 | ) |
Sets the relative height of the other end of the cdaxis.
bool openstudio::contam::Zone::setIc | ( | const int | i, |
const double | value | ||
) |
Sets the initial condition of contaminant i.
bool openstudio::contam::Zone::setIc | ( | const int | i, |
const std::string & | value | ||
) |
Sets the initial condition of contaminant i.
bool openstudio::contam::Zone::setIc | ( | std::vector< double > & | ic | ) |
Sets the contaminant initial condition vector.
bool openstudio::contam::Zone::setIc | ( | std::vector< std::string > & | ic | ) |
Sets the contaminant initial condition vector.
void openstudio::contam::Zone::setName | ( | const std::string & | name | ) |
Sets the zone name.
void openstudio::contam::Zone::setNr | ( | const int | nr | ) |
Sets the zone number.
This should only be done with care.
bool openstudio::contam::Zone::setP0 | ( | const double | P0 | ) |
Sets the initial zone pressure [Pa].
bool openstudio::contam::Zone::setP0 | ( | const std::string & | P0 | ) |
Sets the initial zone pressure [Pa].
void openstudio::contam::Zone::setPc | ( | const int | pc | ) |
Sets the control node index.
It is converted to pointer by CONTAM.
void openstudio::contam::Zone::setPk | ( | const int | pk | ) |
Sets the kinetic reaction index.
It is converted to pointer by CONTAM.
void openstudio::contam::Zone::setPl | ( | const int | pl | ) |
Sets the building level index.
It is converted to pointer by CONTAM.
void openstudio::contam::Zone::setPs | ( | const int | ps | ) |
Sets the week schedule index.
It is converted to pointer by CONTAM.
bool openstudio::contam::Zone::setRelHt | ( | const double | relHt | ) |
Sets the zone height [m].
bool openstudio::contam::Zone::setRelHt | ( | const std::string & | relHt | ) |
Sets the zone height [m].
void openstudio::contam::Zone::setSystem | ( | bool | b | ) |
Set the zone system flag.
bool openstudio::contam::Zone::setT0 | ( | const double | T0 | ) |
Sets the initial zone temperature [K].
bool openstudio::contam::Zone::setT0 | ( | const std::string & | T0 | ) |
Sets the initial zone temperature [K].
void openstudio::contam::Zone::setU_aD | ( | const int | u_aD | ) |
Sets the display units of axial diffusion.
void openstudio::contam::Zone::setU_Ht | ( | const int | u_Ht | ) |
Sets the units of height.
void openstudio::contam::Zone::setU_L | ( | const int | u_L | ) |
Sets the c/d axis limit display units.
void openstudio::contam::Zone::setU_P | ( | const int | u_P | ) |
sets the units of pressure.
void openstudio::contam::Zone::setU_T | ( | const int | u_T | ) |
Sets the units of temperature.
void openstudio::contam::Zone::setU_V | ( | const int | u_V | ) |
Sets the units of volume.
void openstudio::contam::Zone::setVariableContaminants | ( | bool | b | ) |
Set the zone contaminant behavior.
void openstudio::contam::Zone::setVariablePressure | ( | bool | b | ) |
Set the zone pressure behavior.
bool openstudio::contam::Zone::setVol | ( | const double | Vol | ) |
Sets the zone volume [m^3].
bool openstudio::contam::Zone::setVol | ( | const std::string & | Vol | ) |
Sets the zone volume [m^3].
bool openstudio::contam::Zone::setX1 | ( | const double | X1 | ) |
Sets the X coordinate of one end of the cdaxis.
bool openstudio::contam::Zone::setX1 | ( | const std::string & | X1 | ) |
Sets the X coordinate of one end of the cdaxis.
bool openstudio::contam::Zone::setX2 | ( | const double | X2 | ) |
Sets the X coordinate of the other end of the cdaxis.
bool openstudio::contam::Zone::setX2 | ( | const std::string & | X2 | ) |
Sets the X coordinate of the other end of the cdaxis.
bool openstudio::contam::Zone::setY1 | ( | const double | Y1 | ) |
Sets the Y coordinate of one end of the cdaxis.
bool openstudio::contam::Zone::setY1 | ( | const std::string & | Y1 | ) |
Sets the Y coordinate of one end of the cdaxis.
bool openstudio::contam::Zone::setY2 | ( | const double | Y2 | ) |
Sets the Y coordinate of the other end of the cdaxis.
bool openstudio::contam::Zone::setY2 | ( | const std::string & | Y2 | ) |
Sets the Y coordinate of the other end of the cdaxis.
bool openstudio::contam::Zone::system | ( | ) | const |
Returns true if the zone is a system zone.
double openstudio::contam::Zone::T0 | ( | ) | const |
Returns the initial zone temperature [K].
int openstudio::contam::Zone::u_aD | ( | ) | const |
Returns the display units of axial diffusion.
int openstudio::contam::Zone::u_Ht | ( | ) | const |
Returns the units of height.
int openstudio::contam::Zone::u_L | ( | ) | const |
Returns the c/d axis limit display units.
int openstudio::contam::Zone::u_P | ( | ) | const |
Returns the units of pressure.
int openstudio::contam::Zone::u_T | ( | ) | const |
Returns the units of temperature.
int openstudio::contam::Zone::u_V | ( | ) | const |
Returns the units of volume.
bool openstudio::contam::Zone::variableContaminants | ( | ) | const |
Returns true if the zone is a variable contaminant zone.
bool openstudio::contam::Zone::variablePressure | ( | ) | const |
Returns true if the zone is a variable pressure zone.
double openstudio::contam::Zone::Vol | ( | ) | const |
Returns the zone volume [m^3].
std::string openstudio::contam::Zone::write | ( | ) |
Write the object to a string.
double openstudio::contam::Zone::X1 | ( | ) | const |
Returns the X coordinate of one end of the cdaxis.
double openstudio::contam::Zone::X2 | ( | ) | const |
Returns the X coordinate of the other end of the cdaxis.
double openstudio::contam::Zone::Y1 | ( | ) | const |
Returns the Y coordinate of one end of the cdaxis.
double openstudio::contam::Zone::Y2 | ( | ) | const |
Returns the Y coordinate of the other end of the cdaxis.