Detailed Description

Parameters for a hydraulic component for the network.

Definition at line 36 of file NANDRAD_HydraulicNetworkComponent.h.

#include <NANDRAD_HydraulicNetworkComponent.h>

Collaboration diagram for NANDRAD::HydraulicNetworkComponent:

Public Types
enum	ModelType { MT_SimplePipe, MT_DynamicPipe, MT_ConstantPressurePump, MT_ConstantMassFluxPump, MT_ControlledPump, MT_HeatExchanger, MT_HeatPumpIdealCarnotSourceSide, MT_HeatPumpIdealCarnotSupplySide, MT_HeatPumpRealSourceSide, MT_ControlledValve, MT_IdealHeaterCooler, MT_ConstantPressureLossValve, NUM_MT }
	The various types (equations) of the hydraulic component. More...

enum	para_t { P_HydraulicDiameter, P_PressureLossCoefficient, P_PressureHead, P_MassFlux, P_PumpEfficiency, P_FractionOfMotorInefficienciesToFluidStream, P_Volume, P_PipeMaxDiscretizationWidth, P_CarnotEfficiency, P_MaximumHeatingPower, P_PressureLoss, P_MaximumPressureHead, P_PumpMaximumElectricalPower, NUM_P }
	Parameters for the component. More...

Public Member Functions
NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID bool	sameParametersAs (const HydraulicNetworkComponent &other) const
	Compares two component definitions by parameters only, without comparing ID. More...

void	checkParameters (int networkModelType)
	Checks for valid and required parameters (value ranges). More...

Static Public Member Functions
static std::vector< unsigned int >	requiredParameter (const ModelType modelType, int networkModelType)
	Needed both in user interface and for valid parameter checking in solver. More...

static std::vector< std::string >	requiredScheduleNames (const ModelType modelType)

static void	checkModelParameter (const IBK::Parameter &para, const unsigned int numPara)
	Helper function that implements specific rules for testing a single parameter. More...

Public Attributes
unsigned int	m_id = NANDRAD::INVALID_ID
	Unique ID for this component. More...

std::string	m_displayName
	Display name. More...

ModelType	m_modelType = NUM_MT
	Model type. More...

IBK::Parameter	m_para [NUM_P]
	Parameters of the flow component. More...

DataTable	m_polynomCoefficients
	Array parameters of the flow component.

Member Enumeration Documentation

◆ ModelType

enum NANDRAD::HydraulicNetworkComponent::ModelType

The various types (equations) of the hydraulic component.

Definition at line 40 of file NANDRAD_HydraulicNetworkComponent.h.

◆ para_t

enum NANDRAD::HydraulicNetworkComponent::para_t

Parameters for the component.

Definition at line 57 of file NANDRAD_HydraulicNetworkComponent.h.

Member Function Documentation

◆ sameParametersAs()

NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID bool NANDRAD::HydraulicNetworkComponent::sameParametersAs ( const HydraulicNetworkComponent & other ) const

Compares two component definitions by parameters only, without comparing ID.

◆ checkParameters()

void NANDRAD::HydraulicNetworkComponent::checkParameters ( int networkModelType )

Checks for valid and required parameters (value ranges).

Parameters

networkModelType Type of network calculation model (HydraulicNetwork::ModelType).

◆ requiredParameter()

static std::vector<unsigned int> NANDRAD::HydraulicNetworkComponent::requiredParameter	(	const ModelType	modelType,
		int	networkModelType
	)

static

Needed both in user interface and for valid parameter checking in solver.

Parameters

networkModelType Identifies network model (HydraulicNetwork::ModelType).

◆ checkModelParameter()

static void NANDRAD::HydraulicNetworkComponent::checkModelParameter	(	const IBK::Parameter &	para,
		const unsigned int	numPara
	)

static

Helper function that implements specific rules for testing a single parameter.

This is useful if the same parameter is used by several models and we want to avoid implementing the same checking rule multiple times. Is used in Nandrad as well as in the graphical user interface.

Member Data Documentation

◆ m_id

unsigned int NANDRAD::HydraulicNetworkComponent::m_id = NANDRAD::INVALID_ID

Unique ID for this component.

Definition at line 92 of file NANDRAD_HydraulicNetworkComponent.h.

◆ m_displayName

std::string NANDRAD::HydraulicNetworkComponent::m_displayName

Display name.

Definition at line 95 of file NANDRAD_HydraulicNetworkComponent.h.

◆ m_modelType

ModelType NANDRAD::HydraulicNetworkComponent::m_modelType = NUM_MT

Model type.

Definition at line 98 of file NANDRAD_HydraulicNetworkComponent.h.

◆ m_para

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

Parameters of the flow component.

Definition at line 101 of file NANDRAD_HydraulicNetworkComponent.h.

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

NANDRAD_HydraulicNetworkComponent.h