VICUS Library
Documentation of Vicus library
Loading...
Searching...
No Matches
VICUS::Outputs Class Reference

#include <VICUS_Outputs.h>

Public Types

enum  flag_t {
  F_BinaryFormat , F_CreateDefaultZoneOutputs , F_CreateDefaultNetworkOutputs , F_CreateDefaultNetworkSummationModels ,
  NUM_F
}
 

Public Attributes

std::vector< VICUS::OutputDefinitionm_definitions
 
std::vector< NANDRAD::OutputGrid > m_grids
 
std::string m_checkSum
 
IBK::Unit m_timeUnit
 
IBK::Flag m_flags [NUM_F]
 

Detailed Description

Contains output definitions/specifications. The VICUS output definition is very similar to the NANDRAD Outputs data structure, but contains some more properties needed for the user interface.

If CreateDefaultZoneOutputs is true, default output definitions for zones are created. These are:

  • zone air temperatures for all zones
  • wall surface temperatures for all constructions
  • wall heat flux towards zones
  • wall heat flux towards ambient
  • total heat conduction load in zone

Also, default object lists are being created.

Similarly, the flag "CreateDefaultNetworkOutputs" defines, whether default outputs for network objects are being created.

Additionally, custom output definitions can be specified.

Member Enumeration Documentation

◆ flag_t

Flags.

Enumerator
F_BinaryFormat 
F_CreateDefaultZoneOutputs 
F_CreateDefaultNetworkOutputs 
F_CreateDefaultNetworkSummationModels 
NUM_F 

Member Data Documentation

◆ m_checkSum

std::string VICUS::Outputs::m_checkSum

Hash code (MD5) of output variables file 'output_reference_list.txt'

◆ m_definitions

std::vector<VICUS::OutputDefinition> VICUS::Outputs::m_definitions

List with user-defined output definitions.

◆ m_flags

IBK::Flag VICUS::Outputs::m_flags[NUM_F]

(optional) If true, output files are written in binary format (the default, if flag is missing).

◆ m_grids

std::vector<NANDRAD::OutputGrid> VICUS::Outputs::m_grids

List with output grids.

◆ m_timeUnit

IBK::Unit VICUS::Outputs::m_timeUnit

(optional) The time unit to be used in all output files. If not set (undefined unit), the time unit is selected automatically based on the simulation duration.


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