Added documentation and comments to all models and examples

Author: fachif

OpenIPSL/Electrical/Controls/VariableSpeedDrive/ControllerLogic/VoltsHertzController.mo

@@ -24,7 +24,7 @@ model VoltsHertzController "Volts/Hertz controller model"
         rotation=180,
         origin={120,40})));
   OpenIPSL.NonElectrical.Continuous.SimpleLag Speed_Sensor(K=1, T=Tr,
-    y_start=1.9*Modelica.Constants.pi*SysData.fn)
+    y_start=0.1*1.9*Modelica.Constants.pi*SysData.fn)
     annotation (Placement(transformation(extent={{-38,-22},{-18,-2}})));
   parameter OpenIPSL.Types.Time Tr=0.01 "Time constant for speed sensor filter"
     annotation (Dialog(group="Control Parameters"));

OpenIPSL/Electrical/Controls/VariableSpeedDrive/PowerElectronics/AC2DCandDC2AC.mo

@@ -58,9 +58,9 @@ model AC2DCandDC2AC "Phasor based voltage source converter model."
   Modelica.Blocks.Sources.RealExpression Qmotor(y=n.vr*n.ii - n.vi*n.ir) "Reactive power for drawn motor current"
     annotation (Placement(transformation(extent={{24,54},{44,74}})));
   OpenIPSL.Types.PerUnit P "Active Power";
-  Modelica.Units.SI.ActivePower Pdc;
+  Modelica.Units.SI.ActivePower Pdc "DC Circuit Active Power";
   OpenIPSL.Types.PerUnit Q "Reactive Power";
-  OpenIPSL.Types.PerUnit S "Motor Slip";
+  OpenIPSL.Types.PerUnit S "Apparent Power";
 
   Modelica.Blocks.Sources.RealExpression Vmotor(y=Capacitor.v*m_input/(2*sqrt(2)
         *V_b)) "Motor terminal voltage"

OpenIPSL/Electrical/Machines/PSSE/BaseClasses/baseMotor.mo

@@ -41,6 +41,8 @@ partial model baseMotor "Base model for the PSSE three-phase induction motor mod
   OpenIPSL.Types.PerUnit Ir "Real part of terminal current";
   OpenIPSL.Types.PerUnit Ii "Imaginary part of terminal current";
   OpenIPSL.Types.PerUnit Imag "Terminal current magnitude";
+  OpenIPSL.Types.PerUnit Te_motor "Electromagnetic torque in motor base";
+  OpenIPSL.Types.PerUnit Te_sys "Electromagnetic torque in system base";
 
   Modelica.Blocks.Math.Gain we_fix(k=1) "Necessary gain for controllable synchronous speed functionality"
     annotation (Placement(transformation(extent={{80,-88},{90,-78}})));
@@ -94,8 +96,12 @@ equation
   v = sqrt(p.vr^2 + p.vi^2);
   anglev = atan2(p.vi, p.vr);
   delta = anglev;
-  P = if Ctrl == true then (p.vr*p.ir + p.vi*p.ii)*(we_fix.y/w_b) else (p.vr*p.ir + p.vi*p.ii);
-  Q = if Ctrl == true then ((-p.vr*p.ii) + p.vi*p.ir)*(we_fix.y/w_b) else ((-p.vr*p.ii) + p.vi*p.ir);
+  //P = if Ctrl == true then (p.vr*p.ir + p.vi*p.ii)*(we_fix.y/w_b) else (p.vr*p.ir + p.vi*p.ii);
+  //Q = if Ctrl == true then ((-p.vr*p.ii) + p.vi*p.ir)*(we_fix.y/w_b) else ((-p.vr*p.ii) + p.vi*p.ir);
+  //P = (p.vr*p.ir + p.vi*p.ii);
+  P = if Ctrl == true then Te_sys*nr/w_b else Te_sys;
+  Q = (-p.vr*p.ii) + p.vi*p.ir;
+
   P_motor = P/CoB;
   Q_motor = Q/CoB;
   ns = w_sync/N;

OpenIPSL/Electrical/Machines/PSSE/CIM5.mo

@@ -23,8 +23,7 @@ model CIM5 "PSSE CIM5 three-phase induction motor model"
   parameter Real T_nom = 1 "Load torque at 1 pu speed" annotation (Dialog(group="Machine parameters"));
   parameter Real D = 1 "Load Damping Factor" annotation (Dialog(group="Machine parameters"));
 
-  OpenIPSL.Types.PerUnit Te_motor "Electromagnetic torque in motor base";
-  OpenIPSL.Types.PerUnit Te_sys "Electromagnetic torque in system base";
+
   OpenIPSL.Types.PerUnit TL "Load torque";
 
   OpenIPSL.Types.PerUnit Epr "Real voltage behind transient reactance";

OpenIPSL/Examples/Microgrids/IEEEMicrogrid/Data/package.mo

@@ -1,3 +1,3 @@
 within OpenIPSL.Examples.Microgrids.IEEEMicrogrid;
-package Data
+package Data "Record Data for IEEE Microgrid Example"
 end Data;

OpenIPSL/Examples/Microgrids/IEEEMicrogrid/GeneratorGroups/DieselGeneratorUnit.mo

@@ -1,5 +1,5 @@
 within OpenIPSL.Examples.Microgrids.IEEEMicrogrid.GeneratorGroups;
-model DieselGeneratorUnit
+model DieselGeneratorUnit "Diesel Generation Unit"
   extends OpenIPSL.Interfaces.Generator(V_b = 400);
   Electrical.Machines.PSSE.GENROE gENROE(
     V_b=400,
@@ -51,8 +51,8 @@ equation
     annotation (Line(points={{-59.4,-16},{-21,-16}}, color={0,0,127}));
   connect(sEXS.XADIFD, gENROE.XADIFD) annotation (Line(points={{-2,-31},{-2,-40},
           {70,-40},{70,-18},{62,-18}}, color={0,0,127}));
-  connect(sEXS.EFD0, gENROE.EFD0) annotation (Line(points={{-21,-24},{-26,-24},
-          {-26,-44},{74,-44},{74,-10},{62,-10}}, color={0,0,127}));
+  connect(sEXS.EFD0, gENROE.EFD0) annotation (Line(points={{-21,-24},{-26,-24},{
+          -26,-44},{74,-44},{74,-10},{62,-10}}, color={0,0,127}));
   connect(sEXS.ECOMP, gENROE.ETERM) annotation (Line(points={{-21,-20},{-30,-20},
           {-30,-48},{78,-48},{78,-6},{62,-6}}, color={0,0,127}));
   connect(dEGOV.PMECH,gENROE. PMECH)
@@ -61,10 +61,10 @@ equation
           70,28},{-24,28},{-24,18},{-18,18}}, color={0,0,127}));
   connect(gENROE.PMECH0, dEGOV.PMECH0) annotation (Line(points={{62,10},{74,10},
           {74,32},{-28,32},{-28,6},{-18,6}}, color={0,0,127}));
-  connect(sEXS.VUEL, zero.y) annotation (Line(points={{-14,-31},{-14,-38},{-36,
-          -38},{-36,-16},{-59.4,-16}}, color={0,0,127}));
-  connect(sEXS.VOEL, zero.y) annotation (Line(points={{-10,-31},{-10,-38},{-36,
-          -38},{-36,-16},{-59.4,-16}}, color={0,0,127}));
+  connect(sEXS.VUEL, zero.y) annotation (Line(points={{-14,-31},{-14,-38},{-36,-38},
+          {-36,-16},{-59.4,-16}}, color={0,0,127}));
+  connect(sEXS.VOEL, zero.y) annotation (Line(points={{-10,-31},{-10,-38},{-36,-38},
+          {-36,-16},{-59.4,-16}}, color={0,0,127}));
   annotation (Icon(coordinateSystem(preserveAspectRatio=false)), Diagram(
         coordinateSystem(preserveAspectRatio=false)));
 end DieselGeneratorUnit;

OpenIPSL/Examples/Microgrids/IEEEMicrogrid/GeneratorGroups/package.mo

@@ -1,4 +1,4 @@
 within OpenIPSL.Examples.Microgrids.IEEEMicrogrid;
-package GeneratorGroups
+package GeneratorGroups "Synchronous Generator Group"
   extends Modelica.Icons.ExamplesPackage;
 end GeneratorGroups;