Skip to content

Commit d33a5eb

Browse files
committed
Fix comments for NFC-HOA
1 parent 6bd867f commit d33a5eb

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

sfs/mono/drivingfunction.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,15 @@ def source_selection_all(N):
162162

163163

164164
def nfchoa_2d_plane(omega, x0, r0, n=[0, 1, 0], c=None):
165-
"""Point source by 2.5-dimensional WFS."""
165+
"""Plane wave by two-dimensional NFC-HOA.
166+
167+
::
168+
__
169+
2i \ i^-m
170+
D(phi0,w) = - ----- /__ ---------- e^(i m (phi0-phi_pw))
171+
pi r0 m=-N..N (2)
172+
Hm (w/c r0)
173+
"""
166174
x0 = np.asarray(x0)
167175
k = util.wavenumber(omega, c)
168176
alpha, beta, r = util.cart2sph(n[0], n[1], n[2])
@@ -179,7 +187,7 @@ def nfchoa_2d_plane(omega, x0, r0, n=[0, 1, 0], c=None):
179187

180188

181189
def nfchoa_25d_point(omega, x0, r0, xs, c=None):
182-
"""Point source by 2.5-dimensional WFS.
190+
"""Point source by 2.5-dimensional NFC-HOA.
183191
184192
::
185193
@@ -206,7 +214,7 @@ def nfchoa_25d_point(omega, x0, r0, xs, c=None):
206214

207215

208216
def nfchoa_25d_plane(omega, x0, r0, n=[0, 1, 0], c=None):
209-
"""Plane wave by 2.5-dimensional WFS.
217+
"""Plane wave by 2.5-dimensional NFC-HOA.
210218
211219
::
212220

0 commit comments

Comments
 (0)