Skip to content

Commit 381a269

Browse files
committed
fix docstring
1 parent acb7f93 commit 381a269

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

src/pyfvtool/source.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ def constantSourceTerm(gamma: CellVariable):
2222
Returns
2323
-------
2424
RHS: np.ndarray
25-
Right hand side of the source term
25+
Right hand side term corresponding to a constant source. (The
26+
corresponding matrix term is zero.)
2627
2728
Examples
2829
--------
@@ -70,15 +71,16 @@ def linearSourceTerm(beta: CellVariable):
7071
7172
Returns
7273
-------
73-
RHS: np.ndarray
74-
Right hand side of the source term
74+
M: scipy.sparse.csr_array
75+
Matrix term corresponding to a linear source. (The corresponding RHS is
76+
zero.)
7577
7678
Examples
7779
--------
7880
>>> import pyfvtool as pf
7981
>>> m = pf.Grid1D(10, 1.0)
8082
>>> beta = pf.CellVariable(m, 1.0)
81-
>>> RHS = pf.linearSourceTerm(beta)
83+
>>> M = pf.linearSourceTerm(beta)
8284
"""
8385
m = beta.domain
8486
if issubclass(type(m), Grid1D):

0 commit comments

Comments
 (0)