Detailed Description

This class contains parameters for a controller that is used for network elements.

A controller is actually a flow controller that impacts the way the flow elements-system function is evaluated, usually adding a flow resistance (e.g. value) to the element. The additional flow resistance can be controlled in different ways, as defined by ControlledProperty.

Definition at line 19 of file NANDRAD_HydraulicNetworkControlElement.h.

#include <NANDRAD_HydraulicNetworkControlElement.h>

Public Types
enum	ModelType { MT_Constant, MT_Scheduled, NUM_MT }
	Defines variability options for set point values. More...

enum	ControlledProperty { CP_TemperatureDifference, CP_TemperatureDifferenceOfFollowingElement, CP_ThermostatValue, CP_MassFlux, NUM_CP }
	Controlled property used as signal input for the controller. More...

enum	ControllerType { CT_PController, CT_PIController, NUM_CT }
	Different model variants. More...

enum	para_t { P_Kp, P_Ki, P_Kd, P_TemperatureDifferenceSetpoint, P_MassFluxSetpoint, NUM_P }
	Model parameters. More...

enum	References { ID_ThermostatZoneId, NUM_ID }
	Integer/whole number parameters. More...

Public Member Functions
NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID void	checkParameters (const std::vector< NANDRAD::Zone > &zones) const
	Checks for valid and required parameters (value ranges). More...

Static Public Member Functions
static std::vector< ControlledProperty >	availableControlledProperties (const HydraulicNetworkComponent::ModelType modelType)

Public Attributes
IDType	m_id = NANDRAD::INVALID_ID

ModelType	m_modelType = NUM_MT
	Determines variability of setpoint parameters. More...

ControllerType	m_controllerType = NUM_CT
	Controller type (P, PI, ...)

ControlledProperty	m_controlledProperty = NUM_CP
	property which shall be controlled (temperature difference, ...)

IDType	m_idReferences [NUM_ID]
	Integer/ID reference parameters. More...

double	m_maximumControllerResultValue = 0
	Used to cut the system input, if this is zero, it will not be considered.

IBK::Parameter	m_para [NUM_P]
	Controller parameters. More...

Member Enumeration Documentation

◆ ModelType

enum NANDRAD::HydraulicNetworkControlElement::ModelType

Defines variability options for set point values.

Enumerator

MT_Scheduled

Generates 'TemperatureDifferenceSetpointSchedule' or 'MassFluxSetpointSchedule' depending on controlled property for each network element that uses this controller.

InputRef-Typ: NetworkElement, id = id of network element that uses the component with this controller

Definition at line 30 of file NANDRAD_HydraulicNetworkControlElement.h.

◆ ControlledProperty

enum NANDRAD::HydraulicNetworkControlElement::ControlledProperty

Controlled property used as signal input for the controller.

Enumerator
CP_TemperatureDifference	Temperature difference is computed from pre-defined heat loss and compared against target temperature difference.
CP_TemperatureDifferenceOfFollowingElement	Temperature difference of the following flow element is computed from outlet temperature of this element and outlet temperature of the following element. This temperature difference is compared against target temperature difference.
CP_ThermostatValue	Thermostat heating/cooling control values determine whether valve is open or closed.
CP_MassFlux	Try to achieve target mass flow in current element.

Definition at line 41 of file NANDRAD_HydraulicNetworkControlElement.h.

◆ ControllerType

enum NANDRAD::HydraulicNetworkControlElement::ControllerType

Different model variants.

Definition at line 55 of file NANDRAD_HydraulicNetworkControlElement.h.

◆ para_t

enum NANDRAD::HydraulicNetworkControlElement::para_t

Model parameters.

Definition at line 62 of file NANDRAD_HydraulicNetworkControlElement.h.

◆ References

enum NANDRAD::HydraulicNetworkControlElement::References

Integer/whole number parameters.

Enumerator
ID_ThermostatZoneId	Id of zone whose thermostat is used for control: only for controlled property 'ThermostatValue'.

Definition at line 72 of file NANDRAD_HydraulicNetworkControlElement.h.

Member Function Documentation

◆ checkParameters()

NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID void NANDRAD::HydraulicNetworkControlElement::checkParameters ( const std::vector< NANDRAD::Zone > & zones ) const

Checks for valid and required parameters (value ranges).

Member Data Documentation

◆ m_modelType

ModelType NANDRAD::HydraulicNetworkControlElement::m_modelType = NUM_MT

Determines variability of setpoint parameters.

Definition at line 81 of file NANDRAD_HydraulicNetworkControlElement.h.

◆ m_idReferences

IDType NANDRAD::HydraulicNetworkControlElement::m_idReferences[NUM_ID]

Integer/ID reference parameters.

Definition at line 90 of file NANDRAD_HydraulicNetworkControlElement.h.

◆ m_para

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

Controller parameters.

Definition at line 96 of file NANDRAD_HydraulicNetworkControlElement.h.

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

NANDRAD_HydraulicNetworkControlElement.h