Skip to content

Commit 12b0aba

Browse files
committed
Enhanced documentation
1 parent 5ecb23b commit 12b0aba

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

sfs/mono/source.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,17 @@ def point_modal(omega, x0, n0, grid, L, N=None, deltan=0, c=None):
4242
N : triple of integers or integer
4343
Combination of modal orders in the three-spatial dimensions to
4444
calculate the sound field for or maximum order for all dimensions.
45-
If not given, the maximum modal order is determined and the sound
46-
field is computed up to this max.
45+
If not given, the maximum modal order is approximately determined and
46+
the sound field is computed up to this maximum order.
4747
deltan : float
4848
Absorption coefficient of the walls.
4949
c : float
5050
Speed of sound.
5151
5252
Returns
5353
-------
54+
p : array of floats
55+
Sound pressure at positions given by grid
5456
5557
"""
5658
k = util.wavenumber(omega, c)

0 commit comments

Comments
 (0)