Detailed Description

Contains all input data that describes a room with walls, floor, ceiling, usage, HVAC etc.

The room description references constructions, window and shading types from the database.

Definition at line 55 of file NANDRAD_Project.h.

#include <NANDRAD_Project.h>

Collaboration diagram for NANDRAD::Project:

[legend]

Public Member Functions
void	readXML (const IBK::Path &filename)
	Reads the project data from an XML file. More...

void	writeXML (const IBK::Path &filename) const
	Writes the project file to an XML file. More...

void	initDefaults ()
	Initializes project defaults. More...

void	mergeSameConstructions ()
	All constructions with same boundary conditions and construction type are merged into one since the results will be the same for all constructions. More...

Public Attributes
ProjectInfo	m_projectInfo
	Comments about the project. More...

std::map< std::string, IBK::Path >	m_placeholders
	Contains mapping of directory placeholders and absolute directory paths. More...

Location	m_location
	Location of the building and climate data. More...

SimulationParameter	m_simulationParameter
	Simulation settings: all global parameters. More...

SolverParameter	m_solverParameter
	Solver settings: error tolerances and convergence coefficients.

std::vector< Zone >	m_zones
	All active and constant thermal zones. More...

std::vector< ConstructionInstance >	m_constructionInstances
	All construction instances refernce a construction and a thermal zone. More...

std::vector< HydraulicNetwork >	m_hydraulicNetworks
	All hydraulic networks defined for this project. More...

std::vector< ConstructionType >	m_constructionTypes
	All construction types reference construction parameters. More...

std::vector< Material >	m_materials
	All material types. More...

std::vector< WindowGlazingSystem >	m_windowGlazingSystems
	All glazing types. More...

Schedules	m_schedules
	References to all schedules. More...

Models	m_models
	Container for various model parametrization blocks. More...

Outputs	m_outputs
	References to Output specifications. More...

std::vector< ObjectList >	m_objectLists
	References to object lists. More...

FMIDescription	m_fmiDescription
	Definitions for exporting an FMU from the model. More...

Private Member Functions
void	readDirectoryPlaceholdersXML (const TiXmlElement *element)
	Reads the section with directory placeholders. More...

void	writeDirectoryPlaceholdersXML (TiXmlElement *parent) const
	Writes the section with directory placeholders, but only, if the map isn't empty. More...

Member Function Documentation

◆ readXML()

void NANDRAD::Project::readXML ( const IBK::Path & filename )

Reads the project data from an XML file.

Parameters

filename The full path to the project file.

◆ writeXML()

void NANDRAD::Project::writeXML ( const IBK::Path & filename ) const

Writes the project file to an XML file.

Parameters

filename The full path to the project file.

◆ initDefaults()

void NANDRAD::Project::initDefaults ( )

Initializes project defaults.

This function is called during solver run before readXML(). Hence, default values can be overwritten during project file reading.

◆ mergeSameConstructions()

void NANDRAD::Project::mergeSameConstructions ( )

All constructions with same boundary conditions and construction type are merged into one since the results will be the same for all constructions.

For each merged construction, a new construction is added to the end of the construction list. All merged constructions are removed (this ensured, that any remaining reference to a merged construction will trigger an error). The cross sections of all constructions are summed together to make up the final cross section of the merged construction.

A data table is created with information on merged constructions:

new merged construction ID
vector of merged construction IDs and their areas

Warning: This algorithmus may not be suitable for calculations that involve view factors and long wave radiation exchange. Hence, do not call this function for such models!

Embedded objects that reference one of the merge constructions will be modified to reference the merge construction instead. A mapping table is created that lists those changes:

embedded object ID
old construction instance ID
new merged construction instance ID

◆ readDirectoryPlaceholdersXML()

void NANDRAD::Project::readDirectoryPlaceholdersXML ( const TiXmlElement * element )

private

Reads the section with directory placeholders.

Parameters

element The directory placeholders element tag.

◆ writeDirectoryPlaceholdersXML()

void NANDRAD::Project::writeDirectoryPlaceholdersXML ( TiXmlElement * parent ) const

private

Writes the section with directory placeholders, but only, if the map isn't empty.

Parameters

parent The parent tag.

Member Data Documentation

◆ m_projectInfo

ProjectInfo NANDRAD::Project::m_projectInfo

Comments about the project.

Definition at line 103 of file NANDRAD_Project.h.

◆ m_placeholders

std::map<std::string, IBK::Path> NANDRAD::Project::m_placeholders

Contains mapping of directory placeholders and absolute directory paths.

Definition at line 106 of file NANDRAD_Project.h.

◆ m_location

Location NANDRAD::Project::m_location

Location of the building and climate data.

Definition at line 109 of file NANDRAD_Project.h.

◆ m_simulationParameter

SimulationParameter NANDRAD::Project::m_simulationParameter

Simulation settings: all global parameters.

Definition at line 112 of file NANDRAD_Project.h.

◆ m_zones

std::vector<Zone> NANDRAD::Project::m_zones

All active and constant thermal zones.

Definition at line 118 of file NANDRAD_Project.h.

◆ m_constructionInstances

std::vector<ConstructionInstance> NANDRAD::Project::m_constructionInstances

All construction instances refernce a construction and a thermal zone.

Definition at line 121 of file NANDRAD_Project.h.

◆ m_hydraulicNetworks

std::vector<HydraulicNetwork> NANDRAD::Project::m_hydraulicNetworks

All hydraulic networks defined for this project.

Definition at line 124 of file NANDRAD_Project.h.

◆ m_constructionTypes

std::vector<ConstructionType> NANDRAD::Project::m_constructionTypes

All construction types reference construction parameters.

Definition at line 127 of file NANDRAD_Project.h.

◆ m_materials

std::vector<Material> NANDRAD::Project::m_materials

All material types.

Definition at line 130 of file NANDRAD_Project.h.

◆ m_windowGlazingSystems

std::vector<WindowGlazingSystem> NANDRAD::Project::m_windowGlazingSystems

All glazing types.

Definition at line 133 of file NANDRAD_Project.h.

◆ m_schedules

Schedules NANDRAD::Project::m_schedules

References to all schedules.

Definition at line 136 of file NANDRAD_Project.h.

◆ m_models

Models NANDRAD::Project::m_models

Container for various model parametrization blocks.

Definition at line 139 of file NANDRAD_Project.h.

◆ m_outputs

Outputs NANDRAD::Project::m_outputs

References to Output specifications.

Definition at line 142 of file NANDRAD_Project.h.

◆ m_objectLists

std::vector<ObjectList> NANDRAD::Project::m_objectLists

References to object lists.

Definition at line 145 of file NANDRAD_Project.h.

◆ m_fmiDescription

FMIDescription NANDRAD::Project::m_fmiDescription

Definitions for exporting an FMU from the model.

Definition at line 148 of file NANDRAD_Project.h.

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

NANDRAD_Project.h

Detailed Description

Public Member Functions

Public Attributes

Private Member Functions

Member Function Documentation

◆ readXML()

◆ writeXML()

◆ initDefaults()

◆ mergeSameConstructions()

◆ readDirectoryPlaceholdersXML()

◆ writeDirectoryPlaceholdersXML()

Member Data Documentation

◆ m_projectInfo

◆ m_placeholders

◆ m_location

◆ m_simulationParameter

◆ m_zones

◆ m_constructionInstances

◆ m_hydraulicNetworks

◆ m_constructionTypes

◆ m_materials

◆ m_windowGlazingSystems

◆ m_schedules

◆ m_models

◆ m_outputs

◆ m_objectLists

◆ m_fmiDescription