Buildings.Fluid.Sensors

Package with sensor models

Information

Package Sensors consists of idealized sensor components that provide variables of a medium as output signals. These signals can be, e.g., further processed with components of the Modelica.Blocks library.

Extends from Modelica.Icons.SensorsPackage (Icon for packages containing sensors).

Package Content

Name	Description
UsersGuide	User's Guide
Density	Ideal one port density sensor
DensityTwoPort	Ideal two port density sensor
EnthalpyFlowRate	Ideal enthalphy flow rate sensor
EntropyFlowRate	Ideal entropy flow rate sensor
LatentEnthalpyFlowRate	Ideal enthalphy flow rate sensor that outputs the latent enthalpy flow rate only
MassFlowRate	Ideal sensor for mass flow rate
MassFraction	Ideal one port mass fraction sensor
MassFractionTwoPort	Ideal two port mass fraction sensor
PPM	Ideal one port trace substances sensor outputting in parts per million
PPMTwoPort	Ideal two port trace substances sensor outputting in parts per million
Pressure	Ideal pressure sensor
RelativeHumidity	Ideal one port relative humidity sensor
RelativeHumidityTwoPort	Ideal two port relative humidity sensor
RelativePressure	Ideal relative pressure sensor
RelativeTemperature	Ideal relative temperature sensor
SensibleEnthalpyFlowRate	Ideal enthalphy flow rate sensor that outputs the sensible enthalpy flow rate only
SpecificEnthalpy	Ideal one port specific enthalpy sensor
SpecificEnthalpyTwoPort	Ideal two port sensor for the specific enthalpy
SpecificEntropy	Ideal one port specific entropy sensor
SpecificEntropyTwoPort	Ideal two port sensor for the specific entropy
Temperature	Ideal one port temperature sensor
TemperatureTwoPort	Ideal two port temperature sensor
TemperatureWetBulbTwoPort	Ideal wet bulb temperature sensor
TraceSubstances	Ideal one port trace substances sensor
TraceSubstancesTwoPort	Ideal two port sensor for trace substance
Velocity	Ideal sensor for flow velocity
VolumeFlowRate	Ideal sensor for volume flow rate
Conversions	Package with conversions for sensor models
Examples	Collection of models that illustrate model use and test models
BaseClasses	Package with base classes for Buildings.Fluid.Sensors

Buildings.Fluid.Sensors.Density

Ideal one port density sensor

Buildings.Fluid.Sensors.Density

Information

This model outputs the density of the fluid connected to its port. The sensor is ideal, i.e. it does not influence the fluid.

To measure density in a duct or pipe, use Buildings.Fluid.Sensors.DensityTwoPort rather than this sensor. Read the Buildings.Fluid.Sensors.UsersGuide prior to using this model to see about potential numerical problems if this sensor is used incorrectly in a system model.

Extends from Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor (Partial component to model a sensor that measures a potential variable), Modelica.Icons.RoundSensor (Icon representing a round measurement device).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	true	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information

Connectors

Type	Name	Description
FluidPort_a	port
output RealOutput	d	Density in port medium [kg/m3]

Modelica definition

model Density "Ideal one port density sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor; extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput d(final quantity="Density", final unit="kg/m3", min=0) "Density in port medium"; equation d = Medium.density( state=Medium.setState_phX( p=port.p, h=inStream(port.h_outflow), X=inStream(port.Xi_outflow))); end Density;

Buildings.Fluid.Sensors.DensityTwoPort

Ideal two port density sensor

Buildings.Fluid.Sensors.DensityTwoPort

Information

This model outputs the density of the fluid flowing from port_a to port_b.

The sensor is ideal, i.e., it does not influence the fluid. If the parameter tau is non-zero, then its output is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Extends from Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor (Partial component to model sensors that measure flow properties using a dynamic model), Modelica.Icons.RoundSensor (Icon representing a round measurement device).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
Density	d_start	Medium.density(state=Medium....	Initial or guess value of output (=state) [kg/m3]
Temperature	T_start	Medium.T_default	Temperature used to compute d_start [K]
Pressure	p_start	Medium.p_default	Pressure used to compute d_start [Pa]
MassFraction	X_start[Medium.nX]	Medium.X_default	Mass fraction used to compute d_start [1]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	d	Density of the passing fluid [kg/m3]

Modelica definition

model DensityTwoPort "Ideal two port density sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor; extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput d(final quantity="Density", final unit="kg/m3", min=0) "Density of the passing fluid"; parameter Medium.Density d_start= Medium.density(state=Medium.setState_pTX( p=p_start, T=T_start, X=X_start)) "Initial or guess value of output (=state)"; parameter Modelica.Units.SI.Temperature T_start=Medium.T_default "Temperature used to compute d_start"; parameter Modelica.Units.SI.Pressure p_start=Medium.p_default "Pressure used to compute d_start"; parameter Modelica.Units.SI.MassFraction X_start[Medium.nX]=Medium.X_default "Mass fraction used to compute d_start"; protected Medium.Density dMed(start=d_start) "Medium density to which the sensor is exposed"; Medium.Density d_a_inflow "Density of inflowing fluid at port_a"; Medium.Density d_b_inflow "Density of inflowing fluid at port_b, or rho_a_inflow if uni-directional flow"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(d) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then d = d_start; end if; end if; equation if allowFlowReversal then d_a_inflow = Medium.density( state=Medium.setState_phX(p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); d_b_inflow = Medium.density( state=Medium.setState_phX(p=port_a.p, h=port_a.h_outflow, X=port_a.Xi_outflow)); dMed = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=d_a_inflow, y2=d_b_inflow, x_small=m_flow_small); else dMed = Medium.density( state=Medium.setState_phX(p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); d_a_inflow = dMed; d_b_inflow = dMed; end if; // Output signal of sensor if dynamic then der(d) = (dMed-d)*k*tauInv; else d = dMed; end if; end DensityTwoPort;

Buildings.Fluid.Sensors.EnthalpyFlowRate

Ideal enthalphy flow rate sensor

Buildings.Fluid.Sensors.EnthalpyFlowRate

Information

This model outputs the enthalphy flow rate of the medium in the flow between fluid ports. The sensor is ideal, i.e., it does not influence the fluid.

If the parameter tau is non-zero, then the measured specific enthalpy h_out that is used to compute the enthalpy flow rate Ḣ = ṁ h_out is computed using a first order differential equation. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

For a sensor that measures the latent enthalpy flow rate, use Buildings.Fluid.Sensors.LatentEnthalpyFlowRate.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	0	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
SpecificEnthalpy	h_out_start	Medium.specificEnthalpy_pTX(...	Initial or guess value of measured specific enthalpy [J/kg]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	H_flow	Enthalpy flow rate, positive if from port_a to port_b [W]

Modelica definition

model EnthalpyFlowRate "Ideal enthalphy flow rate sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor( tau=0); extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput H_flow(final unit="W") "Enthalpy flow rate, positive if from port_a to port_b"; parameter Modelica.Units.SI.SpecificEnthalpy h_out_start= Medium.specificEnthalpy_pTX( p=Medium.p_default, T=Medium.T_default, X=Medium.X_default) "Initial or guess value of measured specific enthalpy"; protected Modelica.Units.SI.SpecificEnthalpy hMed_out(start=h_out_start) "Medium enthalpy to which the sensor is exposed"; Modelica.Units.SI.SpecificEnthalpy h_out(start=h_out_start) "Medium enthalpy that is used to compute the enthalpy flow rate"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(h_out) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then h_out = h_out_start; end if; end if; equation if allowFlowReversal then hMed_out = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.h_outflow, y2=port_a.h_outflow, x_small=m_flow_small); else hMed_out = port_b.h_outflow; end if; // Specific enthalpy measured by sensor if dynamic then der(h_out) = (hMed_out-h_out)*k*tauInv; else h_out = hMed_out; end if; // Sensor output signal H_flow = port_a.m_flow * h_out; end EnthalpyFlowRate;

Buildings.Fluid.Sensors.EntropyFlowRate

Ideal entropy flow rate sensor

Buildings.Fluid.Sensors.EntropyFlowRate

Information

This model outputs the entropy flow rate of the medium in the flow between fluid ports. The sensor is ideal, i.e., it does not influence the fluid.

If the parameter tau is non-zero, then the measured specific entropy s_out that is used to compute the entropy flow rate Ṡ = ṁ s_out is computed using a first order differential equation. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	0	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
SpecificEntropy	s_out_start	Medium.specificEntropy_pTX(p...	Initial or guess value of measured specific entropy [J/(kg.K)]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	S_flow	Entropy flow rate, positive if from port_a to port_b [W/K]

Modelica definition

model EntropyFlowRate "Ideal entropy flow rate sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor( tau=0); extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput S_flow(final unit="W/K") "Entropy flow rate, positive if from port_a to port_b"; parameter Modelica.Units.SI.SpecificEntropy s_out_start= Medium.specificEntropy_pTX( p=Medium.p_default, T=Medium.T_default, X=Medium.X_default) "Initial or guess value of measured specific entropy"; protected Modelica.Units.SI.SpecificEntropy sMed_out(start=s_out_start) "Medium entropy to which the sensor is exposed"; Modelica.Units.SI.SpecificEntropy s_out(start=s_out_start) "Medium entropy that is used to compute the entropy flow rate"; Modelica.Units.SI.SpecificEntropy port_b_s_outflow(start=s_out_start) "Medium entropy outflowing at port_b if mass flow were from port_a to port_b"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(s_out) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then s_out = s_out_start; end if; end if; equation port_b_s_outflow = Medium.specificEntropy( Medium.setState_phX( p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); if allowFlowReversal then sMed_out = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b_s_outflow, y2=Medium.specificEntropy( Medium.setState_phX( p=port_a.p, h=port_a.h_outflow, X=port_a.Xi_outflow)), x_small=m_flow_small); else sMed_out = port_b_s_outflow; end if; // Specific entropy measured by sensor if dynamic then der(s_out) = (sMed_out-s_out)*k*tauInv; else s_out = sMed_out; end if; // Sensor output signal S_flow = port_a.m_flow * s_out; end EntropyFlowRate;

Buildings.Fluid.Sensors.LatentEnthalpyFlowRate

Ideal enthalphy flow rate sensor that outputs the latent enthalpy flow rate only

Buildings.Fluid.Sensors.LatentEnthalpyFlowRate

Information

This model outputs the latent enthalphy flow rate of the medium in the flow between its fluid ports. In particular, if the total enthalpy flow rate is

Ḣ_tot = Ḣ_sen + Ḣ_lat,

where Ḣ_sen = ṁ (1-X_w) c_p,air, then this sensor outputs Ḣ = Ḣ_lat.

If the parameter tau is non-zero, then the measured specific latent enthalpy h_out that is used to compute the latent enthalpy flow rate Ḣ_lat = ṁ h_out is computed using a first order differential equation. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

For a sensor that measures Ḣ_tot, use Buildings.Fluid.Sensors.EnthalpyFlowRate.
For a sensor that measures Ḣ_sen, use Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate.

The sensor is ideal, i.e., it does not influence the fluid. The sensor can only be used with medium models that implement the function enthalpyOfNonCondensingGas(T).

Extends from Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor (Partial component to model sensors that measure flow properties using a dynamic model), Buildings.Fluid.BaseClasses.IndexMassFraction (Computes the index of a substance in the mass fraction vector Xi), Modelica.Icons.RoundSensor (Icon representing a round measurement device).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	0	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
String	substanceName	"water"	Name of species substance
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
SpecificEnthalpy	h_out_start	Medium.specificEnthalpy_pTX(...	Initial or guess value of measured specific latent enthalpy [J/kg]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
replaceable package Medium		Medium in the component
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	H_flow	Latent enthalpy flow rate, positive if from port_a to port_b [W]

Modelica definition

model LatentEnthalpyFlowRate "Ideal enthalphy flow rate sensor that outputs the latent enthalpy flow rate only" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor( redeclare replaceable package Medium = Modelica.Media.Interfaces.PartialCondensingGases, tau=0); extends Buildings.Fluid.BaseClasses.IndexMassFraction(final substanceName="water"); extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput H_flow(final unit="W") "Latent enthalpy flow rate, positive if from port_a to port_b"; parameter Modelica.Units.SI.SpecificEnthalpy h_out_start= Medium.specificEnthalpy_pTX( p=Medium.p_default, T=Medium.T_default, X=Medium.X_default) - Medium.enthalpyOfNonCondensingGas(T=Medium.T_default) "Initial or guess value of measured specific latent enthalpy"; protected Modelica.Units.SI.SpecificEnthalpy hMed_out(start=h_out_start) "Medium latent enthalpy to which the sensor is exposed"; Modelica.Units.SI.SpecificEnthalpy h_out(start=h_out_start) "Medium latent enthalpy that is used to compute the enthalpy flow rate"; Medium.MassFraction XiActual[Medium.nXi] "Medium mass fraction to which sensor is exposed to"; Medium.SpecificEnthalpy hActual "Medium enthalpy to which sensor is exposed to"; initial equation // Compute initial state if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(h_out) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then h_out = h_out_start; end if; end if; equation if allowFlowReversal then XiActual = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.Xi_outflow, y2=port_a.Xi_outflow, x_small=m_flow_small); hActual = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.h_outflow, y2=port_a.h_outflow, x_small=m_flow_small); else XiActual = port_b.Xi_outflow; hActual = port_b.h_outflow; end if; // Specific enthalpy measured by sensor. // Compute H_flow as difference between total enthalpy and enthalpy on non-condensing gas. // This is needed to compute the liquid vs. gas fraction of water, using the equations // provided by the medium model hMed_out = (hActual - (1-XiActual[i_x]) * Medium.enthalpyOfNonCondensingGas( T=Medium.temperature(Medium.setState_phX(p=port_a.p, h=hActual, X=XiActual)))); if dynamic then der(h_out) = (hMed_out-h_out)*k*tauInv; else h_out = hMed_out; end if; // Sensor output signal H_flow = port_a.m_flow * h_out; end LatentEnthalpyFlowRate;

Buildings.Fluid.Sensors.MassFlowRate

Ideal sensor for mass flow rate

Buildings.Fluid.Sensors.MassFlowRate

Information

This model outputs the mass flow rate flowing from port_a to port_b. The sensor is ideal, i.e., it does not influence the fluid.

Extends from Buildings.Fluid.Sensors.BaseClasses.PartialFlowSensor (Partial component to model sensors that measure flow properties), Modelica.Icons.RoundSensor (Icon representing a round measurement device).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Nominal condition
MassFlowRate	m_flow_nominal	0	Nominal mass flow rate, used for regularization near zero flow [kg/s]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	0	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	m_flow	Mass flow rate from port_a to port_b [kg/s]

Modelica definition

model MassFlowRate "Ideal sensor for mass flow rate" extends Buildings.Fluid.Sensors.BaseClasses.PartialFlowSensor( final m_flow_nominal = 0, final m_flow_small = 0); extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput m_flow(quantity="MassFlowRate", final unit="kg/s") "Mass flow rate from port_a to port_b"; equation m_flow = port_a.m_flow; end MassFlowRate;

Buildings.Fluid.Sensors.MassFraction

Ideal one port mass fraction sensor

Buildings.Fluid.Sensors.MassFraction

Information

This model outputs the mass fraction of the fluid connected to its port. The sensor is ideal, i.e., it does not influence the fluid.

To measure mass fraction in a duct or pipe, use Buildings.Fluid.Sensors.MassFractionTwoPort rather than this sensor. Read the Buildings.Fluid.Sensors.UsersGuide prior to using this model to see about potential numerical problems if this sensor is used incorrectly in a system model.

Extends from Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor (Partial component to model a sensor that measures a potential variable), Buildings.Fluid.BaseClasses.IndexMassFraction (Computes the index of a substance in the mass fraction vector Xi), Modelica.Icons.RoundSensor (Icon representing a round measurement device).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	true	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information
String	substanceName	"water"	Name of species substance

Connectors

Type	Name	Description
replaceable package Medium		Medium in the sensor
FluidPort_a	port
output RealOutput	X	Mass fraction in port [kg/kg]

Modelica definition

model MassFraction "Ideal one port mass fraction sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor( redeclare replaceable package Medium = Modelica.Media.Interfaces.PartialCondensingGases); extends Buildings.Fluid.BaseClasses.IndexMassFraction(substanceName = "water"); extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput X(min=-1e-3, max=1.001, final unit="kg/kg") "Mass fraction in port"; protected Medium.MassFraction XiVec[Medium.nXi]( final quantity=Medium.substanceNames[1:Medium.nXi]) "Mass fraction vector, needed because indexed argument for the operator inStream is not supported"; equation XiVec = inStream(port.Xi_outflow); X = if i_x > Medium.nXi then (1-sum(XiVec)) else XiVec[i_x]; end MassFraction;

Buildings.Fluid.Sensors.MassFractionTwoPort

Ideal two port mass fraction sensor

Buildings.Fluid.Sensors.MassFractionTwoPort

Information

This model outputs the mass fraction of the passing fluid. The sensor is ideal, i.e. it does not influence the fluid. If the parameter tau is non-zero, then its output is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
String	substanceName	"water"	Name of species substance
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
MassFraction	X_start	Medium.X_default[i_x]	Initial or guess value of output (= state) [kg/kg]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
replaceable package Medium		Medium in the component
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	X	Mass fraction of the passing fluid [kg/kg]

Modelica definition

model MassFractionTwoPort "Ideal two port mass fraction sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor( redeclare replaceable package Medium = Modelica.Media.Interfaces.PartialCondensingGases); extends Buildings.Fluid.BaseClasses.IndexMassFraction(substanceName = "water"); extends Modelica.Icons.RoundSensor; parameter Medium.MassFraction X_start=Medium.X_default[i_x] "Initial or guess value of output (= state)"; Modelica.Blocks.Interfaces.RealOutput X(min=-1e-3, max=1.001, start=X_start, final unit="kg/kg") "Mass fraction of the passing fluid"; protected Medium.MassFraction XMed(start=X_start) "Mass fraction to which the sensor is exposed"; Medium.MassFraction XiVec[Medium.nXi]( final quantity=Medium.substanceNames[1:Medium.nXi]) "Mass fraction vector, needed because indexed argument for the operator inStream is not supported"; initial equation // Assign initial conditions if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(X) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then X = X_start; end if; end if; equation if allowFlowReversal then XiVec = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.Xi_outflow, y2=port_a.Xi_outflow, x_small=m_flow_small); else XiVec = port_b.Xi_outflow; end if; XMed = if i_x > Medium.nXi then (1-sum(XiVec)) else XiVec[i_x]; // Output signal of sensor if dynamic then der(X) = (XMed-X)*k*tauInv; else X = XMed; end if; end MassFractionTwoPort;

Buildings.Fluid.Sensors.PPM

Ideal one port trace substances sensor outputting in parts per million

Buildings.Fluid.Sensors.PPM

Information

This model outputs the trace substance concentration in ppm contained in the fluid connected to its port. The sensor is ideal, i.e., it does not influence the fluid.

The parameter MM is the molar mass of the trace substance. For a list of molar masses, see Modelica.Media.IdealGases.Common.SingleGasesData and Modelica.Media.IdealGases.Common.FluidData.

To measure PPM in a duct or pipe, use Buildings.Fluid.Sensors.PPMTwoPort rather than this sensor. Read the Buildings.Fluid.Sensors.UsersGuide prior to using this model to see about potential numerical problems if this sensor is used incorrectly in a system model.

Assumptions

This sensor assumes that the concentration C of the medium is in mass fraction. Otherwise, the conversion to ppm will be wrong.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	true	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information
String	substanceName	"CO2"	Name of trace substance
MolarMass	MM	Modelica.Media.IdealGases.Co...	Molar mass of the trace substance [kg/mol]

Connectors

Type	Name	Description
output RealOutput	ppm	Trace substance in port medium in ppm

Modelica definition

model PPM "Ideal one port trace substances sensor outputting in parts per million" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor( port(C_outflow(each final quantity="MassFraction", each final unit="1", each min=0, each max=1))); extends Modelica.Icons.RoundSensor; parameter String substanceName = "CO2" "Name of trace substance"; parameter Modelica.Units.SI.MolarMass MM=Modelica.Media.IdealGases.Common.SingleGasesData.CO2.MM "Molar mass of the trace substance"; Modelica.Blocks.Interfaces.RealOutput ppm(min=0) "Trace substance in port medium in ppm"; protected parameter Real s[:]= { if ( Modelica.Utilities.Strings.isEqual(string1=Medium.extraPropertiesNames[i], string2=substanceName, caseSensitive=false)) then 1 else 0 for i in 1:Medium.nC} "Vector with zero everywhere except where species is"; final parameter Modelica.Units.SI.MolarMass MMBul=Medium.molarMass( Medium.setState_phX( p=Medium.p_default, h=Medium.h_default, X=Medium.X_default)) "Molar mass of bulk medium"; final parameter Real MMFraction( min=0, max=1, final unit="1", final quantity="MassFraction")=MMBul/MM "Molar mass of the medium divided by the molar mass of the trace substance"; final parameter Real coeff = MMFraction*1e6 "Conversion from mass fraction to ppm"; initial equation assert(max(s) > 0.9, "Trace substance '" + substanceName + "' is not present in medium '" + Medium.mediumName + "'.\n" + "Check sensor parameter and medium model."); equation // We obtain the species concentration with a vector multiplication // because Dymola 7.3 cannot find the derivative in the model // Buildings.Examples.VAVSystemCTControl.mo // if we set C = CVec[ind]; ppm = s*inStream(port.C_outflow)*coeff; end PPM;

Buildings.Fluid.Sensors.PPMTwoPort

Ideal two port trace substances sensor outputting in parts per million

Information

This model outputs the trace substance of the passing fluid in parts per million. The sensor is ideal, i.e., it does not influence the fluid. If the parameter tau is non-zero, then its output is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
String	substanceName	"CO2"	Name of trace substance
MolarMass	MM	Modelica.Media.IdealGases.Co...	Molar mass of the trace substance [kg/mol]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
Real	C_start	0	Initial or guess value of output (= state)
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
output RealOutput	ppm	Trace substance in port medium in ppm

Modelica definition

model PPMTwoPort "Ideal two port trace substances sensor outputting in parts per million" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor( port_a(C_outflow(each final quantity="MassFraction", each final unit="1", each min=0, each max=1)), port_b(C_outflow(each final quantity="MassFraction", each final unit="1", each min=0, each max=1))); extends Modelica.Icons.RoundSensor; parameter String substanceName = "CO2" "Name of trace substance"; parameter Real C_start(min=0) = 0 "Initial or guess value of output (= state)"; parameter Modelica.Units.SI.MolarMass MM=Modelica.Media.IdealGases.Common.SingleGasesData.CO2.MM "Molar mass of the trace substance"; Modelica.Blocks.Interfaces.RealOutput ppm(min=0) "Trace substance in port medium in ppm"; protected parameter Real s[:]= { if ( Modelica.Utilities.Strings.isEqual(string1=Medium.extraPropertiesNames[i], string2=substanceName, caseSensitive=false)) then 1 else 0 for i in 1:Medium.nC} "Vector with zero everywhere except where species is"; final parameter Modelica.Units.SI.MolarMass MMBul=Medium.molarMass( Medium.setState_phX( p=Medium.p_default, h=Medium.h_default, X=Medium.X_default)) "Molar mass of bulk medium"; final parameter Real MMFraction(min=0, unit="1")=MMBul/MM "Molar mass of the medium divided by the molar mass of the trace substance"; final parameter Real coeff = MMFraction*1e6 "Conversion from mass fraction to ppm"; Real CMed(min=0, start=C_start, nominal=sum(Medium.C_nominal))= if allowFlowReversal then Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=s*port_b.C_outflow, y2=s*port_a.C_outflow, x_small=m_flow_small) else s*port_b.C_outflow "Trace substance concentration to which the sensor is exposed"; Real C(min=0,start=C_start) "Trace substance concentration of the passing fluid"; initial equation assert(max(s) > 0.9, "Trace substance '" + substanceName + "' is not present in medium '" + Medium.mediumName + "'.\n" + "Check sensor parameter and medium model."); if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(C) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then C = C_start; end if; end if; equation ppm = C*coeff; // Output signal of sensor if dynamic then der(C) = (CMed-C)*k*tauInv; else C = CMed; end if; end PPMTwoPort;

Buildings.Fluid.Sensors.Pressure

Ideal pressure sensor

Buildings.Fluid.Sensors.Pressure

Information

This model outputs the absolute pressure of the fluid connected to its port. The sensor is ideal, i.e., it does not influence the fluid.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	false	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information

Connectors

Type	Name	Description
FluidPort_a	port
output RealOutput	p	Pressure at port [Pa]

Modelica definition

model Pressure "Ideal pressure sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor( final warnAboutOnePortConnection = false); extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput p(final quantity="AbsolutePressure", final unit="Pa", min=0) "Pressure at port"; equation p = port.p; end Pressure;

Buildings.Fluid.Sensors.RelativeHumidity

Ideal one port relative humidity sensor

Buildings.Fluid.Sensors.RelativeHumidity

Information

This model outputs the relative humidity of the fluid connected to its port. The sensor is ideal, i.e. it does not influence the fluid.

Note that this sensor can only be used with media that contain the variable phi, which is typically the case for moist air models.

To measure relative humidity in a duct or pipe, use Buildings.Fluid.Sensors.RelativeHumidityTwoPort rather than this sensor. Read the Buildings.Fluid.Sensors.UsersGuide prior to using this model to see about potential numerical problems if this sensor is used incorrectly in a system model.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	true	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information

Connectors

Type	Name	Description
FluidPort_a	port
output RealOutput	phi	Relative humidity in port medium [1]

Modelica definition

model RelativeHumidity "Ideal one port relative humidity sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor; extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput phi(final unit="1", min=0) "Relative humidity in port medium"; protected Modelica.Units.SI.Temperature T "Temperature of the medium"; Medium.MassFraction Xi[Medium.nXi]( quantity=Medium.substanceNames[1:Medium.nXi]) "Mass fraction of the medium"; equation Xi = inStream(port.Xi_outflow); T=Medium.temperature_phX( p=port.p, h=inStream(port.h_outflow), X=Xi); phi = Buildings.Utilities.Psychrometrics.Functions.phi_pTX( p=port.p, T=T, X_w=Xi[1]); end RelativeHumidity;

Buildings.Fluid.Sensors.RelativeHumidityTwoPort

Ideal two port relative humidity sensor

Buildings.Fluid.Sensors.RelativeHumidityTwoPort

Information

This model outputs the relative humidity of the fluid flowing from port_a to port_b. The sensor is ideal, i.e., it does not influence the fluid.

Note that this sensor can only be used with media that contain the variable phi, which is typically the case for moist air models.

If the parameter tau is non-zero, then its output is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
Real	phi_start	0.5	Initial or guess value of output (= state) [1]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	phi	Relative humidity of the passing fluid [1]

Modelica definition

model RelativeHumidityTwoPort "Ideal two port relative humidity sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor; extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput phi(final unit="1", min=0, start=phi_start) "Relative humidity of the passing fluid"; parameter Real phi_start(final unit="1", min=0, max=1)=0.5 "Initial or guess value of output (= state)"; protected Real phiMed(final unit="1", min=0, start=phi_start) "Relative humidity to which the sensor is exposed to"; protected Modelica.Units.SI.Temperature T_a "Temperature of the medium flowing from port_a to port_b"; Medium.MassFraction Xi_a[Medium.nXi]( quantity=Medium.substanceNames[1:Medium.nXi]) "Mass fraction of the medium flowing from port_a to port_b"; Real phi_a(final unit="1") "Relative humidity of the medium flowing from port_a to port_b"; Modelica.Units.SI.Temperature T_b "Temperature of the medium flowing from port_b to port_a"; Medium.MassFraction Xi_b[Medium.nXi]( quantity=Medium.substanceNames[1:Medium.nXi]) "Mass fraction of the medium flowing from port_b to port_a"; Real phi_b(final unit="1") "Relative humidity of the medium flowing from port_b to port_a"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(phi) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then phi = phi_start; end if; end if; equation // Since the sensor does not affect the medium, we can use // port_b.Xi_outflow = inStream(port_a.Xi_outflow). Xi_a = port_b.Xi_outflow; T_a=Medium.temperature_phX( p=port_a.p, h=port_b.h_outflow, X=Xi_a); phi_a = Buildings.Utilities.Psychrometrics.Functions.phi_pTX( p=port_a.p, T=T_a, X_w=Xi_a[1]); if allowFlowReversal then phi_b = Buildings.Utilities.Psychrometrics.Functions.phi_pTX( p=port_b.p, T=T_b, X_w=Xi_b[1]); T_b=Medium.temperature_phX( p=port_b.p, h=port_a.h_outflow, X=Xi_b); Xi_b = port_a.Xi_outflow; phiMed = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=phi_a, y2=phi_b, x_small=m_flow_small); else phi_b = 0; T_b = 273.15; Xi_b = zeros(Medium.nXi); phiMed = phi_a; end if; // Output signal of sensor if dynamic then der(phi) = (phiMed-phi)*k*tauInv; else phi = phiMed; end if; end RelativeHumidityTwoPort;

Buildings.Fluid.Sensors.RelativePressure

Ideal relative pressure sensor

Buildings.Fluid.Sensors.RelativePressure

Information

The relative pressure port_a.p - port_b.p is determined between the two ports of this component and is provided as output signal. The sensor should be connected in parallel with other equipment, no flow through the sensor is allowed.

Extends from Modelica.Icons.RectangularSensor (Icon representing a linear measurement device).

Parameters

Type	Name	Default	Description
replaceable package Medium		Modelica.Media.Interfaces.Pa...	Medium in the sensor

Connectors

Type	Name	Description
replaceable package Medium		Medium in the sensor
FluidPort_a	port_a	Fluid connector of stream a
FluidPort_b	port_b	Fluid connector of stream b
output RealOutput	p_rel	Relative pressure of port_a minus port_b [Pa]

Modelica definition

model RelativePressure "Ideal relative pressure sensor" extends Modelica.Icons.RectangularSensor; replaceable package Medium = Modelica.Media.Interfaces.PartialMedium "Medium in the sensor"; Modelica.Fluid.Interfaces.FluidPort_a port_a(m_flow(min=0), p(start=Medium.p_default), redeclare package Medium = Medium) "Fluid connector of stream a"; Modelica.Fluid.Interfaces.FluidPort_b port_b(m_flow(min=0), p(start=Medium.p_default), redeclare package Medium = Medium) "Fluid connector of stream b"; Modelica.Blocks.Interfaces.RealOutput p_rel(final quantity="PressureDifference", final unit="Pa", displayUnit="Pa") "Relative pressure of port_a minus port_b"; equation // Zero flow equations for connectors port_a.m_flow = 0; port_b.m_flow = 0; // No contribution of specific quantities port_a.h_outflow = 0; port_b.h_outflow = 0; port_a.Xi_outflow = zeros(Medium.nXi); port_b.Xi_outflow = zeros(Medium.nXi); port_a.C_outflow = zeros(Medium.nC); port_b.C_outflow = zeros(Medium.nC); // Relative pressure p_rel = port_a.p - port_b.p; end RelativePressure;

Buildings.Fluid.Sensors.RelativeTemperature

Ideal relative temperature sensor

Buildings.Fluid.Sensors.RelativeTemperature

Information

The relative temperature T(port_a) - T(port_b) is determined between the two ports of this component and is provided as output signal. The sensor should be connected in parallel with other equipment. There is no flow through the sensor.

Note that this sensor should only be connected to fluid volumes, such as Buildings.Fluid.MixingVolumes.MixingVolume. Otherwise, numerical problems may occur if one of the mass flow rates are close to zero. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Extends from Modelica.Icons.RectangularSensor (Icon representing a linear measurement device).

Parameters

Type	Name	Default	Description
replaceable package Medium		Modelica.Media.Interfaces.Pa...	Medium in the sensor

Connectors

Type	Name	Description
replaceable package Medium		Medium in the sensor
FluidPort_a	port_a	Fluid connector of stream a
FluidPort_b	port_b	Fluid connector of stream b
output RealOutput	T_rel	Temperature difference of port_a minus port_b [K]

Modelica definition

model RelativeTemperature "Ideal relative temperature sensor" extends Modelica.Icons.RectangularSensor; replaceable package Medium = Modelica.Media.Interfaces.PartialMedium "Medium in the sensor"; Modelica.Fluid.Interfaces.FluidPort_a port_a(m_flow(min=0), p(start=Medium.p_default), redeclare package Medium = Medium) "Fluid connector of stream a"; Modelica.Fluid.Interfaces.FluidPort_b port_b(m_flow(min=0), p(start=Medium.p_default), redeclare package Medium = Medium) "Fluid connector of stream b"; Modelica.Blocks.Interfaces.RealOutput T_rel(final unit = "K", displayUnit = "K") "Temperature difference of port_a minus port_b"; equation // Zero flow equations for connectors port_a.m_flow = 0; port_b.m_flow = 0; // No contribution of specific quantities port_a.h_outflow = 0; port_b.h_outflow = 0; port_a.Xi_outflow = zeros(Medium.nXi); port_b.Xi_outflow = zeros(Medium.nXi); port_a.C_outflow = zeros(Medium.nC); port_b.C_outflow = zeros(Medium.nC); // Relative temperature T_rel = Medium.temperature(state=Medium.setState_phX( p=port_a.p, h=inStream(port_a.h_outflow), X=inStream(port_a.Xi_outflow))) - Medium.temperature(state=Medium.setState_phX( p=port_b.p, h=inStream(port_b.h_outflow), X=inStream(port_b.Xi_outflow))); end RelativeTemperature;

Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate

Ideal enthalphy flow rate sensor that outputs the sensible enthalpy flow rate only

Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate

Information

This model outputs the sensible enthalphy flow rate of the medium in the flow between its fluid ports. In particular, if the total enthalpy flow rate is

Ḣ_tot = Ḣ_sen + Ḣ_lat,

where Ḣ_sen = ṁ (1-X_w) c_p,air, then this sensor outputs Ḣ = Ḣ_sen.

If the parameter tau is non-zero, then the measured specific sensible enthalpy h_out that is used to compute the sensible enthalpy flow rate Ḣ_sen = ṁ h_out is computed using a first order differential equation. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

For a sensor that measures Ḣ_tot, use Buildings.Fluid.Sensors.EnthalpyFlowRate.
For a sensor that measures Ḣ_lat, use Buildings.Fluid.Sensors.LatentEnthalpyFlowRate.

The sensor is ideal, i.e., it does not influence the fluid. The sensor can only be used with medium models that implement the function enthalpyOfNonCondensingGas(T).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	0	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
String	substanceName	"water"	Name of species substance
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
SpecificEnthalpy	h_out_start	Medium.enthalpyOfNonCondensi...	Initial or guess value of measured specific sensible enthalpy [J/kg]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
replaceable package Medium		Medium in the component
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	H_flow	Sensible enthalpy flow rate, positive if from port_a to port_b [W]

Modelica definition

model SensibleEnthalpyFlowRate "Ideal enthalphy flow rate sensor that outputs the sensible enthalpy flow rate only" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor( redeclare replaceable package Medium = Modelica.Media.Interfaces.PartialCondensingGases, tau=0); extends Buildings.Fluid.BaseClasses.IndexMassFraction(final substanceName="water"); extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput H_flow(final unit="W") "Sensible enthalpy flow rate, positive if from port_a to port_b"; parameter Modelica.Units.SI.SpecificEnthalpy h_out_start= Medium.enthalpyOfNonCondensingGas(T=Medium.T_default) "Initial or guess value of measured specific sensible enthalpy"; protected Modelica.Units.SI.SpecificEnthalpy hMed_out(start=h_out_start) "Medium sensible enthalpy to which the sensor is exposed"; Modelica.Units.SI.SpecificEnthalpy h_out(start=h_out_start) "Medium sensible enthalpy that is used to compute the enthalpy flow rate"; Medium.MassFraction XiActual[Medium.nXi] "Medium mass fraction to which sensor is exposed to"; Medium.SpecificEnthalpy hActual "Medium enthalpy to which sensor is exposed to"; initial equation // Compute initial state if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(h_out) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then h_out = h_out_start; end if; end if; equation if allowFlowReversal then XiActual = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.Xi_outflow, y2=port_a.Xi_outflow, x_small=m_flow_small); hActual = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.h_outflow, y2=port_a.h_outflow, x_small=m_flow_small); else XiActual = port_b.Xi_outflow; hActual = port_b.h_outflow; end if; // Specific enthalpy measured by sensor hMed_out = (1-XiActual[i_x]) * Medium.enthalpyOfNonCondensingGas( T=Medium.temperature(state=Medium.setState_phX(p=port_a.p, h=hActual, X=XiActual))); if dynamic then der(h_out) = (hMed_out-h_out)*k*tauInv; else h_out = hMed_out; end if; // Sensor output signal H_flow = port_a.m_flow * h_out; end SensibleEnthalpyFlowRate;

Buildings.Fluid.Sensors.SpecificEnthalpy

Ideal one port specific enthalpy sensor

Buildings.Fluid.Sensors.SpecificEnthalpy

Information

This model outputs the specific enthalpy of the fluid connected to its port. The sensor is ideal, i.e. it does not influence the fluid.

To measure specific enthalpy in a duct or pipe, use Buildings.Fluid.Sensors.SpecificEnthalpyTwoPort rather than this sensor. Read the Buildings.Fluid.Sensors.UsersGuide prior to using this model to see about potential numerical problems if this sensor is used incorrectly in a system model.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	true	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information

Connectors

Type	Name	Description
FluidPort_a	port
output RealOutput	h_out	Specific enthalpy in port medium [J/kg]

Modelica definition

model SpecificEnthalpy "Ideal one port specific enthalpy sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor; extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput h_out(final quantity="SpecificEnergy", final unit="J/kg") "Specific enthalpy in port medium"; equation h_out = inStream(port.h_outflow); end SpecificEnthalpy;

Buildings.Fluid.Sensors.SpecificEnthalpyTwoPort

Ideal two port sensor for the specific enthalpy

Buildings.Fluid.Sensors.SpecificEnthalpyTwoPort

Information

This model outputs the specific enthalpy of a passing fluid. The sensor is ideal, i.e. it does not influence the fluid. If the parameter tau is non-zero, then its output is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
SpecificEnthalpy	h_out_start	Medium.specificEnthalpy_pTX(...	Initial or guess value of output (= state) [J/kg]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	h_out	Specific enthalpy of the passing fluid [J/kg]

Modelica definition

model SpecificEnthalpyTwoPort "Ideal two port sensor for the specific enthalpy" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor; extends Modelica.Icons.RoundSensor; parameter Modelica.Units.SI.SpecificEnthalpy h_out_start= Medium.specificEnthalpy_pTX( p=Medium.p_default, T=Medium.T_default, X=Medium.X_default) "Initial or guess value of output (= state)"; Modelica.Blocks.Interfaces.RealOutput h_out(final quantity="SpecificEnergy", final unit="J/kg", start=h_out_start) "Specific enthalpy of the passing fluid"; protected Modelica.Units.SI.SpecificEnthalpy hMed_out(start=h_out_start) "Medium enthalpy to which the sensor is exposed"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(h_out) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then h_out = h_out_start; end if; end if; equation if allowFlowReversal then hMed_out = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.h_outflow, y2=port_a.h_outflow, x_small=m_flow_small); else hMed_out = port_b.h_outflow; end if; // Output signal of sensor if dynamic then der(h_out) = (hMed_out-h_out)*k*tauInv; else h_out = hMed_out; end if; end SpecificEnthalpyTwoPort;

Buildings.Fluid.Sensors.SpecificEntropy

Ideal one port specific entropy sensor

Buildings.Fluid.Sensors.SpecificEntropy

Information

This model outputs the specific entropy of the fluid connected to its port. The sensor is ideal, i.e., it does not influence the fluid.

To measure specific entropy in a duct or pipe, use Buildings.Fluid.Sensors.SpecificEntropyTwoPort rather than this sensor. Read the Buildings.Fluid.Sensors.UsersGuide prior to using this model to see about potential numerical problems if this sensor is used incorrectly in a system model.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	true	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information

Connectors

Type	Name	Description
FluidPort_a	port
output RealOutput	s	Specific entropy in port medium [J/(kg.K)]

Modelica definition

model SpecificEntropy "Ideal one port specific entropy sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor; extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput s(final quantity="SpecificEntropy", final unit="J/(kg.K)") "Specific entropy in port medium"; equation s = Medium.specificEntropy(state=Medium.setState_phX( p=port.p, h=inStream(port.h_outflow), X=inStream(port.Xi_outflow))); end SpecificEntropy;

Buildings.Fluid.Sensors.SpecificEntropyTwoPort

Ideal two port sensor for the specific entropy

Buildings.Fluid.Sensors.SpecificEntropyTwoPort

Information

This model outputs the specific entropy of the passing fluid. The sensor is ideal, i.e., it does not influence the fluid. If the parameter tau is non-zero, then its output is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
SpecificEntropy	s_start	Medium.specificEntropy_pTX(p...	Initial or guess value of output (= state) [J/(kg.K)]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	s	Specific entropy of the passing fluid [J/(kg.K)]

Modelica definition

model SpecificEntropyTwoPort "Ideal two port sensor for the specific entropy" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor; extends Modelica.Icons.RoundSensor; parameter Modelica.Units.SI.SpecificEntropy s_start= Medium.specificEntropy_pTX( p=Medium.p_default, T=Medium.T_default, X=Medium.X_default) "Initial or guess value of output (= state)"; Modelica.Blocks.Interfaces.RealOutput s(final quantity="SpecificEntropy", final unit="J/(kg.K)", start=s_start) "Specific entropy of the passing fluid"; protected Modelica.Units.SI.SpecificEntropy sMed(start=s_start) "Medium entropy to which the sensor is exposed"; Medium.SpecificEntropy s_a_inflow "Specific entropy of inflowing fluid at port_a"; Medium.SpecificEntropy s_b_inflow "Specific entropy of inflowing fluid at port_b, or s_a_inflow if uni-directional flow"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(s) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then s = s_start; end if; end if; equation if allowFlowReversal then s_a_inflow = Medium.specificEntropy(state= Medium.setState_phX(p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); s_b_inflow = Medium.specificEntropy(state= Medium.setState_phX(p=port_a.p, h=port_a.h_outflow, X=port_a.Xi_outflow)); sMed = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=s_a_inflow, y2=s_b_inflow, x_small=m_flow_small); else sMed = Medium.specificEntropy(state= Medium.setState_phX(p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); s_a_inflow = sMed; s_b_inflow = sMed; end if; // Output signal of sensor if dynamic then der(s) = (sMed-s)*k*tauInv; else s = sMed; end if; end SpecificEntropyTwoPort;

Buildings.Fluid.Sensors.Temperature

Ideal one port temperature sensor

Buildings.Fluid.Sensors.Temperature

Information

This model outputs the temperature of the fluid connected to its port. The sensor is ideal, i.e., it does not influence the fluid.

To measure temperature in a duct or pipe, use Buildings.Fluid.Sensors.TemperatureTwoPort rather than this sensor. Read the Buildings.Fluid.Sensors.UsersGuide prior to using this model to see about potential numerical problems if this sensor is used incorrectly in a system model.

Extends from Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor (Partial component to model a sensor that measures a potential variable).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	true	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information

Connectors

Type	Name	Description
FluidPort_a	port
output RealOutput	T	Temperature in port medium [K]

Modelica definition

model Temperature "Ideal one port temperature sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor; Modelica.Blocks.Interfaces.RealOutput T(final quantity="ThermodynamicTemperature", final unit = "K", min=0, displayUnit = "degC") "Temperature in port medium"; equation T = Medium.temperature(state=Medium.setState_phX( p=port.p, h=inStream(port.h_outflow), X=inStream(port.Xi_outflow))); end Temperature;

Buildings.Fluid.Sensors.TemperatureTwoPort

Ideal two port temperature sensor

Buildings.Fluid.Sensors.TemperatureTwoPort

Information

This model outputs the temperature of the medium in the flow between its fluid ports. The sensor does not influence the fluid.

Typical use and important parameters

If the parameter tau is non-zero, then its output T converges to the temperature of the incoming fluid using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

If transferHeat = true, then heat transfer with the ambient is approximated and T converges towards the fixed ambient temperature T_Amb using a first order approximation with a time constant of tauHeaTra when the flow rate is small. Note that no energy is exchanged with the fluid as the sensor does not influence the fluid temperature.

Setting transferHeat = true is useful, for example, if the sensor is used to measure the fluid temperature in a system with on/off control on the mass flow rate. If transferHeat were false, then the sensor output T would remain constant if the mass flow rate is set to zero, and hence the controller may never switch the mass flow rate on again.

In general, applications in which the sensor output is not used to switch the mass flow rate on should set transferHeat=false.

Extends from Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor (Partial component to model sensors that measure flow properties using a dynamic model).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
Temperature	T_start	Medium.T_default	Initial or guess value of output (= state) [K]
Heat transfer
Boolean	transferHeat	false	if true, temperature T converges towards TAmb when no flow
Temperature	TAmb	Medium.T_default	Fixed ambient temperature for heat transfer [K]
Time	tauHeaTra	1200	Time constant for heat transfer, default 20 minutes [s]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	T	Temperature of the passing fluid [K]

Modelica definition

model TemperatureTwoPort "Ideal two port temperature sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor; Modelica.Blocks.Interfaces.RealOutput T(final quantity="ThermodynamicTemperature", final unit="K", displayUnit = "degC", min = 0, start=T_start) "Temperature of the passing fluid"; parameter Modelica.Units.SI.Temperature T_start=Medium.T_default "Initial or guess value of output (= state)"; parameter Boolean transferHeat = false "if true, temperature T converges towards TAmb when no flow"; parameter Modelica.Units.SI.Temperature TAmb=Medium.T_default "Fixed ambient temperature for heat transfer"; parameter Modelica.Units.SI.Time tauHeaTra(min=1) = 1200 "Time constant for heat transfer, default 20 minutes"; protected parameter Real tauHeaTraInv(final unit = "1/s")= if tauHeaTra<1E-10 then 0 else 1/tauHeaTra "Dummy parameter to avoid division by tauHeaTra"; parameter Real ratTau = if dynamic then tauHeaTra/tau else 1 "Ratio of tau"; Medium.Temperature TMed(start=T_start) "Medium temperature to which the sensor is exposed"; Medium.Temperature T_a_inflow "Temperature of inflowing fluid at port_a"; Medium.Temperature T_b_inflow "Temperature of inflowing fluid at port_b, or T_a_inflow if uni-directional flow"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(T) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then T = T_start; end if; end if; equation if allowFlowReversal then T_a_inflow = Medium.temperature(state= Medium.setState_phX(p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); T_b_inflow = Medium.temperature(state= Medium.setState_phX(p=port_a.p, h=port_a.h_outflow, X=port_a.Xi_outflow)); TMed = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=T_a_inflow, y2=T_b_inflow, x_small=m_flow_small); else TMed = Medium.temperature(state= Medium.setState_phX(p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); T_a_inflow = TMed; T_b_inflow = TMed; end if; // Output signal of sensor if dynamic then if transferHeat then der(T) = (TMed-T)*k*tauInv + (TAmb-T)*tauHeaTraInv/(ratTau*k+1); else der(T) = (TMed-T)*k*tauInv; end if; else T = TMed; end if; end TemperatureTwoPort;

Buildings.Fluid.Sensors.TemperatureWetBulbTwoPort

Ideal wet bulb temperature sensor

Buildings.Fluid.Sensors.TemperatureWetBulbTwoPort

Information

This sensor outputs the wet bulb temperature of the medium in the flow between its fluid ports. The sensor is ideal, i.e., it does not influence the fluid. If the parameter tau is non-zero, then its output is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Extends from Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor (Partial component to model sensors that measure flow properties using a dynamic model).

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
Temperature	TWetBul_start	Medium.T_default	Initial or guess value of wet bulb temperature (used to compute initial output signal)) [K]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	T	Wet bulb temperature in port medium [K]

Modelica definition

model TemperatureWetBulbTwoPort "Ideal wet bulb temperature sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor; Modelica.Blocks.Interfaces.RealOutput T( start=TWetBul_start, final quantity="ThermodynamicTemperature", final unit="K", displayUnit = "degC") "Wet bulb temperature in port medium"; parameter Modelica.Units.SI.Temperature TWetBul_start=Medium.T_default "Initial or guess value of wet bulb temperature (used to compute initial output signal))"; protected Medium.Temperature TMedWetBul(start=TWetBul_start) "Medium wet bulb temperature to which the sensor is exposed"; Buildings.Utilities.Psychrometrics.TWetBul_TDryBulXi wetBulMod( redeclare package Medium = Medium, TWetBul(start=TWetBul_start)) "Block for wet bulb temperature"; Modelica.Units.SI.SpecificEnthalpy h "Specific enthalpy"; Medium.MassFraction Xi[Medium.nXi] "Species vector, needed because indexed argument for the operator inStream is not supported"; initial equation // Initialization of wet bulb temperature if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(T) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then T = TWetBul_start; end if; end if; equation if allowFlowReversal then h = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.h_outflow, y2=port_a.h_outflow, x_small=m_flow_small); Xi = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=port_b.Xi_outflow, y2=port_a.Xi_outflow, x_small=m_flow_small); else h = port_b.h_outflow; Xi = port_b.Xi_outflow; end if; // Compute wet bulb temperature wetBulMod.TDryBul = Medium.temperature_phX(p=port_a.p, h=h, X=cat(1,Xi,{1-sum(Xi)})); wetBulMod.Xi = Xi; wetBulMod.p = port_a.p; TMedWetBul = wetBulMod.TWetBul; // Output signal of sensor if dynamic then der(T) = (TMedWetBul-T)*k*tauInv; else T = TMedWetBul; end if; end TemperatureWetBulbTwoPort;

Buildings.Fluid.Sensors.TraceSubstances

Ideal one port trace substances sensor

Buildings.Fluid.Sensors.TraceSubstances

Information

This model outputs the trace substances contained in the fluid connected to its port. The sensor is ideal, i.e., it does not influence the fluid.

To measure trace substances in a duct or pipe, use Buildings.Fluid.Sensors.TraceSubstancesTwoPort rather than this sensor. Read the Buildings.Fluid.Sensors.UsersGuide prior to using this model to see about potential numerical problems if this sensor is used incorrectly in a system model.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the sensor
Boolean	warnAboutOnePortConnection	true	Set to false to suppress warning about potential numerical issues, see Buildings.Fluid.Sensors.UsersGuide for more information
String	substanceName	"CO2"	Name of trace substance

Connectors

Type	Name	Description
FluidPort_a	port
output RealOutput	C	Trace substance in port medium

Modelica definition

model TraceSubstances "Ideal one port trace substances sensor" extends Buildings.Fluid.Sensors.BaseClasses.PartialAbsoluteSensor; extends Modelica.Icons.RoundSensor; parameter String substanceName = "CO2" "Name of trace substance"; Modelica.Blocks.Interfaces.RealOutput C(min=0) "Trace substance in port medium"; protected parameter Real s[:]= { if ( Modelica.Utilities.Strings.isEqual(string1=Medium.extraPropertiesNames[i], string2=substanceName, caseSensitive=false)) then 1 else 0 for i in 1:Medium.nC} "Vector with zero everywhere except where species is"; initial equation assert(max(s) > 0.9, "Trace substance '" + substanceName + "' is not present in medium '" + Medium.mediumName + "'.\n" + "Check sensor parameter and medium model."); equation // We obtain the species concentration with a vector multiplication // because Dymola 7.3 cannot find the derivative in the model // Buildings.Examples.VAVSystemCTControl.mo // if we set C = CVec[ind]; C = s*inStream(port.C_outflow); end TraceSubstances;

Buildings.Fluid.Sensors.TraceSubstancesTwoPort

Ideal two port sensor for trace substance

Buildings.Fluid.Sensors.TraceSubstancesTwoPort

Information

This model outputs the trace substance of the passing fluid. The sensor is ideal, i.e., it does not influence the fluid. If the parameter tau is non-zero, then its output is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
String	substanceName	"CO2"	Name of trace substance
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
Real	C_start	0	Initial or guess value of output (= state)
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	C	Trace substance of the passing fluid

Modelica definition

model TraceSubstancesTwoPort "Ideal two port sensor for trace substance" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor; extends Modelica.Icons.RoundSensor; Modelica.Blocks.Interfaces.RealOutput C(min=0, start=C_start) "Trace substance of the passing fluid"; parameter String substanceName = "CO2" "Name of trace substance"; parameter Real C_start(min=0) = 0 "Initial or guess value of output (= state)"; protected constant Real sumC_nominal = sum(Medium.C_nominal) "Sum of Medium.C_nominal"; Real CMed(min=0, start=C_start, nominal= if sumC_nominal > Modelica.Constants.eps then sumC_nominal else 1) "Medium trace substance to which the sensor is exposed"; parameter Real s[:]= { if ( Modelica.Utilities.Strings.isEqual(string1=Medium.extraPropertiesNames[i], string2=substanceName, caseSensitive=false)) then 1 else 0 for i in 1:Medium.nC} "Vector with zero everywhere except where species is"; initial equation assert(max(s) > 0.9, "Trace substance '" + substanceName + "' is not present in medium '" + Medium.mediumName + "'.\n" + "Check sensor parameter and medium model."); if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(C) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then C = C_start; end if; end if; equation if allowFlowReversal then CMed = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=s*port_b.C_outflow, y2=s*port_a.C_outflow, x_small=m_flow_small); else CMed = s*port_b.C_outflow; end if; // Output signal of sensor if dynamic then der(C) = (CMed-C)*k*tauInv; else C = CMed; end if; end TraceSubstancesTwoPort;

Buildings.Fluid.Sensors.Velocity

Ideal sensor for flow velocity

Buildings.Fluid.Sensors.Velocity

Information

This model outputs the flow velocity flowing from port_a to port_b.

The sensor is ideal, i.e., it does not influence the fluid. If the parameter tau is non-zero, then the measured density that is used to convert the mass flow rate into volumetric flow rate is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Typical use and important parameters

In order to use the flow velocity sensor, the cross sectional area of the flow channel crossSection must be specified in m₂. For a circular flow channel (e.g. a round pipe) of diameter diameter, the cross sectional area can be specified as crossSection = diameter * diameter / 4 * Modelica.Constants.pi. See Buildings.Fluid.Sensors.Examples.Velocity for an example implementation with diameter = 0.1.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	1	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Area	A		Cross sectional area of flow channel [m2]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
Density	d_start	Medium.density(Medium.setSta...	Initial or guess value of density [kg/m3]
Temperature	T_start	Medium.T_default	Temperature used to compute d_start [K]
Pressure	p_start	Medium.p_default	Pressure used to compute d_start [Pa]
MassFraction	X_start[Medium.nX]	Medium.X_default	Mass fraction used to compute d_start [1]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	v	Flow velocity from port_a to port_b [m/s]

Modelica definition

model Velocity "Ideal sensor for flow velocity" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor; extends Modelica.Icons.RoundSensor; parameter Medium.Density d_start=Medium.density(Medium.setState_pTX(p_start, T_start, X_start)) "Initial or guess value of density"; parameter Modelica.Units.SI.Temperature T_start=Medium.T_default "Temperature used to compute d_start"; parameter Modelica.Units.SI.Pressure p_start=Medium.p_default "Pressure used to compute d_start"; parameter Modelica.Units.SI.MassFraction X_start[Medium.nX]=Medium.X_default "Mass fraction used to compute d_start"; parameter Modelica.Units.SI.Area A "Cross sectional area of flow channel"; Modelica.Units.SI.VolumeFlowRate V_flow "Volume flow rate from port_a to port_b"; Modelica.Blocks.Interfaces.RealOutput v(final quantity="Velocity", final unit="m/s") "Flow velocity from port_a to port_b"; protected Medium.Density dMed(start=d_start) "Medium temperature to which the sensor is exposed"; Medium.Density d_a_inflow(start=d_start) "Density of inflowing fluid at port_a"; Medium.Density d_b_inflow(start=d_start) "Density of inflowing fluid at port_b, or rho_a_inflow if uni-directional flow"; Medium.Density d(start=d_start) "Density of the passing fluid"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(d) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then d = d_start; end if; end if; equation if allowFlowReversal then d_a_inflow = Medium.density(state= Medium.setState_phX(p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); d_b_inflow = Medium.density(state= Medium.setState_phX(p=port_a.p, h=port_a.h_outflow, X=port_a.Xi_outflow)); dMed = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=d_a_inflow, y2=d_b_inflow, x_small=m_flow_small); else dMed = Medium.density(state=Medium.setState_phX( p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); d_a_inflow = dMed; d_b_inflow = dMed; end if; // Output signal of density sensor that is used to compute // the volume flow rate if dynamic then der(d) = (dMed-d)*k*tauInv; else d = dMed; end if; // Volume flow rate V_flow = port_a.m_flow/d; // Flow velocity v = V_flow / A; end Velocity;

Buildings.Fluid.Sensors.VolumeFlowRate

Ideal sensor for volume flow rate

Buildings.Fluid.Sensors.VolumeFlowRate

Information

This model outputs the volume flow rate flowing from port_a to port_b. The sensor is ideal, i.e., it does not influence the fluid. If the parameter tau is non-zero, then the measured density that is used to convert the mass flow rate into volumetric flow rate is computed using a first order differential equation. Setting tau=0 is not recommend. See Buildings.Fluid.Sensors.UsersGuide for an explanation.

Parameters

Type	Name	Default	Description
replaceable package Medium		PartialMedium	Medium in the component
Time	tau	0	Time constant at nominal flow rate (use tau=0 for steady-state sensor, but see user guide for potential problems) [s]
Nominal condition
MassFlowRate	m_flow_nominal		Nominal mass flow rate, used for regularization near zero flow [kg/s]
Initialization
Init	initType	Modelica.Blocks.Types.Init.I...	Type of initialization (InitialState and InitialOutput are identical)
Density	d_start	Medium.density(Medium.setSta...	Initial or guess value of density [kg/m3]
Temperature	T_start	Medium.T_default	Temperature used to compute d_start [K]
Pressure	p_start	Medium.p_default	Pressure used to compute d_start [Pa]
MassFraction	X_start[Medium.nX]	Medium.X_default	Mass fraction used to compute d_start [1]
Assumptions
Boolean	allowFlowReversal	true	= false to simplify equations, assuming, but not enforcing, no flow reversal
Advanced
MassFlowRate	m_flow_small	1E-4*m_flow_nominal	For bi-directional flow, temperature is regularized in the region \|m_flow\| < m_flow_small (m_flow_small > 0 required) [kg/s]

Connectors

Type	Name	Description
FluidPort_a	port_a	Fluid connector a (positive design flow direction is from port_a to port_b)
FluidPort_b	port_b	Fluid connector b (positive design flow direction is from port_a to port_b)
output RealOutput	V_flow	Volume flow rate from port_a to port_b [m3/s]

Modelica definition

model VolumeFlowRate "Ideal sensor for volume flow rate" extends Buildings.Fluid.Sensors.BaseClasses.PartialDynamicFlowSensor( tau=0); extends Modelica.Icons.RoundSensor; parameter Medium.Density d_start=Medium.density(Medium.setState_pTX(p_start, T_start, X_start)) "Initial or guess value of density"; parameter Modelica.Units.SI.Temperature T_start=Medium.T_default "Temperature used to compute d_start"; parameter Modelica.Units.SI.Pressure p_start=Medium.p_default "Pressure used to compute d_start"; parameter Modelica.Units.SI.MassFraction X_start[Medium.nX]=Medium.X_default "Mass fraction used to compute d_start"; Modelica.Blocks.Interfaces.RealOutput V_flow(final quantity="VolumeFlowRate", final unit="m3/s") "Volume flow rate from port_a to port_b"; protected Medium.Density dMed(start=d_start) "Medium temperature to which the sensor is exposed"; Medium.Density d_a_inflow(start=d_start) "Density of inflowing fluid at port_a"; Medium.Density d_b_inflow(start=d_start) "Density of inflowing fluid at port_b, or rho_a_inflow if uni-directional flow"; Medium.Density d(start=d_start) "Density of the passing fluid"; initial equation if dynamic then if initType == Modelica.Blocks.Types.Init.SteadyState then der(d) = 0; elseif initType == Modelica.Blocks.Types.Init.InitialState or initType == Modelica.Blocks.Types.Init.InitialOutput then d = d_start; end if; end if; equation if allowFlowReversal then d_a_inflow = Medium.density(state= Medium.setState_phX(p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); d_b_inflow = Medium.density(state= Medium.setState_phX(p=port_a.p, h=port_a.h_outflow, X=port_a.Xi_outflow)); dMed = Modelica.Fluid.Utilities.regStep( x=port_a.m_flow, y1=d_a_inflow, y2=d_b_inflow, x_small=m_flow_small); else dMed = Medium.density(state=Medium.setState_phX( p=port_b.p, h=port_b.h_outflow, X=port_b.Xi_outflow)); d_a_inflow = dMed; d_b_inflow = dMed; end if; // Output signal of density sensor that is used to compute // the volume flow rate if dynamic then der(d) = (dMed-d)*k*tauInv; else d = dMed; end if; // Volume flow rate V_flow = port_a.m_flow/d; end VolumeFlowRate;