NANDRAD Data Model Library  Version 2.0
NANDRAD
NANDRAD::Zone Class Reference

Detailed Description

A zone defines a thermal zone/room with a single air temperature.

The class Zone stores all properties needed to compute zone temperature from energy density (the conserved quantity).

Zones can be either Constant or Active. For constant zones, the temperature is assumed to be fixed/predefined (given via parameter P_Temperature) whereas in Active zones the temperature is computed (i.e. included in the model's unknowns).

Definition at line 44 of file NANDRAD_Zone.h.

#include <NANDRAD_Zone.h>

Public Types

enum  type_t {
  ZT_Constant, ZT_Scheduled, ZT_Active, ZT_Ground,
  NUM_ZT
}
 Type of zone. More...
 
enum  para_t {
  P_Temperature, P_RelativeHumidity, P_CO2Concentration, P_Area,
  P_Volume, P_HeatCapacity, NUM_P
}
 Parameters of a zone. More...
 
typedef std::pair< unsigned int, unsigned int > viewFactorPair
 Data type used in view factor definition. More...
 

Public Member Functions

NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID void checkParameters () const
 Checks for valid and required parameters (value ranges). More...
 

Public Attributes

unsigned int m_id = INVALID_ID
 Unique ID of the zone. More...
 
std::string m_displayName
 Descriptive name of zone. More...
 
type_t m_type = NUM_ZT
 Zone type (Constant, Active). More...
 
IBK::Parameter m_para [NUM_P]
 Physical parameters describing the zone. More...
 
std::vector< std::pair< viewFactorPair, double > > m_viewFactors
 Optional: view factors for all inside interfaces of the current zone. More...
 

Member Typedef Documentation

◆ viewFactorPair

typedef std::pair<unsigned int, unsigned int> NANDRAD::Zone::viewFactorPair

Data type used in view factor definition.

Definition at line 95 of file NANDRAD_Zone.h.

Member Enumeration Documentation

◆ type_t

Type of zone.

Defines whether zone is balanced and included in equation system.

Enumerator
ZT_Constant 

Constant model requires P_Temperature parameter.

Optionally, a schedule with name 'TemperatureSchedule' can be used to identify temperature of the zone (or soil, if this is a ground zone).

Definition at line 48 of file NANDRAD_Zone.h.

◆ para_t

Parameters of a zone.

Definition at line 60 of file NANDRAD_Zone.h.

Member Function Documentation

◆ checkParameters()

NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID void NANDRAD::Zone::checkParameters ( ) const

Checks for valid and required parameters (value ranges).

Member Data Documentation

◆ m_id

unsigned int NANDRAD::Zone::m_id = INVALID_ID

Unique ID of the zone.

Definition at line 81 of file NANDRAD_Zone.h.

◆ m_displayName

std::string NANDRAD::Zone::m_displayName

Descriptive name of zone.

Definition at line 84 of file NANDRAD_Zone.h.

◆ m_type

type_t NANDRAD::Zone::m_type = NUM_ZT

Zone type (Constant, Active).

See also
type_t

Definition at line 89 of file NANDRAD_Zone.h.

◆ m_para

IBK::Parameter NANDRAD::Zone::m_para[NUM_P]

Physical parameters describing the zone.

Definition at line 92 of file NANDRAD_Zone.h.

◆ m_viewFactors

std::vector<std::pair<viewFactorPair, double> > NANDRAD::Zone::m_viewFactors

Optional: view factors for all inside interfaces of the current zone.

Definition at line 97 of file NANDRAD_Zone.h.


The documentation for this class was generated from the following file: