Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise dc_ohmic_loss and dc_ohms_from_percent docstrings #2229

Merged
merged 6 commits into from
Sep 27, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 38 additions & 29 deletions pvlib/pvsystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -2872,45 +2872,47 @@ def dc_ohms_from_percent(vmp_ref, imp_ref, dc_ohmic_percent,
modules_per_string=1,
strings=1):
"""
cwhanse marked this conversation as resolved.
Show resolved Hide resolved
Calculates the equivalent resistance of the wires from a percent
ohmic loss at STC.

Equivalent resistance is calculated with the function:

.. math::
Rw = (L_{stc} / 100) * (Varray / Iarray)

:math:`Rw` is the equivalent resistance in ohms
:math:`Varray` is the Vmp of the modules times modules per string
:math:`Iarray` is the Imp of the modules times strings per array
:math:`L_{stc}` is the input dc loss percent
Calculate the equivalent resistance of the conductors from the percent
ohmic loss of an array at reference conditions.

Parameters
----------
vmp_ref: numeric
Voltage at maximum power in reference conditions [V]
Maximum power voltage of one module at reference conditions. [V]
imp_ref: numeric
Current at maximum power in reference conditions [V]
dc_ohmic_percent: numeric, default 0
input dc loss as a percent, e.g. 1.5% loss is input as 1.5
Maximum power current of one module at reference conditions. [A]
dc_ohmic_percent: numeric
Array DC power loss as a percent of DC power loss at reference
conditions. In percent, e.g. 1.5% loss is input as 1.5.
modules_per_string: int, default 1
Number of modules per string in the array.
Number of series-connected modules per string in the array.
strings: int, default 1
Number of parallel strings in the array.

Returns
----------
Rw: numeric
Equivalent resistance [ohm]
Equivalent resistance. [ohm]

See Also
--------
pvlib.pvsystem.dc_ohmic_losses

References
----------
.. [1] PVsyst 7 Help. "Array ohmic wiring loss".
https://www.pvsyst.com/help/ohmic_loss.htm
Notes
-----
Equivalent resistance is calculated as:

.. math::

Rw = (L_{stc} / 100) \times (Varray / Iarray)
cwhanse marked this conversation as resolved.
Show resolved Hide resolved

:math:`Rw` is the equivalent resistance in ohms.
:math:`Varray` is the array voltage, equal to ``vmp_ref`` times
``modules_per_string``.
:math:`Iarray` is the array current, equal to ``imp_ref`` times
``strings``.
cwhanse marked this conversation as resolved.
Show resolved Hide resolved
:math:`L_{stc}` is the input DC loss percent at reference conditions.

"""
vmp = modules_per_string * vmp_ref

Expand All @@ -2929,23 +2931,30 @@ def dc_ohmic_losses(resistance, current):
Parameters
----------
resistance: numeric
Equivalent resistance of wires [ohm]
Equivalent resistance of wires. [ohm]
current: numeric, float or array-like
Operating current [A]
Operating current. [A]

Returns
----------
loss: numeric
Power Loss [W]
Power loss. [W]

See Also
--------
pvlib.pvsystem.dc_ohms_from_percent

References
----------
.. [1] PVsyst 7 Help. "Array ohmic wiring loss".
https://www.pvsyst.com/help/ohmic_loss.htm
Notes
-----
Ohmic (also termed joule or heat) loss is the power lost due to current
flowing through a conductor. Ohmic loss :math:`L` is computed as
cwhanse marked this conversation as resolved.
Show resolved Hide resolved

.. math::

L = I \times R^2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be L = I^2 R


where :math:`I` is the current (A) and :math:`R` is the resistance of the
conductor (ohms).
"""
return resistance * current * current

Expand Down
Loading