updated doc string and changelog

KS-HTK · Sep 6, 2024 · 6fdf9c8 · 6fdf9c8
1 parent 90a63cd
commit 6fdf9c8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -15,6 +15,7 @@ Change Log
 
 [upcoming release] - 2024-..-..
 -------------------------------
+- [ADDED] A switch to disable updating the vk and vkr values for trafo3w
 - [FIXED] cast the column to the correct type before assigning values
 - [FIXED] replacement for deprecated namespaces scipy.sparse.csc and scipy.sparse.csr
 - [FIXED] copy array element to standard python scalar

diff --git a/pandapower/run.py b/pandapower/run.py
@@ -222,6 +222,7 @@ def runpp(net, algorithm='nr', calculate_voltage_angles=True, init="auto",
 
         **tdpf_update_r_theta** (bool, True) - TDPF parameter, whether to update R_Theta in Newton-Raphson or to assume a constant R_Theta (either from net.line.r_theta, if set, or from a calculation based on the thermal model of Ngoko et.al.)
 
+        **update_vk_values** (bool, True) - If True vk_ and vkr_ values of trafo3w are recalculated based on characteristics, otherwise the values from the table are used. Can improve performance for large models.
     """
 
     # if dict 'user_pf_options' is present in net, these options overrule the net._options
-Original file line number
+Diff line change
@@ Expand Up @@
             **tdpf_update_r_theta** (bool, True) - TDPF parameter, whether to update R_Theta in Newton-Raphson or to assume a constant R_Theta (either from net.line.r_theta, if set, or from a calculation based on the thermal model of Ngoko et.al.)
+            **update_vk_values** (bool, True) - If True vk_ and vkr_ values of trafo3w are recalculated based on characteristics, otherwise the values from the table are used. Can improve performance for large models.
         """
         # if dict 'user_pf_options' is present in net, these options overrule the net._options
@@ Expand Down @@