VICUS::BoundaryCondition Class Reference

#include <VICUS_BoundaryCondition.h>

Inheritance diagram for VICUS::BoundaryCondition:

Public Member Functions
VICUS_READWRITE_OVERRIDE VICUS_COMPARE_WITH_ID bool	isValid (const Database< Schedule > &scheduleDB) const
bool	hasSetpointTemperatureForZone () const
QString	htmlDescription (const VICUS::Database< Schedule > &scheduleDB) const
ComparisonResult	equal (const AbstractDBElement *other) const override
Public Member Functions inherited from VICUS::AbstractDBElement
	AbstractDBElement ()=default
	AbstractDBElement (unsigned int id, const IBK::MultiLanguageString &name)
virtual	~AbstractDBElement ()
virtual void	readXML (const TiXmlElement *element)=0
virtual TiXmlElement *	writeXML (TiXmlElement *parent) const =0
void	collectChildren (std::set< const AbstractDBElement * > &allChildrenRefs) const
void	collectLocalChildren (std::set< AbstractDBElement * > &localChildrenRefs) const
const QString	sourceName () const

Public Attributes
VICUS::InterfaceHeatConduction	m_heatConduction
NANDRAD::InterfaceSolarAbsorption	m_solarAbsorption
NANDRAD::InterfaceLongWaveEmission	m_longWaveEmission
NANDRAD::InterfaceVaporDiffusion	m_vaporDiffusion
NANDRAD::InterfaceAirFlow	m_airFlow
std::string	m_errorMsg
Public Attributes inherited from VICUS::AbstractDBElement
unsigned int	m_id = INVALID_ID
IBK::MultiLanguageString	m_displayName
QColor	m_color
bool	m_builtIn = false
bool	m_local = true
std::set< AbstractDBElement * >	m_childrenRefs
bool	m_isReferenced = false
std::string	m_errorMsg

Additional Inherited Members
Public Types inherited from VICUS::AbstractDBElement
enum	ComparisonResult { Equal , OnlyMetaDataDiffers , Different }

Detailed Description

This is a template for boundary conditions, to be referenced by components.

Member Function Documentation

equal()

AbstractDBElement::ComparisonResult VICUS::BoundaryCondition::equal ( const AbstractDBElement *  other ) const

overridevirtual

Comparison operator

Implements VICUS::AbstractDBElement.

hasSetpointTemperatureForZone()

bool VICUS::BoundaryCondition::hasSetpointTemperatureForZone

(

)

const

Checks if this boundary has a heat conduction model to a constant or scheduled temperature zone.

htmlDescription()

QString VICUS::BoundaryCondition::htmlDescription

(

const VICUS::Database< Schedule > &

scheduleDB

)

const

Generates a short html-description of the defined parameters.

isValid()

bool VICUS::BoundaryCondition::isValid

(

const Database< Schedule > &

scheduleDB

)

const

Checks if all parameters are valid.

Member Data Documentation

m_airFlow

NANDRAD::InterfaceAirFlow VICUS::BoundaryCondition::m_airFlow

Model for air flow calculation.

m_errorMsg

std::string VICUS::BoundaryCondition::m_errorMsg

mutable

Holds error string in order to give users a tooltip in db dialog.

m_heatConduction

VICUS::InterfaceHeatConduction VICUS::BoundaryCondition::m_heatConduction

Model for convective heat transfer.

m_longWaveEmission

NANDRAD::InterfaceLongWaveEmission VICUS::BoundaryCondition::m_longWaveEmission

Model for long wave emissivity.

m_solarAbsorption

NANDRAD::InterfaceSolarAbsorption VICUS::BoundaryCondition::m_solarAbsorption

Model for solar absorption.

m_vaporDiffusion

NANDRAD::InterfaceVaporDiffusion VICUS::BoundaryCondition::m_vaporDiffusion

Model for vapor diffusion (requires enabled moisture balance).

---

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

• /home/hirth/git/SIM-VICUS.master2/externals/Vicus/src/VICUS_BoundaryCondition.h
• /home/hirth/git/SIM-VICUS.master2/externals/Vicus/src/VICUS_BoundaryCondition.cpp