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

Detailed Description

Simulation parameters define global model settings.

Definition at line 39 of file NANDRAD_SimulationParameter.h.

#include <NANDRAD_SimulationParameter.h>

Collaboration diagram for NANDRAD::SimulationParameter:

Public Types

enum  para_t {
  P_InitialTemperature, P_InitialRelativeHumidity, P_DomesticWaterSensitiveHeatGainFraction, P_AirExchangeRateN50,
  P_ShieldingCoefficient, P_HeatingDesignAmbientTemperature, NUM_P
}
 Parameter values. More...
 
enum  intPara_t { IP_StartYear, NUM_IP }
 Integer parameters. More...
 
enum  flag_t {
  F_EnableMoistureBalance, F_EnableCO2Balance, F_EnableJointVentilation, F_ExportClimateDataFMU,
  NUM_F
}
 Global model flags. More...
 

Public Member Functions

void initDefaults ()
 Init default values (called before readXML()). More...
 
NANDRAD_READWRITE void checkParameters () const
 To be called after readXML() and mainly used to check whether user-provided parameters are in the valid ranges. More...
 
double evaluateTimeSeries (double t, const NANDRAD::LinearSplineParameter &spl) const
 Takes the linear spline parameter and evalutes the data using potential time shift defined due to simulation start and also considers continuous/cyclic usage of the spline. More...
 

Public Attributes

IBK::Parameter m_para [NUM_P]
 List of parameters. More...
 
IBK::IntPara m_intPara [NUM_IP]
 Integer parameters. More...
 
IBK::Flag m_flags [NUM_F]
 List of flags. More...
 
Interval m_interval
 The time interval of simulation beginning, offset and duration from January 1, 0:00 of the start year. More...
 
SolarLoadsDistributionModel m_solarLoadsDistributionModel
 

Member Enumeration Documentation

◆ para_t

Parameter values.

Definition at line 43 of file NANDRAD_SimulationParameter.h.

◆ intPara_t

Integer parameters.

Definition at line 54 of file NANDRAD_SimulationParameter.h.

◆ flag_t

Global model flags.

Definition at line 60 of file NANDRAD_SimulationParameter.h.

Member Function Documentation

◆ initDefaults()

void NANDRAD::SimulationParameter::initDefaults ( )

Init default values (called before readXML()).

Note
These values will be overwritten in readXML() when the respective property is set in the project file.

◆ checkParameters()

NANDRAD_READWRITE void NANDRAD::SimulationParameter::checkParameters ( ) const

To be called after readXML() and mainly used to check whether user-provided parameters are in the valid ranges.

◆ evaluateTimeSeries()

double NANDRAD::SimulationParameter::evaluateTimeSeries ( double  t,
const NANDRAD::LinearSplineParameter spl 
) const

Takes the linear spline parameter and evalutes the data using potential time shift defined due to simulation start and also considers continuous/cyclic usage of the spline.

Parameters
tTime point in simulation time (i.e. simulation always starts with 0)
splThe spline data.

Member Data Documentation

◆ m_para

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

List of parameters.

Definition at line 92 of file NANDRAD_SimulationParameter.h.

◆ m_intPara

IBK::IntPara NANDRAD::SimulationParameter::m_intPara[NUM_IP]

Integer parameters.

Definition at line 94 of file NANDRAD_SimulationParameter.h.

◆ m_flags

IBK::Flag NANDRAD::SimulationParameter::m_flags[NUM_F]

List of flags.

Definition at line 96 of file NANDRAD_SimulationParameter.h.

◆ m_interval

Interval NANDRAD::SimulationParameter::m_interval

The time interval of simulation beginning, offset and duration from January 1, 0:00 of the start year.

Definition at line 100 of file NANDRAD_SimulationParameter.h.


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