Skip to content

Commit

Permalink
as see also to docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoMVale committed Dec 9, 2024
1 parent c564489 commit ddc9d99
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions src/polykin/reactors/rtd.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ def E_cstr(t: float, tavg: float) -> float:
-------
float
Differential residence time distribution.
See also
--------
* [`F_cstr`](F_cstr.md): related method to determine the cumulative
distribution.
"""
return (1/tavg)*exp(-t/tavg)

Expand All @@ -64,6 +69,11 @@ def F_cstr(t: float, tavg: float) -> float:
-------
float
Cumulative residence time distribution.
See also
--------
* [`E_cstr`](E_cstr.md): related method to determine the differential
distribution.
"""
return 1 - exp(-t/tavg)

Expand Down Expand Up @@ -92,6 +102,11 @@ def E_tanks_series(t: float, tavg: float, N: int) -> float:
-------
float
Differential residence time distribution.
See also
--------
* [`F_tanks_series`](F_tanks_series.md): related method to determine the
cumulative distribution.
"""
q = t/tavg
if q == inf:
Expand Down Expand Up @@ -124,6 +139,11 @@ def F_tanks_series(t: float, tavg: float, N: int) -> float:
-------
float
Cumulative residence time distribution.
See also
--------
* [`E_tanks_series`](E_tanks_series.md): related method to determine the
differential distribution.
"""
q = t/tavg
if q == 0:
Expand Down Expand Up @@ -161,6 +181,11 @@ def E_laminar_flow(t: float, tavg: float) -> float:
-------
float
Differential residence time distribution.
See also
--------
* [`F_laminar_flow`](F_laminar_flow.md): related method to determine the
cumulative distribution.
"""
q = t/tavg
if q < 1/2:
Expand Down Expand Up @@ -195,6 +220,11 @@ def F_laminar_flow(t: float, tavg: float) -> float:
-------
float
Cumulative residence time distribution.
See also
--------
* [`E_laminar_flow`](E_laminar_flow.md): related method to determine the
differential distribution.
"""
q = t/tavg
if q <= 1/2:
Expand Down Expand Up @@ -240,6 +270,11 @@ def E_dispersion_model(t: float, tavg: float, Pe: float) -> float:
-------
float
Differential residence time distribution.
See also
--------
* [`F_dispersion_model`](F_dispersion_model.md): related method to determine
the cumulative distribution.
"""
q = t/tavg
if q == 0 or q == inf:
Expand Down Expand Up @@ -284,6 +319,11 @@ def F_dispersion_model(t: float, tavg: float, Pe: float) -> float:
-------
float
Cumulative residence time distribution.
See also
--------
* [`E_dispersion_model`](E_dispersion_model.md): related method to determine
the differential distribution.
"""
q = t/tavg
if q == 0:
Expand Down

0 comments on commit ddc9d99

Please sign in to comment.