HTML formatting and code formatting #1575

ibpsa · Dec 12, 2023 · 3eec2db · 3eec2db
1 parent 9281339
commit 3eec2db
Show file tree

Hide file tree

Showing 12 changed files with 31 additions and 45 deletions.
diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/Icons/package.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/Icons/package.mo
@@ -1,5 +1,7 @@
 within IBPSA.Electrical.BaseClasses.PV.BaseClasses;
 package Icons
+  extends Modelica.Icons.Package;
+
  annotation(Documentation(info="<html>
 <p>
 This package contains icons for the models in

diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PVOptical/AirMass.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PVOptical/AirMass.mo
@@ -12,16 +12,13 @@ protected
   Modelica.Units.SI.Angle zen "Zenith angle internal use";
 equation
 // Restriction for zenith angle
- zen = if zenAng <= Modelica.Constants.pi/2 then
- zenAng
- else
- Modelica.Constants.pi/2 "Zenith angle";
+ zen = if zenAng <= Modelica.Constants.pi/2 then zenAng
+ else Modelica.Constants.pi/2 "Zenith angle";
 
-  airMas =
-  exp(-0.0001184*alt)/(cos(zen) + 0.5057*(96.080 -
-                  zen*180/Modelica.Constants.pi)^(-1.634)) "Air mass";
+ airMas = exp(-0.0001184*alt)/(cos(zen) +
+   0.5057*(96.080 - zen*180/Modelica.Constants.pi)^(-1.634)) "Air mass";
 
-  annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(
+ annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(
         coordinateSystem(preserveAspectRatio=false)),
         Documentation(info="<html><p>The model computes the air mass, which is the number of particles in the atmosphere.</br>
         It bases on an exact empirical approach by Kasten et al. and bases on the zenith angle of the object as well as its height.</p>

diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PVOptical/package.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PVOptical/package.mo
@@ -1,6 +1,6 @@
 within IBPSA.Electrical.BaseClasses.PV.BaseClasses;
 package PVOptical "Models for computing irradiance-related boundary conditions for PV systems"
-
+  extends Modelica.Icons.Package;
 
  annotation(Documentation(info="<html>
 <p>

diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PartialPVElectrical.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PartialPVElectrical.mo
@@ -2,7 +2,7 @@ within IBPSA.Electrical.BaseClasses.PV.BaseClasses;
 partial model PartialPVElectrical
   "Partial electrical model for PV module model"
 
-  replaceable parameter Data.PV.Generic dat                   constrainedby
+  replaceable parameter Data.PV.Generic dat constrainedby
     IBPSA.Electrical.Data.PV.Generic "PV Panel data definition"
     annotation (choicesAllMatching);
 
@@ -84,7 +84,7 @@ protected
           smooth=Smooth.Bezier)}),                               Diagram(
         coordinateSystem(preserveAspectRatio=false, extent={{-100,-100},{100,100}})),
     Documentation(info="<html>
-    <p>This is a partial model for the electrical surrogate models of a photovoltaic model.</p>
+    <p>This is a partial model for the electrical surrogate models of a photovoltaic module.</p>
 </html>", revisions="<html>
 <ul>
 <li>

diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PartialPVElectricalSingleDiode.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/PartialPVElectricalSingleDiode.mo
@@ -38,14 +38,14 @@ protected
   final parameter Real TCoeVOC(unit="V/K") = dat.TCoeVOC
     "Temperature coefficient for open circuit voltage, <0";
 
-  final parameter Modelica.Units.SI.LinearTemperatureCoefficient alphaISC=
-  dat.alphaISC "Normalized temperature coefficient for short circuit current, >0";
+  final parameter Modelica.Units.SI.LinearTemperatureCoefficient alphaISC=dat.alphaISC
+    "Normalized temperature coefficient for short circuit current, >0";
 
-  final parameter Modelica.Units.SI.LinearTemperatureCoefficient betaVOC=
-  dat.betaVOC "Normalized temperature coefficient for open circuit voltage, <0";
+  final parameter Modelica.Units.SI.LinearTemperatureCoefficient betaVOC=dat.betaVOC
+    "Normalized temperature coefficient for open circuit voltage, <0";
 
-  final parameter Modelica.Units.SI.LinearTemperatureCoefficient gammaPMP=
-  dat.gammaPMP "Normalized temperature coefficient for power at MPP";
+  final parameter Modelica.Units.SI.LinearTemperatureCoefficient gammaPMP=dat.gammaPMP
+    "Normalized temperature coefficient for power at MPP";
 
   final parameter Modelica.Units.SI.Temperature TCel0 = 25.0 + 273.15
     "Thermodynamic cell temperature under standard conditions";

diff --git a/IBPSA/Electrical/BaseClasses/PV/BaseClasses/lambertWSimple.mo b/IBPSA/Electrical/BaseClasses/PV/BaseClasses/lambertWSimple.mo
@@ -8,7 +8,7 @@ function lambertWSimple
 algorithm
   W:= log(x)*(1-log(log(x))/(log(x)+1));
   annotation (Documentation(info="<html>
-<p><span style=\"font-family: Roboto; color: #202124; background-color: #ffffff;\">The Lambert W function solves mathematical equations in which the unknown is both inside and outside of an exponential function or a logarithm.</span></p>
+<p>The Lambert W function solves mathematical equations in which the unknown is both inside and outside of an exponential function or a logarithm.</span></p>
 <p>This function is a simple approximation for Lambert W function following Baetzelis, 2016:</p>
 </html>", revisions="<html>
 <ul>

diff --git a/IBPSA/Electrical/BaseClasses/PV/PVElectricalSingleDiodeMPP.mo b/IBPSA/Electrical/BaseClasses/PV/PVElectricalSingleDiodeMPP.mo
@@ -159,9 +159,7 @@ to the parameter values at standard conditions following (DeSoto et al.,2006).</
 <p>
   <br/>
 </p>
-<h4>
-  <span style=\"color: #008000\">References</span>
-</h4>
+<h4>References</h4>
 <p>
 Batzelis, E. I., &amp; Papathanassiou, S. A. (2015). A method for the analytical
 extraction of the single-diode PV model parameters. IEEE Transactions on

diff --git a/IBPSA/Electrical/BaseClasses/PV/PVOpticalAbsRat.mo b/IBPSA/Electrical/BaseClasses/PV/PVOpticalAbsRat.mo
@@ -8,8 +8,7 @@ model PVOpticalAbsRat
    "Site altitude in Meters, default= 1"
    annotation(Dialog(group="Location"));
 
- parameter Real groRef(unit="1") "Ground reflectance"
-   annotation ();
+ parameter Real groRef(unit="1") "Ground reflectance";
 
   constant Modelica.Units.SI.Irradiance HGloHor0=1000
  "Total solar radiation on the horizontal surface under standard conditions"
@@ -184,9 +183,7 @@ For a definition of the parameters, see the
 <a href=\"modelica://IBPSA.BoundaryConditions.UsersGuide\">
 IBPSA.BoundaryConditions.UsersGuide</a>.
 </p>
-<h4>
-  <span style=\"color: #008000\">References</span>
-  </h4>
+<h4>References</h4>
 <p>
 De Soto, W., Klein, S. A., &amp; Beckman, W. A. (2006). Improvement and validation 
 of a model for photovoltaic array performance. Solar energy, 80(1), 78-88.

diff --git a/IBPSA/Electrical/BaseClasses/PV/PVThermalEmpMountCloseToGround.mo b/IBPSA/Electrical/BaseClasses/PV/PVThermalEmpMountCloseToGround.mo
@@ -15,15 +15,10 @@ equation
   an open rack under operating conditions and under consideration of
   the wind velocity.
 </p>
+<h4>References</h4>
 <p>
-  <br/>
-</p>
-<h4>
-  <span style=\"color: #008000\">References</span>
-</h4>
-<p>
-  <q>Solar engineering of thermal processes.</q> by Duffie, John A. ;
-  Beckman, W. A.
+<q>Solar engineering of thermal processes.</q> by Duffie, John A. ; 
+Beckman, W. A.
 </p>
 </html>", revisions="<html>
 <ul>

diff --git a/IBPSA/Electrical/BaseClasses/PV/PVThermalEmpMountContactToGround.mo b/IBPSA/Electrical/BaseClasses/PV/PVThermalEmpMountContactToGround.mo
@@ -12,18 +12,16 @@ equation
         coordinateSystem(preserveAspectRatio=false)),
     Documentation(info="<html>
 <p>
-  Model for determining the cell temperature of a PV module mounted on
-  an open rack under operating conditions and under consideration of
-  the wind velocity.
+Model for determining the cell temperature of a PV module mounted on 
+an open rack under operating conditions and under consideration of
+the wind velocity.
 </p>
 <p>
-  <br/>
+<br/>
 </p>
-<h4>
-  <span style=\"color: #008000\">References</span>
-</h4>
+<h4>References</h4>
 <p>
-  <q>Solar engineering of thermal processes.</q> by Duffie, John A. ;
+<q>Solar engineering of thermal processes.</q> by Duffie, John A. ;
   Beckman, W. A.
 </p>
 </html>", revisions="<html>

diff --git a/IBPSA/Electrical/BaseClasses/PV/PVThermalEmpMountOpenRack.mo b/IBPSA/Electrical/BaseClasses/PV/PVThermalEmpMountOpenRack.mo
@@ -23,9 +23,7 @@ equation
 <p>
   <br/>
 </p>
-<h4>
-  <span style=\"color: #008000\">References</span>
-</h4>
+<h4>References</h4>
 <p>
   <q>Solar engineering of thermal processes.</q> by Duffie, John A. ;
   Beckman, W. A.

diff --git a/IBPSA/Electrical/BaseClasses/PV/package.mo b/IBPSA/Electrical/BaseClasses/PV/package.mo
@@ -1,5 +1,6 @@
 within IBPSA.Electrical.BaseClasses;
 package PV "Base classes for PV models"
+  extends Modelica.Icons.Package;
 
   annotation(preferredView="info", Documentation(info="<html>
 <p>