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

Detailed Description

An Interface identifies a surface of a wall and stores all data that are needed for boundary condition calculation.

Each ConstructionInstance contains two member variables of type Interface, which uniquely define the boundary condition parameters at side A or B of the construction (A - layer index 0, B - other side).

The zone at the other side of the wall surface is identified by its zone ID. The zone ID = 0 indicates ambient climate. If the construction is adiabatic, there must not be an interface defined for this side.

Definition at line 49 of file NANDRAD_Interface.h.

#include <NANDRAD_Interface.h>

Collaboration diagram for NANDRAD::Interface:

Public Member Functions

void readXML (const TiXmlElement *element)
 
TiXmlElement * writeXML (TiXmlElement *parent) const
 
NANDRAD_COMPARE_WITH_ID void checkParameters () const
 Checks for valid parameters. More...
 
bool behavesLike (const Interface &other) const
 Special form of comparison operator, tests if parameters that have an impact on result calculation are the same (zone, location, physical parameters).
 
void updateComment (const std::vector< Zone > &zones)
 Updates the comment regarding the zone this interface is connected to. More...
 
bool haveBCParameters () const
 Returns true, if any of the parameters blocks have boundary conditions defined. More...
 

Public Attributes

unsigned int m_id = INVALID_ID
 ID of the referenced surface/interface. More...
 
unsigned int m_zoneId = 0
 The id number of the neighboring zone. More...
 
InterfaceHeatConduction m_heatConduction
 Model for convective heat transfer. More...
 
InterfaceSolarAbsorption m_solarAbsorption
 Model for solar absorption. More...
 
InterfaceLongWaveEmission m_longWaveEmission
 Model for long wave emissivity. More...
 
InterfaceVaporDiffusion m_vaporDiffusion
 Model for vapor diffusion (requires enabled moisture balance). More...
 
InterfaceAirFlow m_airFlow
 Model for air flow calculation. More...
 
std::string m_comment
 Comment, indicating the zone this interface links to. More...
 

Member Function Documentation

◆ checkParameters()

NANDRAD_COMPARE_WITH_ID void NANDRAD::Interface::checkParameters ( ) const

Checks for valid parameters.

Note
This function throws an exception if invalid parameters are defined or parameters are missing.

◆ updateComment()

void NANDRAD::Interface::updateComment ( const std::vector< Zone > &  zones)

Updates the comment regarding the zone this interface is connected to.

◆ haveBCParameters()

bool NANDRAD::Interface::haveBCParameters ( ) const

Returns true, if any of the parameters blocks have boundary conditions defined.

If the model ID m_id is INVALID_ID, the function returns false (the default). A boundary condition parameter block counts as defined, if the modelType is not NUM_MT.

Member Data Documentation

◆ m_id

unsigned int NANDRAD::Interface::m_id = INVALID_ID

ID of the referenced surface/interface.

Definition at line 88 of file NANDRAD_Interface.h.

◆ m_zoneId

unsigned int NANDRAD::Interface::m_zoneId = 0

The id number of the neighboring zone.

Definition at line 90 of file NANDRAD_Interface.h.

◆ m_heatConduction

InterfaceHeatConduction NANDRAD::Interface::m_heatConduction

Model for convective heat transfer.

Definition at line 94 of file NANDRAD_Interface.h.

◆ m_solarAbsorption

InterfaceSolarAbsorption NANDRAD::Interface::m_solarAbsorption

Model for solar absorption.

Definition at line 96 of file NANDRAD_Interface.h.

◆ m_longWaveEmission

InterfaceLongWaveEmission NANDRAD::Interface::m_longWaveEmission

Model for long wave emissivity.

Definition at line 98 of file NANDRAD_Interface.h.

◆ m_vaporDiffusion

InterfaceVaporDiffusion NANDRAD::Interface::m_vaporDiffusion

Model for vapor diffusion (requires enabled moisture balance).

Definition at line 100 of file NANDRAD_Interface.h.

◆ m_airFlow

InterfaceAirFlow NANDRAD::Interface::m_airFlow

Model for air flow calculation.

Definition at line 102 of file NANDRAD_Interface.h.

◆ m_comment

std::string NANDRAD::Interface::m_comment

Comment, indicating the zone this interface links to.

Warning
This comment is set automatically when the project is written with Project::writeXML(). Any existing text will be overwritten.

Definition at line 108 of file NANDRAD_Interface.h.


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