Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Annotation and documentation changes after review #1396

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion IDEAS/Airflow/Multizone/BaseClasses/DoorDiscretized.mo
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ revisions="<html>
<ul>
<li>
October 29, 2024, by Klaas De Jonge:<br/>
Unprotected <code>dh</code> and changed prefixes of <code>dh</code>,<code>hAg</code> and <code>hBg</code> to <code>input</code>.This is for <a href=\\\"https://github.com/ibpsa/modelica-ibpsa/issues/1935\\\">#1935</a>.
Unprotected <code>dh</code> and changed prefixes of <code>dh</code>,<code>hAg</code> and <code>hBg</code> to <code>input</code>. This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1935\">#1935</a>.
</li>
<li>
January 8, 2019, by Michael Wetter:<br/>
Expand Down
18 changes: 9 additions & 9 deletions IDEAS/Airflow/Multizone/CrackOrOperableDoor.mo
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ model CrackOrOperableDoor
if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts "Pressure difference where laminar and turbulent flow relation coincide for large cavities";
parameter Modelica.Units.SI.MassFlowRate MFtrans=(hOpe*wOpe)*VItrans*REtrans/DOpe if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts "Recommended massflowrate used for reguralisation";
parameter Modelica.Units.SI.Length DOpe=4*hOpe*wOpe/(2*hOpe+2*wOpe) if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts "Estimated hydraulic diameter of the opening - 4*A/Perimeter";
constant Real REtrans=30 if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts "assumed reynoldsnumber at transition";
constant Real VItrans(unit="kg/(m.s)")=0.0000181625 if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts "assumed viscosity of air at transition";
constant Modelica.Units.SI.ReynoldsNumber REtrans=30 if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts "Assumed Reynolds number at transition";
constant Modelica.Units.SI.DynamicViscosity VItrans(unit="kg/(m.s)")=0.0000181625 if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts "Assumed dynamic viscosity of air at transition";

final parameter Medium.ThermodynamicState state_default=Medium.setState_pTX(
T=Medium.T_default,
Expand Down Expand Up @@ -130,29 +130,29 @@ model CrackOrOperableDoor
IDEAS.Airflow.Multizone.Point_m_flow point_m_flow2(
redeclare package Medium = Medium,
dpMea_nominal = dpCloRat,
forceErrorControlOnFlow=true,
forceErrorControlOnFlow=true,
m = mClo,
mMea_flow_nominal = (q50/3600*rho_default)*A_q50*0.5,
useDefaultProperties = false) if not useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts "Pressure drop equation" annotation (
Placement(visible = true, transformation(origin = {0, -60}, extent = {{-10, -10}, {10, 10}}, rotation = 0)));
IDEAS.Airflow.Multizone.DoorDiscretizedOperable doo(
final dh=doo.hOpe*sin(inc)/nCom,
redeclare package Medium = Medium,
final hA=hA,
final hB=hB,
dp_turbulent=dp_turbulent_ope,
final hA=hA,
final hB=hB,
dp_turbulent=dp_turbulent_ope,
nCom=nCom,
CDOpe=CDOpe,
CDClo=CDCloRat,
CDClo=CDCloRat,
mOpe=mOpe,
mClo=mClo,
CDCloRat=CDCloRat,
wOpe=wOpe,
hOpe=hOpe,
dpCloRat=dpCloRat,
LClo=LClo,
vZer=vZer*MFtrans*rho_default)
if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts annotation (
vZer=vZer*MFtrans*rho_default)
if useDoor and interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts annotation (
Placement(visible = true, transformation(origin={-2,0}, extent = {{-10, -10}, {10, 10}}, rotation = 0)));
IDEAS.Fluid.Sources.Boundary_pT bou(
redeclare package Medium = Medium,
Expand Down
4 changes: 1 addition & 3 deletions IDEAS/Airflow/Multizone/Examples/TrickleVentIDEAS.mo
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@ This model illustrates the use of the models
IDEAS.Airflow.Multizone.Table_V_flow</a>,
which is an analytic alternative to the table implementation of
<a href=\"modelica://IDEAS.Airflow.Multizone.Table_m_flow\">
IDEAS.Airflow.Multizone.Table_m_flow</a> for

modelling self regulating inlet vents.
IDEAS.Airflow.Multizone.Table_m_flow</a> for modelling self regulating inlet vents.
</p>
</html>", revisions="<html>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions IDEAS/Airflow/Multizone/Validation/LargeHorizontalOpening.mo
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ model LargeHorizontalOpening
annotation (Placement(transformation(extent={{4,14},{-16,34}})));
Modelica.Blocks.Math.Sum MF_Orifice(nin=1, k={3600})
annotation (Placement(transformation(extent={{-180,28},{-200,48}})));
Real OpeningflowDiff(unit="kg/s")=abs(MF_Doormodel.y)-abs(MF_Orifice.y);
Modelica.Units.SI.MassFlowRate OpeningflowDiff(unit="kg/s")=abs(MF_Doormodel.y)-abs(MF_Orifice.y);

protected
Fluid.Sensors.MassFlowRate MFsensor_Orifice(
Expand Down Expand Up @@ -110,7 +110,7 @@ protected
extent={{-10,-10},{10,10}},
rotation=0,
origin={50,116})));
Modelica.Thermal.HeatTransfer.Celsius.FixedTemperature fixedTemperature(T=20)
Modelica.Thermal.HeatTransfer.Sources.FixedTemperature fixedTemperature(T=293.15)
annotation (Placement(transformation(extent={{-172,58},{-152,78}})));
Fluid.Sensors.MassFlowRate Ori_Mixingvol_MF1(
redeclare package Medium = Medium) "Mass flow rate sensor" annotation (Placement(transformation(
Expand Down
16 changes: 11 additions & 5 deletions IDEAS/Buildings/Components/Examples/AirflowBoxModel.mo
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,39 @@ within IDEAS.Buildings.Components.Examples;
model AirflowBoxModel
extends Modelica.Icons.Example;

Box_Sim Energy_Only(sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.None)) annotation (Placement(transformation(rotation=0, extent={{-110,30},
Box_Sim Energy_Only(sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.None))
"Model not including a pressure network or n50 correction, the default IDEAS implementation."
annotation (Placement(transformation(rotation=0, extent={{-110,30},
{-50,90}})));
Box_Sim Energy_n50Corr(sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.None, unify_n50=true)) annotation (Placement(transformation(rotation=0,
Box_Sim Energy_n50Corr(sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.None, unify_n50=true))
"Model not including a pressure network with n50 correction on building level."
annotation (Placement(transformation(rotation=0,
extent={{-30,30},{30,90}})));
Box_Sim IAQ_1port(sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.OnePort))
"Model including a 1-port pressure network."
annotation (Placement(transformation(rotation=0, extent={{-110,-90},{-50,
-30}})));
Box_Sim IAQ_1port_trickle(sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.OnePort),
winD(
use_trickle_vent=true,
m_flow_nominal=0.0192656,
dp_nominal=2))
"Extends the 1 port implementation with a tricklevent in the window"
"Model including a 1-port pressure network and a tricklevent in the window"
annotation (Placement(transformation(rotation=0, extent={{-30,-90},
{30,-30}})));
Box_Sim IAQ_2Port(
PerfectRad(G=10000000),
sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts),

use_operable_window=true,
winD(
crackOrOperableDoor(nCom=2),
use_trickle_vent=false,
m_flow_nominal=0.0192656,
dp_nominal=2),
winD_position(y=0)) annotation (Placement(transformation(rotation=0, extent
winD_position(y=0)) "Model including a 2-port pressure network."
annotation (Placement(transformation(rotation=0, extent
={{50,-90},{110,-30}})));

protected
model Box_Sim
inner BoundaryConditions.SimInfoManager sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts,
Expand Down
5 changes: 2 additions & 3 deletions IDEAS/Buildings/Components/Examples/BuildingShadeExample.mo
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,9 @@ model BuildingShadeExample
azi=azi.k,
t=0.02) "Horizontal fin model"
annotation (Placement(transformation(extent={{14,20},{24,40}})));
Modelica.Blocks.Sources.Constant m_flow(k = 0) "Mass flow rate" annotation(
Placement(visible = true, transformation(origin = {0, -60}, extent = {{-100, 20}, {-80, 40}}, rotation = 0)));
Modelica.Blocks.Sources.Constant m_flow(k=0) "Mass flow rate" annotation (Placement(visible = true, transformation(origin = {0, -60}, extent = {{-100, 20}, {-80, 40}}, rotation = 0)));
protected
Interfaces.WeaBus weaBus(numSolBus=sim.numIncAndAziInBus)
Interfaces.WeaBus weaBus(numSolBus=sim.numIncAndAziInBus)
annotation (Placement(transformation(extent={{-64,24},{-44,44}})));
equation
connect(sim.weaBus, weaBus) annotation (Line(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ within IDEAS.Buildings.Components.Examples;
model RectangularZoneTemplate
"This example illustrates the use of the RectangularZoneTemplate to model a room or building"
extends Modelica.Icons.Example;
inner BoundaryConditions.SimInfoManager sim
"Simulation information manager for climate data"
annotation (Placement(transformation(extent={{-100,80},{-80,100}})));
inner BoundaryConditions.SimInfoManager sim "Simulation information manager for climate data" annotation (Placement(transformation(extent={{-100,80},{-80,100}})));

IDEAS.Buildings.Components.RectangularZoneTemplate Zone(
h=2.7,
Expand All @@ -16,7 +14,6 @@ model RectangularZoneTemplate
bouTypCei=IDEAS.Buildings.Components.Interfaces.BoundaryType.OuterWall,
hasWinCei=false,
redeclare IDEAS.Buildings.Validation.Data.Constructions.LightRoof conTypCei,

bouTypFlo=IDEAS.Buildings.Components.Interfaces.BoundaryType.BoundaryWall,
redeclare IDEAS.Buildings.Validation.Data.Constructions.HeavyFloor
conTypFlo,
Expand Down
6 changes: 2 additions & 4 deletions IDEAS/Buildings/Components/Examples/TwoStoreyBoxes.mo
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ within IDEAS.Buildings.Components.Examples;
model TwoStoreyBoxes
extends Modelica.Icons.Example;

inner BoundaryConditions.SimInfoManager sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts,
n50=1)
annotation (Placement(transformation(extent={{-100,80},{-80,100}})));
inner BoundaryConditions.SimInfoManager sim(interZonalAirFlowType=IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts,n50=1) annotation (Placement(transformation(extent={{-100,80},{-80,100}})));

IDEAS.Buildings.Components.RectangularZoneTemplate Level(
hFloor=5,
Expand Down Expand Up @@ -88,7 +86,7 @@ First implementation
</li>
</ul>
</html>", info="<html>
<p>Model with two zones on different floors with a large opening between these zones and stack-effect airflow enabled.</p>
<p>Model with two zones on different floors, one zone above the other, with a large opening between these zones and stack-effect airflow enabled.</p>
</html>"),
__Dymola_Commands(file=
"Resources/Scripts/Dymola/Buildings/Examples/TwoStoreyBoxes.mos"
Expand Down
6 changes: 3 additions & 3 deletions IDEAS/Buildings/Components/Interfaces/DummyConnection.mo
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ model DummyConnection "Source generator/sink for propsbus"
outer IDEAS.BoundaryConditions.SimInfoManager sim annotation (Placement(transformation(extent={{-100,20},{-80,40}})));
IDEAS.Buildings.Components.Interfaces.ZoneBus zoneBus(
redeclare package Medium = Medium,
numIncAndAziInBus=sim.numIncAndAziInBus,
outputAngles=sim.outputAngles,
use_port_1 = sim.interZonalAirFlowType <> IDEAS.BoundaryConditions.Types.InterZonalAirFlow.None,
numIncAndAziInBus=sim.numIncAndAziInBus,
outputAngles=sim.outputAngles,
use_port_1 = sim.interZonalAirFlowType <> IDEAS.BoundaryConditions.Types.InterZonalAirFlow.None,
use_port_2 = sim.interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts)
annotation (Placement(transformation(extent={{80,-22},{120,18}})));
Modelica.Thermal.HeatTransfer.Sources.FixedHeatFlow prescribedHeatFlow[3](
Expand Down
10 changes: 2 additions & 8 deletions IDEAS/Buildings/Components/Interfaces/PartialZone.mo
Original file line number Diff line number Diff line change
Expand Up @@ -189,9 +189,9 @@ model PartialZone "Building zone model"
extent={{-10,10},{10,-10}},
rotation=270,
origin={-30,-10})));
Modelica.Blocks.Math.Add addmWatFlow "Add mass flow rates" annotation(
Modelica.Blocks.Math.Add addmWatFlow "Add medium substance mass flow rates, typically moisture" annotation (
Placement(visible = true, transformation(origin = {-6, 40}, extent = {{4, -4}, {-4, 4}}, rotation = 0)));
Modelica.Blocks.Math.Add addCFlow[max(Medium.nC,1)](k2 = intGaiOcc.s_co2) annotation(
Modelica.Blocks.Math.Add addCFlow[max(Medium.nC,1)](k2 = intGaiOcc.s_co2) "Add tracer mass flow rates" annotation (
Placement(visible = true, transformation(origin = {-6, 34}, extent = {{4, -4}, {-4, 4}}, rotation = 0)));
protected
parameter Real n50_int(unit="1/h",min=0.01,fixed= false)
Expand Down Expand Up @@ -578,12 +578,6 @@ Added conditional inputs for injecting water or CO2.
Added output phi for the relative humidity.
</li>
<li>
January 8, 2024, by Jelger Jansen:<br/>
Added min attribute to <code>mSenFac</code>.
See <a href=\"https://github.com/open-ideas/IDEAS/issues/1343\">
#1343</a>
</li>
<li>
May 29, 2022, by Filip Jorissen:<br/>
Unprotected component for OM compatibility.
See <a href=\"https://github.com/open-ideas/IDEAS/issues/1254\">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1561,7 +1561,6 @@ See <a href=\"https://github.com/open-ideas/IDEAS/issues/1343\">
October 18, 2023, by Filip Jorissen:<br/>
Added window height parameters.
</li>
</li>
<li>
August 2, 2022, by Filip Jorissen:<br/>
Added cavity support for horizontal internal walls (floor/ceiling)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,15 @@ model ZoneBusVarMultiplicator "Component to scale all flows from the zone propsB
annotation (Placement(transformation(extent={{8,-324},{-12,-304}})));
protected
IDEAS.Fluid.BaseClasses.MassFlowRateMultiplier massFlowRateMultiplier2(
redeclare package Medium = Medium, final k=k)
if sim.interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts
redeclare package Medium = Medium,final k=k) if sim.interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts
"Mass flow rate multiplier for port 2"
annotation (Placement(transformation(extent={{-10,-200},{10,-180}})));
IDEAS.Fluid.BaseClasses.MassFlowRateMultiplier massFlowRateMultiplier1(
redeclare package Medium = Medium, final k=k)
if sim.interZonalAirFlowType <> IDEAS.BoundaryConditions.Types.InterZonalAirFlow.None
redeclare package Medium = Medium,final k=k) if sim.interZonalAirFlowType <> IDEAS.BoundaryConditions.Types.InterZonalAirFlow.None
"Mass flow rate multiplier for port 1"
annotation (Placement(transformation(extent={{-10,-170},{10,-150}})));
IDEAS.Fluid.BaseClasses.MassFlowRateMultiplier massFlowRateMultiplier3(
redeclare package Medium = Medium, final k=k)
if sim.interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts
redeclare package Medium = Medium,final k=k) if sim.interZonalAirFlowType == IDEAS.BoundaryConditions.Types.InterZonalAirFlow.TwoPorts
"Mass flow rate multiplier for port 3"
annotation (Placement(transformation(origin = {0, -208}, extent = {{-10, -200}, {10, -180}})));
Modelica.Blocks.Math.Gain QTra_desgin(k=k) "Design heat flow rate"
Expand Down
5 changes: 2 additions & 3 deletions IDEAS/Buildings/Components/Interfaces/ZoneInterface.mo
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ equation
connect(prescribedHeatFlowE.port, sim.E);
connect(Qgai.y,prescribedHeatFlowQgai. Q_flow);
connect(prescribedHeatFlowQgai.port, sim.Qgai);

connect(setVolume.volumePort, sim.volumePort);

annotation (Diagram(coordinateSystem(preserveAspectRatio=false, extent={{-100,
-100},{100,100}})), Icon(coordinateSystem(
preserveAspectRatio=false, extent={{-100,-100},{100,100}}), graphics={
Expand Down Expand Up @@ -194,15 +194,14 @@ See <a href=\"https://github.com/open-ideas/IDEAS/issues/1253\">#1253</a>.
September 17, 2020, Filip Jorissen:<br/>
Modified default Medium.
See <a href=\"https://github.com/open-ideas/IDEAS/issues/1169\">#1169</a>.
March 21, 2019 by Filip Jorissen:<br/>
</li>
<li>
March 17, 2020, Filip Jorissen:<br/>
Added support for vector fluidport.
See <a href=\"https://github.com/open-ideas/IDEAS/issues/1029\">#1029</a>.
March 21, 2019 by Filip Jorissen:<br/>
</li>
<li>
March 21, 2019 by Filip Jorissen:<br/>
Revised implementation of icon for
<a href=\"https://github.com/open-ideas/IDEAS/issues/996\">#996</a>
and for <a href=\"https://github.com/open-ideas/IDEAS/pull/976\">#976</a>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ This is for <a href=\"https://github.com/open-ideas/IDEAS/issues/760\">#760</a>.
final parameter Real s_co2[max(Medium.nC,1)] = {if Modelica.Utilities.Strings.isEqual(string1=if Medium.nC>0 then Medium.extraPropertiesNames[i] else "",
string2="CO2",
caseSensitive=false)
then 1 else 0 for i in 1:max(Medium.nC,1)};
then 1 else 0 for i in 1:max(Medium.nC,1)}
"Array with 1 on the position where CO2 is situated in the Medium.extraPropertiesNames";
constant Modelica.Units.SI.SpecificEnthalpy lambdaWater=if (Medium.nX) > 1
then Medium.enthalpyOfCondensingGas(T=273.15 + 35) else 2566120
"Latent heat of evaporation of water at 35 degrees Celsius";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,16 @@ record Lowrise_Square_Exposed
Cp_Floor=[0,0; 45,0; 90,0; 135,0; 180,0; 225,0; 270,0; 315,0; 360,0])
annotation (Documentation(info="<html>
<p>

M. W. Liddament, <i>A guide to energy efficient ventilation</i>. Coventry: Annex V Air Infiltration and Ventilation Centre, 1996.<br>
<br>
Table A2.1 Wind Pressure Coefficient Data<br>
Low-rise buildings (up to 3 storeys)<br>
Length to width ratio: 1:1<br>
Shielding condition: Exposed<br>
Wind speed reference level: Building height<br>


</p>
</html>"));


annotation (Documentation(revisions="<html>
annotation (Documentation(revisions="<html>
<ul>
<li>
October 30, 2024, by Klaas De Jonge:<br/>
Expand Down
4 changes: 1 addition & 3 deletions IDEAS/Buildings/Examples/ZoneWithSources.mo
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ within IDEAS.Buildings.Examples;
model ZoneWithSources "Zone with CO2 concentration model"
extends Modelica.Icons.Example;
replaceable package Medium = IDEAS.Media.Air(extraPropertiesNames={"test", "CO2"});
inner BoundaryConditions.SimInfoManager sim
"Simulation information manager for climate data"
annotation (Placement(transformation(extent={{-100,80},{-80,100}})));
inner BoundaryConditions.SimInfoManager sim "Simulation information manager for climate data" annotation (Placement(transformation(extent={{-100,80},{-80,100}})));

IDEAS.Buildings.Components.Examples.BaseClasses.SimpleZone zone(
redeclare package Medium = Medium,
Expand Down
4 changes: 2 additions & 2 deletions IDEAS/Examples/PPD12/package.order
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Heating
Structure
StructureExt_2Port
StructureExt_2Port_NoFlowTest
VentilationMPC
VentilationRBC
StructureExt_2Port
Data
BaseClasses
StructureExt_2Port_NoFlowTest
Loading