Add and update documentation #1575

ibpsa · Oct 6, 2023 · ac70d26 · ac70d26
1 parent d532921
commit ac70d26
Show file tree

Hide file tree

Showing 23 changed files with 205 additions and 58 deletions.
diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/Icons/package.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/Icons/package.mo
@@ -1,3 +1,17 @@
 within IBPSA.Electrical.BaseClasses.PV.BaseClasses;
 package Icons
+ annotation(Documentation(info="<html>
+<p>
+This package contains icons for the models in
+<a href=\"modelica://IBPSA.Electrical.BaseClasses.PV.BaseClasses\">IBPSA.Electrical.BaseClasses.PV.BaseClasses</a>.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
 end Icons;
diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/Icons/partialPVIcon.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/Icons/partialPVIcon.mo
@@ -66,5 +66,18 @@ partial model partialPVIcon "Partial model for basic PV model icon"
         textString="%name",
         textColor={0,0,255})}),
       Diagram(coordinateSystem(preserveAspectRatio=false, extent={{-100,-100},{
-            100,100}})));
+            100,100}})),
+            Documentation(info="<html>
+<p>
+This is a partial model containing the base icon of the PV-related models.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
 end partialPVIcon;
diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PVOptical/PVType.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PVOptical/PVType.mo
@@ -6,4 +6,17 @@ type PVType = enumeration(
     ThinFilmSI
       "Thin film Silicon PV technology",
     ThreeJuncAmorphous "Three-junction amorphous PV technology")
- "Enumeration to define definition of the PV technology";
+ "Enumeration to define definition of the PV technology"
+  annotation(Documentation(info="<html>
+<p>
+Enumeration to define the PV material type used in the PV models.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PVOptical/package.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PVOptical/package.mo
@@ -2,4 +2,18 @@ within IBPSA.Electrical.BaseClasses.PV.BaseClasses;
 package PVOptical "Models for computing irradiance-related boundary conditions for PV systems"
 
 
+ annotation(Documentation(info="<html>
+<p>
+This package contains base classes that are used to construct the models extending from
+<a href=\"modelica://IBPSA.Electrical.BaseClasses.PV.PVOpticalAbsRat\">IBPSA.Electrical.BaseClasses.PV.PVOpticalAbsRat</a>.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
 end PVOptical;
diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PartialPVElectricalSingleDiode.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PartialPVElectricalSingleDiode.mo
@@ -67,14 +67,12 @@ protected
           thickness=0.5),
         Text(
           extent={{-72,80},{-102,68}},
-          lineColor={0,0,0},
           lineThickness=0.5,
           fillColor={255,255,255},
           fillPattern=FillPattern.Solid,
           textString="I"),
         Text(
           extent={{80,-80},{50,-92}},
-          lineColor={0,0,0},
           lineThickness=0.5,
           fillColor={255,255,255},
           fillPattern=FillPattern.Solid,

diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PartialPVThermal.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PartialPVThermal.mo
@@ -27,7 +27,7 @@ partial model PartialPVThermal
         iconTransformation(extent={{-140,-50},{-100,-10}})));
   annotation (Icon(coordinateSystem(preserveAspectRatio=false, extent={{-100,
             -100},{120,100}}),                                  graphics={
-                             Text(extent={{-84,-68},{0,-102}},lineColor={0,0,255},textString= "%name"),
+                             Text(extent={{-84,-68},{0,-102}},textString= "%name"),
     Rectangle(extent={{-94,84},{6,-74}}, lineColor={215,215,215},fillColor={215,215,215},
             fillPattern =                                                                              FillPattern.Solid),
     Rectangle(extent={{-90,24},{-62,-4}},

diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/package.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/package.mo
@@ -2,11 +2,10 @@ within IBPSA.Electrical.BaseClasses.PV;
 package BaseClasses "Package with base classes for IBPSA.Electrical"
   extends Modelica.Icons.BasesPackage;
 
-
-
-
-
-
-
-
+   annotation(preferredView="info", Documentation(info="<html>
+<p>
+This package contains base classes that are used to construct the models in
+<a href=\"modelica://IBPSA.Electrical.BaseClasses.PV\">IBPSA.Electrical.BaseClasses.PV</a>.
+</p>
+</html>"));
 end BaseClasses;
diff --git a/IBPSA/Electrical/BaseClasses/PV/package.mo b/IBPSA/Electrical/BaseClasses/PV/package.mo
@@ -1,11 +1,6 @@
 within IBPSA.Electrical.BaseClasses;
 package PV "Base classes for PV models"
 
-
-
-
-
-
   annotation(preferredView="info", Documentation(info="<html>
 <p>
 This package contains base classes that are used to construct the models in

diff --git a/IBPSA/Electrical/DC/Sources/Validation/BaseClasses/package.mo b/IBPSA/Electrical/DC/Sources/Validation/BaseClasses/package.mo
@@ -1,4 +1,11 @@
 within IBPSA.Electrical.DC.Sources.Validation;
 package BaseClasses "BaseClasses for validation"
   extends Modelica.Icons.BasesPackage;
+
+   annotation(preferredView="info", Documentation(info="<html>
+<p>
+This package contains base classes that are used to construct the models in
+<a href=\"modelica://IBPSA.Electrical.DC.Sources.Validation\">IBPSA.Electrical.DC.Sources.Validation</a>.
+</p>
+</html>"));
 end BaseClasses;
diff --git a/IBPSA/Electrical/DC/Sources/Validation/BaseClasses/partialPVRooftopBuildingValidation.mo b/IBPSA/Electrical/DC/Sources/Validation/BaseClasses/partialPVRooftopBuildingValidation.mo
@@ -202,8 +202,7 @@ equation
       StartTime=18057600,
       StopTime=19008000,
       Interval=300,
-      Tolerance=1e-06,
-      __Dymola_Algorithm="Dassl"),
+      Tolerance=1e-06),
    __Dymola_Commands(file=
           "modelica://IBPSA/Resources/Scripts/Dymola/Electrical/DC/Sources/Validation/PVSingleDiodeRooftopBuildingValidation.mos"
         "Simulate and plot"),

diff --git a/IBPSA/Electrical/DC/Sources/Validation/PVSingleDiodeNISTValidation.mo b/IBPSA/Electrical/DC/Sources/Validation/PVSingleDiodeNISTValidation.mo
@@ -44,7 +44,7 @@ model PVSingleDiodeNISTValidation
     annotation (Placement(transformation(extent={{-96,-10},{-76,10}})));
 
   PVSingleDiode pVSingleDiode(
-    redeclare IBPSA.Electrical.Data.PV.SingleDiodeShardNUU235F2 data,
+    redeclare IBPSA.Electrical.Data.PV.SingleDiodeSharpNUU235F2 data,
     PVTechType=IBPSA.Electrical.BaseClasses.PV.BaseClasses.PVOptical.PVType.MonoSI,
     n_mod=312,
     groRef=rho,
@@ -184,7 +184,6 @@ equation
   annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(
         coordinateSystem(preserveAspectRatio=false), graphics={Text(
           extent={{-94,46},{-36,12}},
-          lineColor={28,108,200},
           horizontalAlignment=TextAlignment.Left,
           textString="1 - Air temperature in °C
 2 - Wind speed in m/s
@@ -193,8 +192,7 @@ equation
     experiment(
       StopTime=86400,
       Interval=300,
-      Tolerance=1e-06,
-      __Dymola_Algorithm="Dassl"),
+      Tolerance=1e-06),
       __Dymola_Commands(file=
           "modelica://IBPSA/Resources/Scripts/Dymola/Electrical/DC/Sources/Validation/PVSingleDiodeNISTValidation.mos"
         "Simulate and plot"),
@@ -221,6 +219,5 @@ Oct 5, 2023, by Laura Maier:<br/>
 First implementation.
 </li>
 </ul>
-</html>"),
-    __Dymola_experimentSetupOutput(events=false));
+</html>"));
 end PVSingleDiodeNISTValidation;
diff --git a/IBPSA/Electrical/DC/Sources/Validation/PVSingleDiodeRooftopBuildingValidation.mo b/IBPSA/Electrical/DC/Sources/Validation/PVSingleDiodeRooftopBuildingValidation.mo
@@ -84,8 +84,7 @@ equation
       StartTime=18057600,
       StopTime=19094400,
       Interval=300,
-      Tolerance=1e-06,
-      __Dymola_Algorithm="Dassl"),
+      Tolerance=1e-06),
    __Dymola_Commands(file=
           "modelica://IBPSA/Resources/Scripts/Dymola/Electrical/DC/Sources/Validation/PVSingleDiodeRooftopBuildingValidation.mos"
         "Simulate and plot"),
@@ -102,6 +101,5 @@ Nov 17, 2022, by Laura Maier:<br/>
 First implementation.
 </li>
 </ul>
-</html>"),
-    __Dymola_experimentSetupOutput(events=false));
+</html>"));
 end PVSingleDiodeRooftopBuildingValidation;
diff --git a/IBPSA/Electrical/DC/Sources/Validation/package.mo b/IBPSA/Electrical/DC/Sources/Validation/package.mo
@@ -2,4 +2,11 @@ within IBPSA.Electrical.DC.Sources;
 package Validation "Package with example models"
   extends Modelica.Icons.ExamplesPackage;
 
+annotation (Documentation(info="<html>
+<p>
+This package contains validation for the use of models that can be found in
+<a href=\"modelica://IBPSA.Electrical.DC.Sources\">
+IBPSA.Electrical.DC.Sources</a>.
+</p>
+</html>"));
 end Validation;
diff --git a/IBPSA/Electrical/Data/PV/Generic.mo b/IBPSA/Electrical/Data/PV/Generic.mo
@@ -24,5 +24,17 @@ record Generic "Basic record of a PV cell"
     "Band gap energy under standard conditions. For Si: 1.79604e-19 J or 1.121 eV";
 
   annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(coordinateSystem(
-          preserveAspectRatio=false)));
+          preserveAspectRatio=false)),Documentation(info="<html>
+<p>
+This is a base record containing the base information for PV models.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
 end Generic;
diff --git a/IBPSA/Electrical/Data/PV/SingleDiodeData.mo b/IBPSA/Electrical/Data/PV/SingleDiodeData.mo
@@ -45,5 +45,17 @@ record SingleDiodeData
     "Band gap temperature coefficient; for Silicon: 0.0002677";
 
   annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(coordinateSystem(
-          preserveAspectRatio=false)));
+          preserveAspectRatio=false)),Documentation(info="<html>
+<p>
+This is the base data model for the data models for the single-diode PV model.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
 end SingleDiodeData;
diff --git a/IBPSA/Electrical/Data/PV/SingleDiodeShardNUU235F2.mo b/IBPSA/Electrical/Data/PV/SingleDiodeShardNUU235F2.mo
diff --git a/IBPSA/Electrical/Data/PV/SingleDiodeSharpNUU235F2.mo b/IBPSA/Electrical/Data/PV/SingleDiodeSharpNUU235F2.mo
@@ -0,0 +1,37 @@
+within IBPSA.Electrical.Data.PV;
+record SingleDiodeSharpNUU235F2
+  "Single-diode record for Sharp NU-U235F2 modules"
+   extends IBPSA.Electrical.Data.PV.SingleDiodeData(
+    n_ser=60,
+    n_par=1,
+    A_cel=((V_mp0*I_mp0)/(1000*eta_0))/n_ser,
+    A_mod=0.994*1.640,
+    eta_0=0.144,
+    V_oc0=37,
+    I_sc0=8.6,
+    V_mp0=30,
+    I_mp0=7.84,
+    P_mp0=235,
+    TCoeff_Isc=0.00053*I_sc0,
+    TCoeff_Voc=-0.00351*V_oc0,
+    gamma_Pmp=-0.00485,
+    T_NOCT=47.5 + 273.15,
+    Eg0 = 1.107,
+    C=0.0002677);
+  annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(
+        coordinateSystem(preserveAspectRatio=false)),Documentation(info="<html>
+<p>
+This is an exemplary data model of the mono-Si module Sharp NU-U235 F2 used for the single-diode PV model.
+This data is used for validation in
+<a href=\"modelica://IBPSA.Electrical.DC.Sources.Validation.PVSingleDiodeNISTValidation\">IBPSA.Electrical.DC.Sources.Validation.PVSingleDiodeNISTValidation</a>.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
+end SingleDiodeSharpNUU235F2;
diff --git a/IBPSA/Electrical/Data/PV/SingleDiodeSolibroSL2CIGS110.mo b/IBPSA/Electrical/Data/PV/SingleDiodeSolibroSL2CIGS110.mo
@@ -18,5 +18,19 @@ record SingleDiodeSolibroSL2CIGS110 "Single-diode record for Solibro SL2 CIGS 11
     Eg0 = 1.107,
     C=0.0002677);
   annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(
-        coordinateSystem(preserveAspectRatio=false)));
+        coordinateSystem(preserveAspectRatio=false)),Documentation(info="<html>
+<p>
+This is an exemplary data model of the thin-film module Solibro SL2 CIGS 110 Wp used for the single-diode PV model.
+This data is used for validation in
+<a href=\"modelica://IBPSA.Electrical.DC.Sources.Validation.PVSingleDiodeRooftopBuildingValidation\">IBPSA.Electrical.DC.Sources.Validation.PVSingleDiodeRooftopBuildingValidation</a>.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
 end SingleDiodeSolibroSL2CIGS110;
diff --git a/IBPSA/Electrical/Data/PV/SingleDiodeSolibroSL2CIGS115.mo b/IBPSA/Electrical/Data/PV/SingleDiodeSolibroSL2CIGS115.mo
@@ -19,5 +19,19 @@ record SingleDiodeSolibroSL2CIGS115
     Eg0 = 1.107,
     C=0.0002677);
   annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(
-        coordinateSystem(preserveAspectRatio=false)));
+        coordinateSystem(preserveAspectRatio=false)),Documentation(info="<html>
+<p>
+This is an exemplary data model of the thin-film module Solibro SL2 CIGS 115 Wp used for the single-diode PV model.
+This data is used for validation in
+<a href=\"modelica://IBPSA.Electrical.DC.Sources.Validation.PVSingleDiodeRooftopBuildingValidation\">IBPSA.Electrical.DC.Sources.Validation.PVSingleDiodeRooftopBuildingValidation</a>.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
 end SingleDiodeSolibroSL2CIGS115;
diff --git a/IBPSA/Electrical/Data/PV/SingleDiodeSolibroSL2CIGS120.mo b/IBPSA/Electrical/Data/PV/SingleDiodeSolibroSL2CIGS120.mo
@@ -19,5 +19,19 @@ record SingleDiodeSolibroSL2CIGS120
     Eg0 = 1.107,
     C=0.0002677);
   annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(
-        coordinateSystem(preserveAspectRatio=false)));
+        coordinateSystem(preserveAspectRatio=false)),Documentation(info="<html>
+<p>
+This is an exemplary data model of the thin-film module Solibro SL2 CIGS 120 Wp used for the single-diode PV model.
+This data is used for validation in
+<a href=\"modelica://IBPSA.Electrical.DC.Sources.Validation.PVSingleDiodeRooftopBuildingValidation\">IBPSA.Electrical.DC.Sources.Validation.PVSingleDiodeRooftopBuildingValidation</a>.
+</p>
+</html>",
+        revisions="<html>
+<ul>
+<li>
+Oct 6, 2023, by Laura Maier:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
 end SingleDiodeSolibroSL2CIGS120;
diff --git a/IBPSA/Electrical/Data/PV/package.mo b/IBPSA/Electrical/Data/PV/package.mo
@@ -1,3 +1,9 @@
 within IBPSA.Electrical.Data;
 package PV "Data records for PV models"
+annotation(preferredView="info", Documentation(info="<html>
+<p>
+This package contains data required for PV models in the package 
+<a href=\"modelica://IBPSA.Electrical\">IBPSA.Electrical</a>.
+</p>
+</html>"));
 end PV;
diff --git a/IBPSA/Electrical/Data/PV/package.order b/IBPSA/Electrical/Data/PV/package.order
@@ -1,6 +1,6 @@
 Generic
 SingleDiodeData
-SingleDiodeShardNUU235F2
+SingleDiodeSharpNUU235F2
 SingleDiodeSolibroSL2CIGS110
 SingleDiodeSolibroSL2CIGS115
 SingleDiodeSolibroSL2CIGS120