Flowmodel in sensor (#383)

* add flow model in base sensor

* adapt sensors to flow model

* update unit tests

* make sure Metroscopia run correctly

* update changelog

* PEP comments

Author: valentind-met

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 ### Changed
+- Sensors now contain a flow model to ease convergence [PR#383](https://github.com/Metroscope-dev/metroscope-modeling-library/pull/383)
 
 ### Fixed
 

MetroscopeModelingLibrary/Examples/Nuclear/MetroscopiaNPP/MetroscopiaNPP_internal_ramp_direct_withStartValues.mo

@@ -479,10 +479,6 @@ Kth_0(start=5000.0),
 NTU(start=1.6153173),
 QCpMAX(start=10000000000.0),
 QCpMIN(start=6346345.0),
-Q_cold(start=1500.0),
-Q_cold_0(start=1500.0),
-Q_hot(start=386.7695),
-Q_hot_0(start=387.0),
 S(start=70.0),
 S_0(start=100.0),
 T_cold_in(start=392.286),
@@ -503,10 +499,6 @@ Kth_0(start=5000.0),
 NTU(start=3.0310464),
 QCpMAX(start=6274835.0),
 QCpMIN(start=1828982.4),
-Q_cold(start=1500.0),
-Q_cold_0(start=1500.0),
-Q_hot(start=386.7695),
-Q_hot_0(start=387.0),
 S(start=30.0),
 S_0(start=100.0),
 T_cold_in(start=353.16913),
@@ -1384,10 +1376,6 @@ Kth_0(start=5000.0),
 NTU(start=0.26206133),
 QCpMAX(start=10000000000.0),
 QCpMIN(start=4426917.5),
-Q_cold(start=1059.745),
-Q_cold_0(start=1060.0),
-Q_hot(start=55.557785),
-Q_hot_0(start=55.0),
 S(start=100.0),
 S_0(start=100.0),
 T_cold_in(start=312.17142),
@@ -1964,10 +1952,6 @@ P_offset(start=0.0),
 P_tot(start=6980.0),
 Psat(start=6980.0),
 Psat_0(start=6980.0),
-Q_cold(start=54232.63),
-Q_cold_0(start=54000.0),
-Q_hot(start=1059.745),
-Q_hot_0(start=1000.0),
 Qv_cold_in(start=54.332294),
 R(start=8.314463),
 S(start=100.0),
@@ -2847,10 +2831,6 @@ Kth_0(start=5000.0),
 NTU(start=0.51276803),
 QCpMAX(start=10000000000.0),
 QCpMIN(start=3353037.2),
-Q_cold(start=1059.745),
-Q_cold_0(start=1059.0),
-Q_hot(start=43.318386),
-Q_hot_0(start=44.0),
 S(start=100.0),
 S_0(start=100.0),
 T_cold_in(start=484.00034),
@@ -2867,10 +2847,6 @@ P_cold_in_0(start=1940000.0),
 P_cold_out_0(start=1940000.0),
 P_hot_in_0(start=4100000.0),
 P_hot_out_0(start=4000000.0),
-Q_cold(start=1059.745),
-Q_cold_0(start=1059.0),
-Q_hot(start=44.318386),
-Q_hot_0(start=44.0),
 Q_vent(start=1.0),
 Q_vent_0(start=1.0),
 S(start=100.0),

MetroscopeModelingLibrary/FlueGases/Connectors/package.mo

@@ -2,6 +2,7 @@ within MetroscopeModelingLibrary.FlueGases;
 package Connectors
   extends MetroscopeModelingLibrary.Utilities.Icons.PackageIcon;
 
+
   annotation (Icon(graphics={
         Rectangle(
           extent={{20,30},{78,-28}},
@@ -19,5 +20,4 @@ package Connectors
           lineThickness=1,
           fillColor={255,255,255},
           fillPattern=FillPattern.Solid)}));
-
 end Connectors;

MetroscopeModelingLibrary/Partial/BaseClasses/IsoPHFlowModel.mo

@@ -11,11 +11,13 @@ partial model IsoPHFlowModel "FlowModel with no pressure or enthalpy variations"
   // Input Quantities
   Units.SpecificEnthalpy h(start=h_0) "Enthalpy of the fluid into the component";
   Units.Pressure P(start=P_0) "Pressure of the fluid into the component";
+  Units.Temperature T(start=T_0) "Temperature of the fluid into the component";
 
 equation
   // Input Quantities
   P = P_in;
   h = h_in;
+  T = T_in;
 
   // Conservation equation
   DP = 0;

MetroscopeModelingLibrary/Partial/Sensors/BaseSensor.mo

@@ -9,19 +9,20 @@ partial model BaseSensor
   parameter Units.PositiveMassFlowRate Q_0=100;
   parameter Units.Pressure P_0 = 1e5;
   parameter Units.SpecificEnthalpy h_0 = 5e5;
-  Medium.ThermodynamicState state;
 
   // Input Quantity
   Units.PositiveMassFlowRate Q(start=Q_0, nominal=Q_0) "Component mass flow rate";
   Units.MassFraction Xi[Medium.nXi] "Component mass fractions";
   Units.Pressure P(start=P_0) "Pressure of the fluid into the component";
   Units.SpecificEnthalpy h(start=h_0) "Enthalpy of the fluid into the component";
+  Medium.ThermodynamicState state;
 
   // Failure modes
   parameter Boolean faulty_flow_rate = false;
   Units.MassFlowRate mass_flow_rate_bias(start=0); // mass_flow_rate_bias > 0 means that more mass flow enters the component
   replaceable Connectors.FluidInlet C_in(Q(start=Q_0, nominal=Q_0), P(start=P_0, nominal=P_0), redeclare package Medium = Medium) annotation (Placement(transformation(extent={{-110,-10},{-90,10}})));
   replaceable Connectors.FluidOutlet C_out(Q(start=-Q_0, nominal=Q_0), P(start=P_0, nominal=P_0), redeclare package Medium = Medium) annotation (Placement(transformation(extent={{90,-10},{110,10}})));
+  replaceable BaseClasses.IsoPHFlowModel flow_model annotation (Placement(transformation(extent={{-10,-10},{10,10}})));
 equation
   if not faulty_flow_rate then
     mass_flow_rate_bias = 0;
@@ -35,6 +36,7 @@ equation
   state = Medium.setState_phX(P, h, Xi);
 
   assert(Q > 0, "Wrong flow sign in inline sensor. Common causes : outlet connected as if it was inlet and vice versa, or Positive/NegativeMassflowrate misuse. Recall : inlet flow is positive, outlet is negatve", AssertionLevel.warning);
-  connect(C_in, C_out) annotation (Line(points={{-100,0},{100,0}}, color={95,95,95}));
+  connect(flow_model.C_in, C_in) annotation (Line(points={{-10,0},{-100,0}}, color={95,95,95}));
+  connect(flow_model.C_out, C_out) annotation (Line(points={{10,0},{100,0}}, color={0,0,0}));
   annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(coordinateSystem(preserveAspectRatio=false)));
 end BaseSensor;

MetroscopeModelingLibrary/Partial/Sensors/TemperatureSensor.mo

@@ -16,7 +16,7 @@ partial model TemperatureSensor
               start=(T_0 +Constants.T0_degC_in_K) *Constants.degC_to_degF +Constants.T0_degC_in_degF,
               nominal=(T_0 +Constants.T0_degC_in_K) *Constants.degC_to_degF +Constants.T0_degC_in_degF);   // Temperature in degF
 equation
-  T = Medium.temperature(state);
+  T =flow_model.T;
   T_degC +Constants.T0_degC_in_K  = T; // Conversion K to Celsius
   T_degF = T_degC*Constants.degC_to_degF +Constants.T0_degC_in_degF;   // Conversion Celsius to Farenheit
 end TemperatureSensor;

MetroscopeModelingLibrary/Power/Connectors/package.mo

@@ -2,6 +2,7 @@ within MetroscopeModelingLibrary.Power;
 package Connectors
   extends MetroscopeModelingLibrary.Utilities.Icons.PackageIcon;
 
+
   annotation (Icon(graphics={
         Rectangle(
           extent={{20,30},{78,-28}},
@@ -19,5 +20,4 @@ package Connectors
           lineThickness=1,
           fillColor={255,255,255},
           fillPattern=FillPattern.Solid)}));
-
 end Connectors;

MetroscopeModelingLibrary/Sensors/FlueGases/FlowSensor.mo

@@ -7,5 +7,6 @@ model FlowSensor
   extends Partial.Sensors.FlowSensor(
     redeclare MetroscopeModelingLibrary.FlueGases.Connectors.Inlet C_in,
     redeclare MetroscopeModelingLibrary.FlueGases.Connectors.Outlet C_out,
+    redeclare MetroscopeModelingLibrary.FlueGases.BaseClasses.IsoPHFlowModel flow_model,
     redeclare package Medium = FlueGasesMedium) annotation (IconMap(primitivesVisible=false));
 end FlowSensor;

MetroscopeModelingLibrary/Sensors/FlueGases/PressureSensor.mo

@@ -7,5 +7,6 @@ model PressureSensor
   extends Partial.Sensors.PressureSensor(
     redeclare MetroscopeModelingLibrary.FlueGases.Connectors.Inlet C_in,
     redeclare MetroscopeModelingLibrary.FlueGases.Connectors.Outlet C_out,
+    redeclare MetroscopeModelingLibrary.FlueGases.BaseClasses.IsoPHFlowModel flow_model,
     redeclare package Medium = FlueGasesMedium) annotation (IconMap(primitivesVisible=false));
 end PressureSensor;

MetroscopeModelingLibrary/Sensors/FlueGases/TemperatureSensor.mo

@@ -7,5 +7,6 @@ model TemperatureSensor
   extends Partial.Sensors.TemperatureSensor(
     redeclare MetroscopeModelingLibrary.FlueGases.Connectors.Inlet C_in,
     redeclare MetroscopeModelingLibrary.FlueGases.Connectors.Outlet C_out,
+    redeclare MetroscopeModelingLibrary.FlueGases.BaseClasses.IsoPHFlowModel flow_model,
     redeclare package Medium = FlueGasesMedium) annotation (IconMap(primitivesVisible=false));
 end TemperatureSensor;