OpenStudio:airflow
 All Classes Namespaces Functions Typedefs Enumerations Enumerator
List of all members
openstudio::contam::PlrGeneral Class Referenceabstract

#include <PrjAirflowElements.hpp>

+ Inheritance diagram for openstudio::contam::PlrGeneral:

Public Member Functions

Constructors and Destructors
 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...
 
 ~PlrGeneral ()=default
 Destroy the object. More...
 
Operators
PlrGeneraloperator= (const PlrGeneral &other)
 Copy operator. More...
 
bool operator== (const PlrGeneral &other) const
 Equality operator. More...
 
bool operator!= (const PlrGeneral &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...
 
virtual std::string dataType () const override=0
 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...
 
- 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 AirflowElementreadElement (Reader &input)
 Read an airflow element from a Reader object. More...
 

Detailed Description

The PlrGeneral object is the base class for general power law elements.

Constructor & Destructor Documentation

openstudio::contam::PlrGeneral::PlrGeneral ( )

Create a new object with default values.

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

Create a new object.

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

Create a new object.

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

Create a new object.

openstudio::contam::PlrGeneral::PlrGeneral ( const PlrGeneral other)

Create a new object from another object.

openstudio::contam::PlrGeneral::~PlrGeneral ( )
default

Destroy the object.

Member Function Documentation

virtual std::string openstudio::contam::PlrGeneral::dataType ( ) const
overridepure virtual

Returns the element data type.

Implements openstudio::contam::AirflowElement.

Implemented in openstudio::contam::PlrFcn, and openstudio::contam::PlrQcn.

std::string openstudio::contam::PlrGeneral::desc ( ) const
overridevirtual

Returns the element description.

Implements openstudio::contam::AirflowElement.

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

Returns the pressure exponent.

int openstudio::contam::PlrGeneral::icon ( ) const
overridevirtual

Returns the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Returns the laminar flow coefficient.

std::string openstudio::contam::PlrGeneral::name ( ) const
overridevirtual

Returns the element name.

Implements openstudio::contam::AirflowElement.

int openstudio::contam::PlrGeneral::nr ( ) const
overridevirtual

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

Implements openstudio::contam::AirflowElement.

bool openstudio::contam::PlrGeneral::operator!= ( const PlrGeneral other) const

Inequality operator.

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

Copy operator.

bool openstudio::contam::PlrGeneral::operator== ( const PlrGeneral other) const

Equality operator.

void openstudio::contam::PlrGeneral::read ( Reader input)

Read an object from a Reader.

void openstudio::contam::PlrGeneral::readDetails ( Reader input)

Read object details from a Reader.

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

Sets the element description.

Implements openstudio::contam::AirflowElement.

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

Sets the pressure exponent.

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

Sets the pressure exponent.

void openstudio::contam::PlrGeneral::setIcon ( const int  icon)
overridevirtual

Sets the icon used to represent flow path.

Implements openstudio::contam::AirflowElement.

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

Sets the laminar flow coefficient.

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

Sets the laminar flow coefficient.

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

Sets the element name.

Implements openstudio::contam::AirflowElement.

void openstudio::contam::PlrGeneral::setNr ( const int  nr)
overridevirtual

Sets the element number.

This should only be done with care.

Implements openstudio::contam::AirflowElement.

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

Sets the turbulent flow coefficient.

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

Sets the turbulent flow coefficient.

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

Returns the turbulent flow coefficient.

std::string openstudio::contam::PlrGeneral::write ( )
overridevirtual

Write the object to a string.

Implements openstudio::contam::AirflowElement.