Package with interfaces for models that serves as an FMU container
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).
| Name | Description |
|---|---|
 FluidProperties
|
Type definition for fluid properties |
 Inlet
|
Connector for fluid inlet |
 MassFractionConnector
|
Mass fraction of water vapor per kg total mass as a connector |
 Outlet
|
Connector for fluid outlet |
 PressureInput
|
Input pressure as a connector |
 PressureOutput
|
Output pressure as a connector |
Type definition for fluid properties
This is a connector that declares the following fluid properties:
T.
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.
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.
| Type | Name | Default | Description |
|---|---|---|---|
| replaceable package Medium | Modelica.Media.Interfaces.Pa... | Medium model | |
| Type | Name | Description |
|---|---|---|
| replaceable package Medium | Medium model | |
| Temperature | T | Temperature [K] |
| MassFractionConnector | X_w | Water vapor mass fractions per kg total air [1] |
| ExtraProperty | C[Medium.nC] | Properties c_i/m |
Buildings.Fluid.FMI.Interfaces.InletConnector for fluid inlet
This is a connector for a fluid inlet. The connector takes as an input the following quantities:
m_flow.
p,
unless use_p_in=false.
forward.T,
e.g., the temperature of the fluid that streams out of the component if m_flow > 0.
forward.Xi,
unless Medium.nXi=0.
forward.C,
unless Medium.nC=0.
If allowFlowReversal = true,
the connector also outputs the following quantities.
backward.T,
e.g., if m_flow ≤ 0.
backward.Xi,
unless Medium.nXi=0.
backward.C,
unless Medium.nC=0.
If allowFlowReversal = false, then these outputs are not present.
| Type | Name | Default | Description |
|---|---|---|---|
| replaceable package Medium | Modelica.Media.Interfaces.Pa... | Medium model | |
| 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 model | |
| 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) |
Mass fraction of water vapor per kg total mass as a connector
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.
Buildings.Fluid.FMI.Interfaces.OutletConnector for fluid outlet
This is a connector for a fluid outlet. The connector produces as an output the following quantities:
m_flow.
p,
unless use_p_in=false.
forward.T,
e.g., the temperature of the fluid that streams out of the component if m_flow > 0.
forward.Xi,
unless Medium.nXi=0.
forward.C,
unless Medium.nC=0.
If allowFlowReversal = true,
the connector requires as input the following quantities.
backward.T,
e.g., if m_flow ≤ 0.
backward.Xi,
unless Medium.nXi=0.
backward.C,
unless Medium.nC=0.
If allowFlowReversal = false, then these inputs are not present
and hence not required to be provided.
| Type | Name | Default | Description |
|---|---|---|---|
| replaceable package Medium | Modelica.Media.Interfaces.Pa... | Medium model | |
| 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 model | |
| Boolean | use_p_in | = true to use a pressure from connector, false to output Medium.p_default |
| 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) |
Buildings.Fluid.FMI.Interfaces.PressureInput
Input pressure as a connector
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.
| Type | Name | Default | Description |
|---|---|---|---|
| displayUnit | "Pa" |
Buildings.Fluid.FMI.Interfaces.PressureOutput
Output pressure as a connector
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.
| Type | Name | Default | Description |
|---|---|---|---|
| displayUnit | "Pa" |