lbl-srg · JayHuLBL · Nov 20, 2024 · Aug 26, 2024 · Aug 26, 2024 · Sep 2, 2024
diff --git a/Buildings/Fluid/AirFilters/BaseClasses/Characteristics/filtrationEfficiencyParameters.mo b/Buildings/Fluid/AirFilters/BaseClasses/Characteristics/filtrationEfficiencyParameters.mo
@@ -0,0 +1,27 @@
+within Buildings.Fluid.AirFilters.BaseClasses.Characteristics;
+record filtrationEfficiencyParameters
+  "Record for filtration efficiency vs. relative mass of the contaminant captured by the filter"
+  extends Modelica.Icons.Record;
+  parameter Real rat[:,:](each max=1, each min=0)
+    "Relative mass of the contaminant captured by the filter";
+  parameter Real eps[:,:](each max=1, each min=0)
+    "Filtration efficiency";
+
+  annotation (Documentation(info="<html>
+<p>
+Data record that describes the relative mass of the contaminant captured by the filter <code>rat</code> versus
+the filtration efficiency <code>eps</code>.
+The elements of the vector <code>rat</code> should be in ascending order, 
+i.e.,<code>rat[i] &lt; rat[i+1]</code>.
+Both vectors, <code>rat</code> and <code>eps</code>
+must have the same size.
+</p>
+</html>", revisions="<html>
+<ul>
+<li>
+June 27, 2023, by Sen Huang:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
+end filtrationEfficiencyParameters;
diff --git a/Buildings/Fluid/AirFilters/BaseClasses/Characteristics/package.mo b/Buildings/Fluid/AirFilters/BaseClasses/Characteristics/package.mo
@@ -0,0 +1,9 @@
+within Buildings.Fluid.AirFilters.BaseClasses;
+package Characteristics "Functions for filter characteristics"
+
+annotation (Documentation(info="<html>
+<p>
+This package implements performance curves for air filters.
+</p>
+</html>"));
+end Characteristics;
diff --git a/Buildings/Fluid/AirFilters/BaseClasses/Characteristics/package.order b/Buildings/Fluid/AirFilters/BaseClasses/Characteristics/package.order
@@ -0,0 +1 @@
+filtrationEfficiencyParameters
diff --git a/Buildings/Fluid/AirFilters/BaseClasses/Data/Generic.mo b/Buildings/Fluid/AirFilters/BaseClasses/Data/Generic.mo
@@ -0,0 +1,49 @@
+within Buildings.Fluid.AirFilters.BaseClasses.Data;
+record Generic "Generic data record for air filters"
+  extends Modelica.Icons.Record;
+  parameter Real mCon_nominal(
+    final unit = "kg")
+    "Maximum mass of the contaminant can be captured by the filter";
+  parameter String substanceName[:] = {"CO2"}
+    "Name of trace substance";
+  parameter
+    Buildings.Fluid.AirFilters.BaseClasses.Characteristics.filtrationEfficiencyParameters
+    filterationEfficiencyParameters
+    "Filtration efficiency vs. relative mass of the contaminant";
+  parameter Real b = 1.1
+    "Resistance coefficient";
+  annotation (
+  defaultComponentPrefixes = "parameter",
+  defaultComponentName = "per",
+  Documentation(revisions="<html>
+<ul>
+<li>
+June 27, 2023, by Sen Huang:<br/>
+First implementation.
+</li>
+</ul>
+</html>", info="<html>
+<p>
+Record containing performance parameters for air filters.
+</p>
+<p>
+It is used as a template of performance data
+for the variable-speed wheel models in
+<a href=\"modelica://Buildings.Fluid.AirFilters\">
+Buildings.Fluid.AirFilters</a>.
+</p>
+<p>
+The record contains one dataset: 
+relative mass of the contaminant
+(see <a href=\"modelica://Buildings.Fluid.AirFilters.BaseClasses.FiltrationEfficiency\">
+Buildings.Fluid.AirFilters.BaseClasses.FiltrationEfficiency</a>)
+versus filtration efficiency.
+</p>
+<p>
+It also contains a parameter that defines how the pressure drop
+changes by the relative mass of the contaminant
+(see <a href=\"modelica://Buildings.Fluid.AirFilters.BaseClasses.FlowCoefficientCorrection\">
+Buildings.Fluid.AirFilters.BaseClasses.FlowCoefficientCorrection</a>).
+</p>
+</html>"));
+end Generic;
diff --git a/Buildings/Fluid/AirFilters/BaseClasses/Data/package.mo b/Buildings/Fluid/AirFilters/BaseClasses/Data/package.mo
@@ -0,0 +1,10 @@
+within Buildings.Fluid.AirFilters.BaseClasses;
+package Data "Performance data for air filters"
+extends Modelica.Icons.MaterialPropertiesPackage;
+
+annotation (Documentation(info="<html>
+<p>
+This package contains data for air filters.
+</p>
+</html>"));
+end Data;
diff --git a/Buildings/Fluid/AirFilters/BaseClasses/Data/package.order b/Buildings/Fluid/AirFilters/BaseClasses/Data/package.order
@@ -0,0 +1 @@
+Generic
diff --git a/Buildings/Fluid/AirFilters/BaseClasses/FiltrationEfficiency.mo b/Buildings/Fluid/AirFilters/BaseClasses/FiltrationEfficiency.mo
@@ -1,37 +1,37 @@
 within Buildings.Fluid.AirFilters.BaseClasses;
 model FiltrationEfficiency
   "Component that calculates the filtration efficiency"
-  parameter Real mCon_nominal(
-    final unit="kg")
-    "Maximum mass of the contaminant can be captured by the filter";
-  parameter Real epsFun[:]
-    "Filtration efficiency curve";
+  parameter Buildings.Fluid.AirFilters.BaseClasses.Data.Generic per
+    "Record with performance data"
+    annotation (Placement(transformation(extent={{20,62},{40,82}})));
   Buildings.Controls.OBC.CDL.Interfaces.RealInput mCon(
     final unit="kg")
     "Mass of the contaminant captured by the filter"
     annotation (Placement(transformation(extent={{-140,-20},{-100,20}})));
-  Buildings.Controls.OBC.CDL.Interfaces.RealOutput y(
-    final unit="1",
-    final min=0,
-    final max=1)
-    "Filtration efficiency"
+  Buildings.Controls.OBC.CDL.Interfaces.RealOutput y[size(per.substanceName, 1)](
+    each final unit="1",
+    each final min=0,
+    each final max=1) "Filtration efficiency"
     annotation (Placement(transformation(extent={{100,-80},{140,-40}})));
   Buildings.Controls.OBC.CDL.Interfaces.RealOutput rat(
-    final unit="1",
-    final min=0,
-    final max=1)
+    each final unit="1",
+    each final min=0,
+    each final max=1)
     "Relative mass of the contaminant captured by the filter"
     annotation (Placement(transformation(extent={{100,40},{140,80}})));
-
 equation
-  rat = Buildings.Utilities.Math.Functions.smoothMin(x1=1, x2= mCon/mCon_nominal, deltaX=0.1);
-  y = Buildings.Utilities.Math.Functions.polynomial(a=epsFun, x=rat);
-  assert(
-    y > 0 and y < 1,
-    "In " + getInstanceName() + ": The filter efficiency has to be in the range of [0, 1], 
-    check the filter efficiency curve.",
-    level=AssertionLevel.error);
-
+  rat = Buildings.Utilities.Math.Functions.smoothMin(
+                x1=1,
+                x2= mCon/per.mCon_nominal,
+                deltaX=0.1)
+                "Calculate the relative mass of the contaminant captured by the filter";
+  for i in 1:size(per.substanceName, 1) loop
+     y[i] = Buildings.Utilities.Math.Functions.smoothInterpolation(
+                x=rat,
+                xSup=per.filterationEfficiencyParameters.rat[i],
+                ySup=per.filterationEfficiencyParameters.eps[i])
+                "Calculate the filtration efficiency";
+  end for;
 annotation (Icon(coordinateSystem(preserveAspectRatio=false), graphics={
           Rectangle(
           extent={{-100,100},{100,-100}},
@@ -46,13 +46,11 @@ annotation (Icon(coordinateSystem(preserveAspectRatio=false), graphics={
   defaultComponentName="eps",
 Documentation(info="<html>
 <p>
-This model calculates the filtration efficiency, <i>eps</i>, by
-</p>
-<p align=\"center\" style=\"font-style:italic;\">
-eps = epsFun<sub>1</sub> + epsFun<sub>2</sub>rat + epsFun<sub>3</sub> rat<sup>2</sup> + ...,
-</p>
-<p>
-where the coefficients <i>epsFun<sub>i</sub></i> are declared by the parameter <i>epsFun</i>;
+This model calculates the filtration efficiency, <i>eps</i>, based on the cubic hermite spline interpolation of
+the filter dataset (see 
+<a href=\"modelica://Buildings.Fluid.AirFilters.BaseClasses.Characteristics.filtrationEfficiencyParameters\">
+Buildings.Fluid.AirFilters.BaseClasses.Characteristics.filtrationEfficiencyParameters</a>)
+with respect to <i>rat</i>.
 </p>
 <p>
 The <i>rat</i> is the relative mass of the contaminant captured by the filter
@@ -62,7 +60,7 @@ and is calculated by
 rat =  mCon/mCon_nominal,
 </p>
 <p>
-where <i>mCon</i> is the mass of the contaminant captured by the filter,
+where <i>mCon</i> is the mass of the contaminant captured by the filter, and
 <i>mCon_nominal</i> is the maximum mass of the contaminant captured by the filter.
 </p>
 <P>

diff --git a/Buildings/Fluid/AirFilters/BaseClasses/FlowCoefficientCorrection.mo b/Buildings/Fluid/AirFilters/BaseClasses/FlowCoefficientCorrection.mo
@@ -1,26 +1,28 @@
 within Buildings.Fluid.AirFilters.BaseClasses;
 model FlowCoefficientCorrection
   "Component that calculates the flow coefficient correction factor"
-  parameter Real b
-    "Resistance coefficient";
+  parameter Buildings.Fluid.AirFilters.BaseClasses.Data.Generic per
+    "Record with performance data"
+    annotation (Placement(transformation(extent={{20,62},{40,82}})));
   Buildings.Controls.OBC.CDL.Interfaces.RealInput rat(
-    final unit="1",
-    final min=0,
-    final max=1)
+    each final unit="1",
+    each final min=0,
+    each final max=1)
     "Relative mass of the contaminant captured by the filter"
     annotation (Placement(transformation(extent={{-140,-20},{-100,20}})));
   Buildings.Controls.OBC.CDL.Interfaces.RealOutput y(
-    final unit="1",
-    final min=1)
+    each final unit="1",
+    each final min=1)
     "Flow coefficient correction"
     annotation (Placement(transformation(extent={{100,-20},{140,20}})));
-
 initial equation
-    assert(b > 1,
-      "In " + getInstanceName() + ": Resistance coefficient has to be greater than 1.",
-      level=AssertionLevel.error);
+  assert(per.b - 1.0 > 0.01,
+          "In " + getInstanceName() + ":The resistance coefficient should be larger
+          than 1",
+         level = AssertionLevel.error)
+         "Validate the resistance coefficient";
 equation
-  y = b^rat;
+  y = per.b^rat;
 
 annotation (defaultComponentName="coeCor",
   Icon(coordinateSystem(preserveAspectRatio=false), graphics={

diff --git a/Buildings/Fluid/AirFilters/BaseClasses/MassAccumulation.mo b/Buildings/Fluid/AirFilters/BaseClasses/MassAccumulation.mo
@@ -1,13 +1,17 @@
 within Buildings.Fluid.AirFilters.BaseClasses;
 model MassAccumulation
   "Component that mimics the accumulation of the contaminants"
-  parameter Real mCon_nominal
-    "Maximum mass of the contaminant captured by the filter";
+  parameter Integer nin(
+    min=1)=1
+    "Number of input connections";
+  parameter Buildings.Fluid.AirFilters.BaseClasses.Data.Generic per
+    "Record with performance dat"
+    annotation (Placement(transformation(extent={{20,62},{40,82}})));
   parameter Real mCon_reset(
     final min = 0)
     "Initial contaminant mass of the filter after replacement";
-  Buildings.Controls.OBC.CDL.Interfaces.RealInput mCon_flow(
-    final unit = "kg/s")
+  Buildings.Controls.OBC.CDL.Interfaces.RealInput mCon_flow[nin](
+    each final unit="kg/s")
     "Contaminant mass flow rate"
     annotation (Placement(transformation(extent={{-140,-20},{-100,20}})));
   Buildings.Controls.OBC.CDL.Interfaces.BooleanInput uRep
@@ -28,17 +32,17 @@ model MassAccumulation
     "Check if the filter is full"
     annotation (Placement(transformation(extent={{40,40},{60,60}})));
   Buildings.Controls.OBC.CDL.Reals.Sources.Constant con1(
-     final k=mCon_nominal)
+     final k=per.mCon_nominal)
     "Constant"
     annotation (Placement(transformation(extent={{-20,40},{0,60}})));
   Buildings.Controls.OBC.CDL.Utilities.Assert assMes(
     message="In " + getInstanceName() + ": The filter needs to be replaced.")
     "Warning message when the filter is full"
     annotation (Placement(transformation(extent={{72,40},{92,60}})));
+  Buildings.Controls.OBC.CDL.Reals.MultiSum mulSum(nin=nin) "Summation of the inputs"
+    annotation (Placement(transformation(extent={{-52,-10},{-32,10}})));
 
 equation
-  connect(intWitRes.u, mCon_flow)
-    annotation (Line(points={{-12,0},{-120,0}}, color={0,0,127}));
   connect(intWitRes.y, mCon)
     annotation (Line(points={{12,0},{120,0}}, color={0,0,127}));
   connect(con.y, intWitRes.y_reset_in)
@@ -51,7 +55,10 @@ equation
     annotation (Line(points={{38,42},{20,42},{20,0},{12,0}}, color={0,0,127}));
   connect(con1.y, greater.u1)
     annotation (Line(points={{2,50},{38,50}}, color={0,0,127}));
-
+  connect(mulSum.y, intWitRes.u)
+    annotation (Line(points={{-30,0},{-12,0}}, color={0,0,127}));
+  connect(mulSum.u, mCon_flow)
+    annotation (Line(points={{-54,0},{-120,0}}, color={0,0,127}));
 annotation (defaultComponentName="masAcc",
   Icon(coordinateSystem(preserveAspectRatio=false), graphics={
      Rectangle(extent={{-100,100},{100,-100}}, lineColor={28,108,200},

diff --git a/Buildings/Fluid/AirFilters/BaseClasses/MassTransfer.mo b/Buildings/Fluid/AirFilters/BaseClasses/MassTransfer.mo
@@ -2,25 +2,75 @@ within Buildings.Fluid.AirFilters.BaseClasses;
 model MassTransfer
   "Component that sets the trace substance at port_b based on an input trace substance mass flow rate and an input mass transfer efficiency"
   extends Buildings.Fluid.Interfaces.PartialTwoPortInterface;
-  Buildings.Controls.OBC.CDL.Interfaces.RealInput C_inflow[Medium.nC]
-    "Input trace substance rate"
-    annotation (Placement(transformation(extent={{-20,-20},{20,20}},
-      rotation=-90, origin={0,120})));
-  Buildings.Controls.OBC.CDL.Interfaces.RealInput eps(
-    final unit = "1",
-    final min = 0,
-    final max= 1)
+  parameter String substanceName[:] = {"CO2"}
+    "Name of trace substance";
+  Buildings.Controls.OBC.CDL.Interfaces.RealInput eps[size(substanceName,1)](
+    each final unit = "1",
+    each final min = 0,
+    each final max= 1)
     "Mass transfer coefficient"
     annotation (Placement(transformation(extent={{-140,40},{-100,80}})));
+  Buildings.Controls.OBC.CDL.Interfaces.RealOutput mCon_flow[size(substanceName,1)](
+    each final unit = "kg/s")
+    "Contaminant mass flow rate"
+    annotation (Placement(transformation(extent={{100,40},{140,80}})));
+
+protected
+  parameter Real s1[:,:]= {
+    {if (Modelica.Utilities.Strings.isEqual(string1=Medium.extraPropertiesNames[i],
+                                            string2=substanceName[j],
+                                            caseSensitive=false))
+    then 1 else 0 for i in 1:Medium.nC}
+    for j in 1:size(substanceName,1)}
+    "Vector to check if the trace substances are included in the medium"
+    annotation(Evaluate=true);
+  parameter Real s2[:,:]= {
+    {if (Modelica.Utilities.Strings.isEqual(string1=Medium.extraPropertiesNames[i],
+                                            string2=substanceName[j],
+                                            caseSensitive=false))
+    then 1 else 0 for i in 1:size(substanceName,1)}
+    for j in 1:Medium.nC}
+    "Vector to check if the trace substances in the medium are included in the performance dataset"
+    annotation(Evaluate=true);
+initial equation
+  assert(abs(sum(s1) - size(substanceName,1)) < 0.1,
+         "In " + getInstanceName() + ":Some specified trace substances are 
+         not present in medium '" + Medium.mediumName + "'.\n"
+         + "Check filter parameter and medium model.",
+         level = AssertionLevel.warning)
+         "Check if all the specified substances are included in the medium";
 
 equation
-  if allowFlowReversal then
-    port_b.C_outflow =inStream(port_a.C_outflow) - eps*C_inflow;
-    port_a.C_outflow = inStream(port_a.C_outflow);
-  else
-    port_b.C_outflow = inStream(port_a.C_outflow);
-    port_a.C_outflow = inStream(port_b.C_outflow);
-  end if;
+  // Modify the substances individually.
+  for i in 1:Medium.nC loop
+      if max(s2[i]) > 0.9 then
+        for j in 1:size(substanceName,1) loop
+            if (Modelica.Utilities.Strings.isEqual(string1=Medium.extraPropertiesNames[i],
+                                              string2=substanceName[j],
+                                              caseSensitive=false)) then
+                port_b.C_outflow[i] =inStream(port_a.C_outflow[i])*(1 - eps[j]);
+                port_a.C_outflow[i] = inStream(port_a.C_outflow[i]);
+            end if;
+        end for;
+      else
+        port_b.C_outflow[i] = inStream(port_a.C_outflow[i]);
+        port_a.C_outflow[i] = inStream(port_b.C_outflow[i]);
+      end if;
+  end for;
+  // Calculate the amount of removed contaminants.
+  for i in 1:size(substanceName,1) loop
+      if max(s1[i]) > 0.9 then
+        for j in 1:Medium.nC loop
+            if (Modelica.Utilities.Strings.isEqual(string1=Medium.extraPropertiesNames[j],
+                                              string2=substanceName[i],
+                                              caseSensitive=false)) then
+                mCon_flow[i] = inStream(port_a.C_outflow[j])* eps[i];
+            end if;
+        end for;
+      else
+        mCon_flow[i] = 0;
+      end if;
+  end for;
   // Mass balance (no storage).
   port_a.Xi_outflow = inStream(port_b.Xi_outflow);
   port_b.Xi_outflow = inStream(port_a.Xi_outflow);
@@ -55,9 +105,7 @@ where <code>eps</code> is an input mass transfer efficiency and
 <code>C_inflow</code> is an input trace substance rate.
 </p>
 <p>
-This model has no pressure drop. In the case of reverse flow,
-the fluid that leaves <code>port_a</code> has the same
-properties as the fluid that enters <code>port_b</code>.
+This model has no pressure drop.
 </p>
 </html>", revisions="<html>
 <ul>

diff --git a/Buildings/Fluid/AirFilters/BaseClasses/PressureDropWithVaryingFlowCoefficient.mo b/Buildings/Fluid/AirFilters/BaseClasses/PressureDropWithVaryingFlowCoefficient.mo
@@ -82,7 +82,7 @@ This block is implemented based on
 <a href=\"modelica://Buildings.Fluid.FixedResistances.PressureDrop\">
 Buildings.Fluid.FixedResistances.PressureDrop</a>
 and inherits most of its configuration.
-However, it is different when calculating the mass flow rate
+However, its mass flow rate is calculated differently by
 </p>
 <p align=\"center\" style=\"font-style:italic;\">
 m&#775; = m_flow_nominal/(&radic;<span style=\"text-decoration:overline;\">dp_nominal*kCor</span>)