Skip to content

Commit eb48069

Browse files
committed
Transformers: add warning about WdgCurrents/WdgVoltages
1 parent b959d64 commit eb48069

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

opendssdirect/Transformers.py

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -235,17 +235,32 @@ def Idx(*args):
235235

236236

237237
def WdgVoltages():
238-
"""(read-only) Complex array of voltages for active winding"""
238+
"""
239+
(read-only) Complex array of voltages for active winding
240+
241+
WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this
242+
in those situations. For more information, see https://github.com/dss-extensions/dss-extensions/issues/24
243+
"""
239244
return get_float64_array(lib.Transformers_Get_WdgVoltages)
240245

241246

242247
def WdgCurrents():
243-
"""(read-only) All Winding currents (ph1, wdg1, wdg2,... ph2, wdg1, wdg2 ...)"""
248+
"""
249+
(read-only) All Winding currents (ph1, wdg1, wdg2,... ph2, wdg1, wdg2 ...)
250+
251+
WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this
252+
in those situations. For more information, see https://github.com/dss-extensions/dss-extensions/issues/24
253+
"""
244254
return get_float64_array(lib.Transformers_Get_WdgCurrents)
245255

246256

247257
def strWdgCurrents():
248-
"""(read-only) All winding currents in CSV string form like the WdgCurrents property"""
258+
"""
259+
(read-only) All winding currents in CSV string form like the WdgCurrents property
260+
261+
WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this
262+
in those situations. For more information, see https://github.com/dss-extensions/dss-extensions/issues/24
263+
"""
249264
return get_string(CheckForError(lib.Transformers_Get_strWdgCurrents()))
250265

251266

0 commit comments

Comments
 (0)