Update documentation of quasi-static AC machines (modelica#3874)

* updated documentation of quasi-static AC machines * update comment string * removed various occurences of "quasi-static AC machines" * Remove white space noise. Co-authored-by: Dietmar Winkler <dietmar.winkler@dwe.no>
wischhusen · Sep 30, 2021 · 24f556f · 24f556f
1 parent f095aa0
commit 24f556f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 11 deletions.
diff --git a/Modelica/Electrical/QuasiStatic/Machines/BasicMachines/Components/package.mo b/Modelica/Electrical/QuasiStatic/Machines/BasicMachines/Components/package.mo
@@ -1,9 +1,10 @@
 within Modelica.Electrical.QuasiStatic.Machines.BasicMachines;
-package Components "Machine components like AirGaps"
+package Components "Machine components"
   extends Modelica.Icons.Package;
+
   annotation (Documentation(info="<html>
 <p>
-This package contains components for modeling electrical machines, specially three-phase induction machines, based on space phasor theory.
+This package contains components for modeling electrical machines.
 </p>
 </html>"));
 end Components;
diff --git a/Modelica/Electrical/QuasiStatic/Machines/BasicMachines/package.mo b/Modelica/Electrical/QuasiStatic/Machines/BasicMachines/package.mo
@@ -28,12 +28,17 @@ package BasicMachines "Basic machine models"
           fillPattern=FillPattern.Solid,
           points={{-70,-90},{-60,-90},{-30,-20},{20,-20},{50,-90},{60,-90},{
               60,-100},{-70,-100},{-70,-90}})}), Documentation(info="<html>
-This package contains components for modeling quasi-static electrical induction machines, based on space phasor theory:
+<p>This package contains components for modeling quasi-static electrical induction machines, based on space phasor theory:</p>
 <ul>
-<li>package InductionMachines: quasi-static models of three-phase induction machines</li>
-<li>package SynchronousMachines: quasi-static models of three-phase synchronous machines</li>
 <li>package Transformers: quasi-static three-phase transformers (see detailed documentation in subpackage)</li>
-<li>package Components: components for quasi-static modeling machines and transformers</li>
+<li>package Components: components for quasi-static modeling of transformers</li>
 </ul>
+<h4>Note</h4>
+<p>
+Quasi-static AC machines (induction machines and synchronous machines) based on space phasor therory are not implemented. 
+Use <a href=\"modelica://Modelica.Magnetic.QuasiStatic.FundamentalWave\">quasi-static fundamental wave machines</a> instead. 
+Fundamental wave machines (transient and quasi-static) are compatible with models based on space phasor theory with respect to connectors and parameters.
+For a discrimination of various machine models, see <a href=\"modelica://Modelica.Electrical.Machines.UsersGuide.Discrimination\">discrimination</a>.
+</p>
 </html>"));
 end BasicMachines;
diff --git a/Modelica/Electrical/QuasiStatic/Machines/Interfaces/package.mo b/Modelica/Electrical/QuasiStatic/Machines/Interfaces/package.mo
@@ -4,7 +4,7 @@ package Interfaces "SpacePhasor connector and PartialMachines"
 
   annotation (Documentation(info="<html>
 <p>
-This package contains the quasi-static space phasor connector and partial models for quasi-static machine models.
+This package contains partial models for quasi-static transformer and spcae phasor models.
 </p>
 </html>"));
 end Interfaces;
diff --git a/Modelica/Electrical/QuasiStatic/Machines/package.mo b/Modelica/Electrical/QuasiStatic/Machines/package.mo
@@ -32,13 +32,12 @@ package Machines "Quasi-static machine models"
 <p>
 Copyright &copy; 1998-2020, Modelica Association and contributors
 </p>
-<p>This package hosts models for quasi-static induction machines and transformers.
+<p>This package hosts models for quasi-static transformers.
 </p>
 <h4>Note</h4>
 <p>
-Quasi-static DC machines are still operated with Dc voltage and current, whereas the quasi-static induction machines and transformers
-are operated with sinusoidal voltages and currents represented by time phasors. Quasi-static theory can be found in the
-<a href=\"modelica://Modelica.Electrical.QuasiStatic.UsersGuide.References\">references</a>.
+Quasi-static DC machines are still operated with DC voltage and current, whereas the quasi-static transformers
+are operated with sinusoidal voltages and currents represented by time phasors. 
 Quasi-static DC machine models therefore are part of the
 <a href=\"modelica://Modelica.Electrical.Machines.BasicMachines.QuasiStaticDCMachines\">machines library</a>.
 </p>