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

Detailed Description

Contains data of a flow element inside a network.

Pipe-specific parameters are stored in HydraulicNetworkPipeProperties objects, referenced via m_pipeID. For other elements, this ID is unused.

Definition at line 43 of file NANDRAD_HydraulicNetworkElement.h.

#include <NANDRAD_HydraulicNetworkElement.h>

Collaboration diagram for NANDRAD::HydraulicNetworkElement:

Public Types

enum  para_t { P_Length, NUM_P }
 Parameters for the element . More...
 
enum  intPara_t { IP_NumberParallelPipes, NUM_IP }
 Whole number parameters. More...
 

Public Member Functions

 HydraulicNetworkElement (unsigned int id, unsigned int inletNodeId, unsigned int outletNodeId, unsigned int componentId)
 C'tor for a network element other than pipes. More...
 
 HydraulicNetworkElement (unsigned int id, unsigned int inletNodeId, unsigned int outletNodeId, unsigned int componentId, unsigned int pipeID, double length)
 Specific constructor to create pipe elements. More...
 
NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID bool operator!= (const HydraulicNetworkElement &other) const
 
void checkParameters (const HydraulicNetwork &nw, const Project &prj)
 Checks for valid and required parameters (value ranges). More...
 

Public Attributes

IDType m_id = NANDRAD::INVALID_ID
 Unique ID for this flow component. More...
 
unsigned int m_inletNodeId = NANDRAD::INVALID_ID
 Inlet node ID. More...
 
unsigned int m_outletNodeId = NANDRAD::INVALID_ID
 Outlet node ID. More...
 
unsigned int m_componentId = NANDRAD::INVALID_ID
 Hydraulic component ID. More...
 
unsigned int m_pipePropertiesId = NANDRAD::INVALID_ID
 Pipe ID (only needed for elements that are pipes). More...
 
IDType m_controlElementId = NANDRAD::INVALID_ID
 Optional reference to a flow controller element. More...
 
std::string m_displayName
 Display name. More...
 
IBK::Parameter m_para [NUM_P]
 Parameters of the flow component. More...
 
IBK::IntPara m_intPara [NUM_IP]
 Integer parameters. More...
 
HydraulicNetworkHeatExchange m_heatExchange
 Optional definition of heat exchange calculation model (if missing, flow element is adiabat). More...
 
const HydraulicNetworkComponentm_component = nullptr
 
const HydraulicNetworkPipePropertiesm_pipeProperties = nullptr
 
const HydraulicNetworkControlElementm_controlElement = nullptr
 

Member Enumeration Documentation

◆ para_t

Parameters for the element .

Definition at line 67 of file NANDRAD_HydraulicNetworkElement.h.

◆ intPara_t

Whole number parameters.

Definition at line 73 of file NANDRAD_HydraulicNetworkElement.h.

Constructor & Destructor Documentation

◆ HydraulicNetworkElement() [1/2]

NANDRAD::HydraulicNetworkElement::HydraulicNetworkElement ( unsigned int  id,
unsigned int  inletNodeId,
unsigned int  outletNodeId,
unsigned int  componentId 
)
inline

C'tor for a network element other than pipes.

Definition at line 53 of file NANDRAD_HydraulicNetworkElement.h.

◆ HydraulicNetworkElement() [2/2]

NANDRAD::HydraulicNetworkElement::HydraulicNetworkElement ( unsigned int  id,
unsigned int  inletNodeId,
unsigned int  outletNodeId,
unsigned int  componentId,
unsigned int  pipeID,
double  length 
)

Specific constructor to create pipe elements.

Member Function Documentation

◆ checkParameters()

void NANDRAD::HydraulicNetworkElement::checkParameters ( const HydraulicNetwork nw,
const Project prj 
)

Checks for valid and required parameters (value ranges).

If referenced TSV file is given, this is read and checked and data is transferred into variable m_tsvFileContent.

Member Data Documentation

◆ m_id

IDType NANDRAD::HydraulicNetworkElement::m_id = NANDRAD::INVALID_ID

Unique ID for this flow component.

ID is used for outputs and to reference heat sources/sinks connected to this element. For active elements, this ID is used to connect control models.

Definition at line 98 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_inletNodeId

unsigned int NANDRAD::HydraulicNetworkElement::m_inletNodeId = NANDRAD::INVALID_ID

Inlet node ID.

Definition at line 100 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_outletNodeId

unsigned int NANDRAD::HydraulicNetworkElement::m_outletNodeId = NANDRAD::INVALID_ID

Outlet node ID.

Definition at line 102 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_componentId

unsigned int NANDRAD::HydraulicNetworkElement::m_componentId = NANDRAD::INVALID_ID

Hydraulic component ID.

Definition at line 104 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_pipePropertiesId

unsigned int NANDRAD::HydraulicNetworkElement::m_pipePropertiesId = NANDRAD::INVALID_ID

Pipe ID (only needed for elements that are pipes).

Definition at line 106 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_controlElementId

IDType NANDRAD::HydraulicNetworkElement::m_controlElementId = NANDRAD::INVALID_ID

Optional reference to a flow controller element.

Definition at line 109 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_displayName

std::string NANDRAD::HydraulicNetworkElement::m_displayName

Display name.

Definition at line 112 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_para

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

Parameters of the flow component.

Definition at line 115 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_intPara

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

Integer parameters.

Definition at line 118 of file NANDRAD_HydraulicNetworkElement.h.

◆ m_heatExchange

HydraulicNetworkHeatExchange NANDRAD::HydraulicNetworkElement::m_heatExchange

Optional definition of heat exchange calculation model (if missing, flow element is adiabat).

Definition at line 121 of file NANDRAD_HydraulicNetworkElement.h.


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