From 2613fad4cc685de3a9b501c7be93ae49fa31a5c5 Mon Sep 17 00:00:00 2001
From: mcosovic <mirsad.cosovic@gmail.com>
Date: Fri, 15 Nov 2024 12:58:59 +0100
Subject: [PATCH] update docs

---
 src/data/case14.h5            | Bin 48372 -> 48348 bytes
 src/data/case14.m             |  28 ++++++++++++++--------------
 src/measurement/pmu.jl        |   2 ++
 src/measurement/powermeter.jl |   4 ++++
 src/measurement/voltmeter.jl  |   2 ++
 src/powerSystem/branch.jl     |   2 ++
 src/powerSystem/bus.jl        |   5 ++++-
 src/powerSystem/generator.jl  |   3 +++
 8 files changed, 31 insertions(+), 15 deletions(-)

diff --git a/src/data/case14.h5 b/src/data/case14.h5
index 7d94943985a974f31d8c2561a6e5eda6f20d0aea..a29c79b38a530857347b770c856ef0f964dbd956 100644
GIT binary patch
delta 2046
zcmbVNeN0<b6o2=$KwDUO40O<a<iQ^eAC52x9iq;T7{tynh7qt%Eg+L`37@(UVa5++
zZfiNP;9N2U1j0vGxE<RXW6(d$vglI(a883uCB$HyhAhUg4HIwsUf(O|vc#9PC+By5
z=i}ac&b@!$fyFyuPbQ0wl!F9j-%N{8Kk~Kk8oIKLcrD_quI|{V{T%xqEZ5B<@Bd4}
z0`$cDqi~#_{g_UtG-)c{Z}5LXNq>pdsnN`5puJr{m&pQl4X&GnVCe=db?b4-o#AjM
zV^dlb9gTTerRB6@6d!IGND!&E{2uChXgC&pT67Ky5&orfoZT@yfPCtlc17~g%N}$k
zby5v~X_aigE*p){&=GP3@0k+Cu)<y&o!GOag6lee*Z@df*%m@>$|Nf6EmlKeq!P)M
zeTe@0SOS61LqKy$CR(3Zf%GUj5<8niczNFsVA_Of&7WZBlnx6o7-3(CEh8qElsRT!
zLUX(ZhxS`!QvQFDhFYTNa$boF3ZwAxe5rU_ev%qaZrQX+)O^6BBB$|Qp}24=9IPc^
z(&KtzaM48;0@w9&?NlhvC2%u@(fyp2z+2I>%iQw@0=sy{!(5W824e_dx3UoFA;9X3
ztT>Ybptro54%u`B_9-CsmRAtSR{%c?7b@>Up@LE0tE`$5222GPeq@e7X$X*0-A@7s
zI^wMXT#YV5Z(XuR>@1GMwK|VuLEi-;u==DZHRhv#Khx=4K57o==5wMHjsAa0*NC!b
zM3n#HNp>zMUyyj`C4Wx(@^}e&5Haq)Jp4(QNUzqPR-?W79kH#wH9d5w<u>4%xLxRK
zw}7_}*W1O7LjNdDbevH^SztRij#3WM(MLOvsldkLA5_{}Uso-`$(|%}JerPK)T97s
z2BlW=z01a>2!E%NUi7||kT(?F+r#uBMK9`Q{40w8!tqo>yo%1B$Ry;3tRsKIj%z1}
ziBE>;!YSsmqUgLMj_4OX!A-TzCPrgs-(m74p6c7CUjDA)FrDnP0$G(^{86cA;5Lvo
z1v8fz@YdiB;2PwnW+QCJ+K;TD*@X3eYz0096MeI2>Deq5*-DR}t5HKdvj^MLFq%a0
z#|j>w{ZyYCCRKVr$#Z;w(L09vix1;OszIC3Ao^U9Z#Wb>3^+X_V1;cv=5|D3ol~nW
z-Cf;`1!H+w5FxO8H4{A<Jl-1X75jpD(EjmwHT<kphKA8@ES?r%_&k0#nvTQM#ZsLn
z$a4nsWBrVH{2Q{q;@pnlG)u{L;CmB0aB@VqAtCmU8)1pX9<L;Q$h-Q$>ZZA>d>|hD
zZSI5QVps6k{E~2y;^QH`Ai<rObO$OijOW5qgWQ>{7~|Has^;BojWw-8a#LGMAQswe
zJLCM59(;z{U$1B8k`zqLcp5EZk@$^U7iOW1fge&MuBGLm;er)(jY?!TLhM0`!L0dh
zq!<s(*Fa{Y(iQBY#=)=xc7gb>YHi=8Kwd5fzs-vcFK@0Y&zr}yBV~}we54M*oa%1v
wRhj5$F@&os+FI_q@rymNc<oX+ynPX!(@#;uWlD6+BD7Yuv<j8<d(Tez2MKh99smFU

delta 1623
zcmZ9Me@s(X6vy8^eM@P9QlJWS>K^<-7-Xb^D5B2F5=QD$JGOPEY@{d{fx?JI#&ns*
zY#FIhTMn4&+y=<604=3g3L|V||L})dSpPCxvzdl0L=&?S!XJoa?zOM<RbJ9G_jAuV
z_x$+Y`{y%Qe+G^`vhIBS6j4uoRv=~PFaLE8y(PK0Bwds+jT`hu!f}a`iF~WaxBsa=
zNzP)R$$+Po8s|bLwpN?Kk$@f-w;e&9OnB??FZ>y?v-hxsVe*_)Z(wUd5*<vfk;q&L
z!fptYd$R;bb43^R?ixsk4p}&wG@K8^IGj_xsLc1tY%;+^5%Zvr^T$}YA;YbM(X&HW
z%rsLYC-7e!<PMqX=>BC1w8&#wQg4Zlkam22FgtQM<qlP`WF@xd`|vJ(awLm@F;NV!
zH5Q@i*kf2sj0FlC;ty~B0ZTiWOxusY_LRayk$0ac!!3Ue_MOm0wjS-=GGd=KiT+(~
zl)y?N9<30nqUMSm7IKq!G=*wU&PhliKG$!TaH^4zC2{RF=m@kZVyRNDs*FIp0=M+h
zz_#~H1a_yyfbRn}0e_0<p*7~S@KYRcnD`KjabUHY&uvKr7^po@`^@|Z9*U3#YR?dO
zB!aLNE}Y$j6_L?U9iPoVJQ&}u`<#!!zaqfR85^BFuOg9=-3v4Ta+W+aSmsclm`OLA
zZ?RJg8iI}sUkZu}G<4BE>l)xhj}nunIeefhg;l=Z_NZQhG&i}fp}D@r+VDw>rQT}A
zk3HG=-SlqsnfKArPwz-TtK89dUW}zAhaUdCQv#JrteK8x8@kd+AkZX&)=nJ@tr2%Y
zW1+A3fo#NC7``?U)OF?v+kq~={z{7&z+mU?JK_Q?T+1h5iv!B*MTE4X+a*W<mDe4(
zabtjV#1LJ$nNNsKTq~U_qFA33?h?a%yQW{lqVA7K5N~#8uz9zR&d{-L6OgW$OE@Z>
z>s<rl5SiAf#;2~|iAzM@5(hTkHj%!Uk^LJJ85NP>SWG{>TPz_udhPoL7Q7a5=<2~7
zLXz>=&|XY)=gI8DLZ$}n&(BCzGQxXQ?h$AgI;H8ttb;?Pc)`Wt88?Ta-h}W=gT~<l
zxKXeNzwoH=>LiDbgK7A5*e<mD(nt{tQ{u^}9<*WA1P8%MoF6R2fr%=#+*aZ{Lkd0<
z4lAW)XmJa(!r)LD)_DpM{3=v<4!n}YXc!iMa~Gqd!tl~LcxglnYA?=@oP`G-%pT3f
z7n4n-n>Kmh23YgqR(}l!%H+6*a$xtOetcg<syb;Y_(U;8-kB#yQegQ$sx^AF-`^#<
zN*P=&(4x*S=UogCj5Ft@&$l2IU-f6m8fS!VY0#<4!ug&`facg8k3LFd46A2e1Ct-`
z-aAd?=pK(siobJY886S~LfSO`vOisFZL4j&XuU&!oZTSu@{3mP{d#K~_ZIzmZZG@~
Du3Mh7

diff --git a/src/data/case14.m b/src/data/case14.m
index 49201d9e0..fc7a6044b 100644
--- a/src/data/case14.m
+++ b/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
diff --git a/src/measurement/pmu.jl b/src/measurement/pmu.jl
index c6e1eb37f..837a68076 100644
--- a/src/measurement/pmu.jl
+++ b/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.
 
diff --git a/src/measurement/powermeter.jl b/src/measurement/powermeter.jl
index c7aec27dc..8a23debd8 100644
--- a/src/measurement/powermeter.jl
+++ b/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.
 
diff --git a/src/measurement/voltmeter.jl b/src/measurement/voltmeter.jl
index e26ffb756..92e19a50e 100644
--- a/src/measurement/voltmeter.jl
+++ b/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.
 
diff --git a/src/powerSystem/branch.jl b/src/powerSystem/branch.jl
index bf6b4bf5b..1c413dd12 100644
--- a/src/powerSystem/branch.jl
+++ b/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
diff --git a/src/powerSystem/bus.jl b/src/powerSystem/bus.jl
index 4a8dcf8b7..ba8c8a5e5 100644
--- a/src/powerSystem/bus.jl
+++ b/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.
 
diff --git a/src/powerSystem/generator.jl b/src/powerSystem/generator.jl
index e5754f24f..4469f3b83 100644
--- a/src/powerSystem/generator.jl
+++ b/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