update docs

src/data/case14.m

@@ -22,20 +22,20 @@
 %% bus data
 %	bus_i	type	Pd	Qd	Gs	Bs	area	Vm	Va	baseKV	zone	Vmax	Vmin
 mpc.bus = [
-	1	3	0       0       0	0	1	1.06        0	0	1	1.06	0.94;
-	2	2	21.7	12.7	0	0	1	1.045	-4.98	0	1	1.06	0.94;
-	3	2	94.2	19      0	0	1	1.01	-12.72	0	1	1.06	0.94;
-	4	1	47.8	-3.9	0	0	1	1.019	-10.33	0	1	1.06	0.94;
-	5	1	7.6     1.6     0	0	1	1.02	-8.78	0	1	1.06	0.94;
-	6	2	11.2	7.5     0	0	1	1.07	-14.22	0	1	1.06	0.94;
-	7	1	0       0       0	0	1	1.062	-13.37	0	1	1.06	0.94;
-	8	2	0       0       0	0	1	1.09	-13.36	0	1	1.06	0.94;
-	9	1	29.5	16.6	0	19	1	1.056	-14.94	0	1	1.06	0.94;
-	10	1	9       5.8     0	0	1	1.051	-15.1	0	1	1.06	0.94;
-	11	1	3.5     1.8     0	0	1	1.057	-14.79	0	1	1.06	0.94;
-	12	1	6.1     1.6     0	0	1	1.055	-15.07	0	1	1.06	0.94;
-	13	1	13.5	5.8 	0	0	1	1.05	-15.16	0	1	1.06	0.94;
-	14	1	14.9	5       0	0	1	1.036	-16.04	0	1	1.06	0.94;
+	1	3	0       0       0	0	1	1.06        0	230	1	1.06	0.94;
+	2	2	21.7	12.7	0	0	1	1.045	-4.98	230	1	1.06	0.94;
+	3	2	94.2	19      0	0	1	1.01	-12.72	230	1	1.06	0.94;
+	4	1	47.8	-3.9	0	0	1	1.019	-10.33	230	1	1.06	0.94;
+	5	1	7.6     1.6     0	0	1	1.02	-8.78	230	1	1.06	0.94;
+	6	2	11.2	7.5     0	0	1	1.07	-14.22	115	1	1.06	0.94;
+	7	1	0       0       0	0	1	1.062	-13.37	115	1	1.06	0.94;
+	8	2	0       0       0	0	1	1.09	-13.36	115	1	1.06	0.94;
+	9	1	29.5	16.6	0	19	1	1.056	-14.94	115	1	1.06	0.94;
+	10	1	9       5.8     0	0	1	1.051	-15.1	115	1	1.06	0.94;
+	11	1	3.5     1.8     0	0	1	1.057	-14.79	115	1	1.06	0.94;
+	12	1	6.1     1.6     0	0	1	1.055	-15.07	115	1	1.06	0.94;
+	13	1	13.5	5.8 	0	0	1	1.05	-15.16	115	1	1.06	0.94;
+	14	1	14.9	5       0	0	1	1.036	-16.04	115	1	1.06	0.94;
 ];
 
 %% generator data

src/measurement/pmu.jl

@@ -34,6 +34,8 @@ The PMU is defined with the following keywords:
   * `polar = true`: adopts the polar coordinate system,
   * `polar = false`: adopts the rectangular coordinate system.
 
+Note that all voltage values are referenced to line-to-neutral voltages.
+
 # Updates
 The function updates the `pmu` field of the `Measurement` composite type.
 

src/measurement/powermeter.jl

@@ -21,6 +21,8 @@ The wattmeter is defined with the following keywords:
   * `status = 1`: in-service,
   * `status = 0`: out-of-service.
 
+Note that when powers are given in SI units, they correspond to three-phase power.
+
 # Updates
 The function updates the `wattmeter` field of the `Measurement` composite type.
 
@@ -105,6 +107,8 @@ The varmeter is defined with the following keywords:
   * `status = 1`: in-service,
   * `status = 0`: out-of-service.
 
+Note that when powers are given in SI units, they correspond to three-phase power.
+
 # Updates
 The function updates the `varmeter` field of the `Measurement` composite type.
 

src/measurement/voltmeter.jl

@@ -19,6 +19,8 @@ The voltmeter is defined with the following keywords:
   * `status = 1`: in-service,
   * `status = 0`: out-of-service.
 
+Note that all voltage values are referenced to line-to-neutral voltages.
+
 # Updates
 The function updates the `voltmeter` field of the `Measurement` composite type.
 

src/powerSystem/branch.jl

@@ -37,6 +37,8 @@ The branch is defined with the following keywords:
   * `type = 2`: active power flow (pu or W),
   * `type = 3`: current magnitude flow (pu or A).
 
+Note that when powers are given in SI units, they correspond to three-phase power.
+
 # Updates
 The function updates the `branch` field within the `PowerSystem` composite type, and in
 cases where parameters impact variables in the `ac` and `dc` fields, it automatically

src/powerSystem/bus.jl

@@ -19,10 +19,13 @@ The bus is defined with the following keywords:
 * `angle` (rad or deg): Initial value of the bus voltage angle.
 * `minMagnitude` (pu or V): Minimum bus voltage magnitude value.
 * `maxMagnitude` (pu or V): Maximum bus voltage magnitude value.
-* `base` (V): Voltage base value.
+* `base` (V): Line-to-line voltage base value.
 * `area`: Area number.
 * `lossZone`: Loss zone.
 
+Note that all voltage values, except for base voltages, are referenced to line-to-neutral
+voltages, while powers, when given in SI units, correspond to three-phase power.
+
 # Updates
 The function updates the `bus` field of the `PowerSystem` composite type.
 

src/powerSystem/generator.jl

@@ -39,6 +39,9 @@ The generator is defined with the following keywords:
 * `reactiveRamp` (pu/min or VAr/min): Ramp rate for reactive power, two seconds timescale.
 * `area`: Area participation factor.
 
+Note that voltage magnitude values are referenced to line-to-neutral voltages, while powers,
+when given in SI units, correspond to three-phase power.
+
 # Updates
 The function updates the `generator` field within the `PowerSystem` composite type, and in
 cases where parameters impact variables in the `bus` field, it automatically adjusts the