Buildings.Fluid.FMI.Interfaces

Package with interfaces for models that serves as an FMU container

Information

This package contains connectors that are used to export fluid flow models as Functional Mockup Units.

The connectors Buildings.Fluid.FMI.Interfaces.Inlet and Buildings.Fluid.FMI.Interfaces.Outlet are hierarchical. This was done for the exported FMUs to have hierarchical names for their input and output signals.

Extends from Modelica.Icons.InterfacesPackage (Icon for packages containing interfaces).

Package Content

Name	Description
FluidProperties	Type definition for fluid properties
Inlet	Connector for fluid inlet
MassFractionConnector	Connector for mass fraction of water vapor per kg total mass
Outlet	Connector for fluid outlet
PressureInput	Connector for pressure input
PressureOutput	Connector for pressure output

Buildings.Fluid.FMI.Interfaces.FluidProperties

Type definition for fluid properties

Information

This is a connector that declares the following fluid properties:

The temperature T.
The mass fraction of water vapor X_w per kg of total air, unless Medium.nXi=0. Note that the mass fraction is not per kg of dry air, but rather per kg of total air as is customary in Modelica.
The trace substances C, unless Medium.nC=0.

These quantities are used in the connectors Buildings.Fluid.FMI.Interfaces.Inlet and Buildings.Fluid.FMI.Interfaces.Outlet.

Note that none of these quantities is declared to be an input or output, because the role is reversed whether the properties are in inlet or outlet connector.

Parameters

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

Type	Name	Description
replaceable package Medium		Medium in the component
Temperature	T	Temperature [K]
MassFractionConnector	X_w	Water vapor mass fractions per kg total air [1]
ExtraProperty	C[Medium.nC]	Properties c_i/m

Modelica definition

connector FluidProperties "Type definition for fluid properties" replaceable package Medium = Modelica.Media.Interfaces.PartialMedium "Medium in the component"; Medium.Temperature T "Temperature"; Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w if Medium.nXi > 0 "Water vapor mass fractions per kg total air"; Medium.ExtraProperty C[Medium.nC] "Properties c_i/m"; end FluidProperties;

Buildings.Fluid.FMI.Interfaces.Inlet

Connector for fluid inlet

Information

This is a connector for a fluid inlet. The connector takes as an input the following quantities:

The mass flow rate m_flow.
The pressure p, unless use_p_in=false.
The temperature of the inflowing fluid forward.T, e.g., the temperature of the fluid that streams out of the component if m_flow > 0.
The mass fraction of the inflowing fluid forward.Xi, unless Medium.nXi=0.
The trace substances of the inflowing fluid forward.C, unless Medium.nC=0.

If allowFlowReversal = true, the connector also outputs the following quantities.

The temperature of the outflowing fluid backward.T, e.g., if m_flow ≤ 0.
The mass fraction of the outflowing fluid backward.Xi, unless Medium.nXi=0.
The trace substances of the outflowing fluid backward.C, unless Medium.nC=0.

If allowFlowReversal = false, then these outputs are not present.

Parameters

Type	Name	Default	Description
replaceable package Medium		Modelica.Media.Interfaces.Pa...	Medium in the component
Boolean	use_p_in	true	= true to use a pressure from connector, false to output Medium.p_default
Assumptions
Boolean	allowFlowReversal	true	= true to allow flow reversal, false restricts to design direction (inlet -> outlet)

Type	Name	Description
replaceable package Medium		Medium in the component
Boolean	use_p_in	= true to use a pressure from connector, false to output Medium.p_default
input MassFlowRate	m_flow	Mass flow rate from the connection point into the component [kg/s]
input PressureInput	p	Thermodynamic pressure in the connection point [Pa]
input FluidProperties	forward	Inflowing properties
output FluidProperties	backward	Outflowing properties
Assumptions
Boolean	allowFlowReversal	= true to allow flow reversal, false restricts to design direction (inlet -> outlet)

Modelica definition

connector Inlet "Connector for fluid inlet" replaceable package Medium = Modelica.Media.Interfaces.PartialMedium "Medium in the component"; parameter Boolean use_p_in = true "= true to use a pressure from connector, false to output Medium.p_default"; parameter Boolean allowFlowReversal = true "= true to allow flow reversal, false restricts to design direction (inlet -> outlet)"; input Medium.MassFlowRate m_flow "Mass flow rate from the connection point into the component"; Buildings.Fluid.FMI.Interfaces.PressureInput p if use_p_in "Thermodynamic pressure in the connection point"; input Buildings.Fluid.FMI.Interfaces.FluidProperties forward( redeclare final package Medium = Medium) "Inflowing properties"; output Buildings.Fluid.FMI.Interfaces.FluidProperties backward( redeclare final package Medium = Medium) if allowFlowReversal "Outflowing properties"; end Inlet;

Buildings.Fluid.FMI.Interfaces.MassFractionConnector

Connector for mass fraction of water vapor per kg total mass

Buildings.Fluid.FMI.Interfaces.MassFractionConnector

Information

Connector with variable of type Modelica.SIunits.MassFraction. Note that the mass fraction is in kg water vapor per total mass of air, rathern than per kg of dry air.

This connector has been implemented to conditionally remove the mass fraction if the medium has only one species. While this could have been done using a vector of mass fractions with zero length, as is used in fluid connectors, this implemantation uses a scalar to avoid vectorized inputs and outputs of FMUs.

Extends from Modelica.SIunits.MassFraction.

Modelica definition

connector MassFractionConnector = Modelica.SIunits.MassFraction "Connector for mass fraction of water vapor per kg total mass";

Buildings.Fluid.FMI.Interfaces.Outlet

Connector for fluid outlet

Information

This is a connector for a fluid outlet. The connector produces as an output the following quantities:

The mass flow rate m_flow.
The pressure p, unless use_p_in=false.
The temperature of the inflowing fluid forward.T, e.g., the temperature of the fluid that streams out of the component if m_flow > 0.
The mass fraction of the inflowing fluid forward.Xi, unless Medium.nXi=0.
The trace substances of the inflowing fluid forward.C, unless Medium.nC=0.

If allowFlowReversal = true, the connector requires as input the following quantities.

The temperature of the outflowing fluid backward.T, e.g., if m_flow ≤ 0.
The mass fraction of the outflowing fluid backward.Xi, unless Medium.nXi=0.
The trace substances of the outflowing fluid backward.C, unless Medium.nC=0.

If allowFlowReversal = false, then these inputs are not present and hence not required to be provided.

Parameters

Type	Name	Default	Description
replaceable package Medium		Modelica.Media.Interfaces.Pa...	Medium in the component
Boolean	use_p_in	true	= true to use pressure connector, false to remove it
Assumptions
Boolean	allowFlowReversal	true	= true to allow flow reversal, false restricts to design direction (inlet -> outlet)

Type	Name	Description
replaceable package Medium		Medium in the component
Boolean	use_p_in	= true to use pressure connector, false to remove it
output MassFlowRate	m_flow	Mass flow rate from the connection point into the component [kg/s]
output PressureOutput	p	Thermodynamic pressure in the connection point [Pa]
input FluidProperties	backward	Inflowing properties
output FluidProperties	forward	Outflowing properties
Assumptions
Boolean	allowFlowReversal	= true to allow flow reversal, false restricts to design direction (inlet -> outlet)

Modelica definition

connector Outlet "Connector for fluid outlet" replaceable package Medium = Modelica.Media.Interfaces.PartialMedium "Medium in the component"; parameter Boolean use_p_in = true "= true to use pressure connector, false to remove it"; parameter Boolean allowFlowReversal = true "= true to allow flow reversal, false restricts to design direction (inlet -> outlet)"; output Medium.MassFlowRate m_flow "Mass flow rate from the connection point into the component"; Buildings.Fluid.FMI.Interfaces.PressureOutput p if use_p_in "Thermodynamic pressure in the connection point"; input Buildings.Fluid.FMI.Interfaces.FluidProperties backward( redeclare final package Medium = Medium) if allowFlowReversal "Inflowing properties"; output Buildings.Fluid.FMI.Interfaces.FluidProperties forward( redeclare final package Medium = Medium) "Outflowing properties"; end Outlet;

Buildings.Fluid.FMI.Interfaces.PressureInput

Connector for pressure input

Buildings.Fluid.FMI.Interfaces.PressureInput

Information

Connector with one input signal of type Modelica.SIunits.AbsolutePressure. This connector has been implemented to conditionally remove the pressure if no pressure drop calculation is requested.

Extends from Modelica.SIunits.AbsolutePressure.

Parameters

Type	Name	Default	Description
Custom Parameters
	displayUnit	"Pa"

Modelica definition

connector PressureInput = input Modelica.SIunits.AbsolutePressure(displayUnit="Pa") "Connector for pressure input";

Buildings.Fluid.FMI.Interfaces.PressureOutput

Connector for pressure output

Buildings.Fluid.FMI.Interfaces.PressureOutput

Information

Connector with one output signal of type Modelica.SIunits.AbsolutePressure. This connector has been implemented to conditionally remove the pressure if no pressure drop calculation is requested.

Extends from Modelica.SIunits.AbsolutePressure.

Parameters

Type	Name	Default	Description
Custom Parameters
	displayUnit	"Pa"

Modelica definition

connector PressureOutput = output Modelica.SIunits.AbsolutePressure(displayUnit="Pa") "Connector for pressure output";

Buildings.Fluid.FMI.Interfaces

Information

Package Content

Buildings.Fluid.FMI.Interfaces.FluidProperties

Information

Parameters

Contents

Modelica definition

Buildings.Fluid.FMI.Interfaces.Inlet

Information

Parameters

Contents

Modelica definition

Buildings.Fluid.FMI.Interfaces.MassFractionConnector

Information

Modelica definition

Buildings.Fluid.FMI.Interfaces.Outlet

Information

Parameters

Contents

Modelica definition

Buildings.Fluid.FMI.Interfaces.PressureInput

Information

Parameters

Modelica definition

Buildings.Fluid.FMI.Interfaces.PressureOutput

Information

Parameters

Modelica definition