Difference between revisions of "Fdlap.m"
(Sync syntax/arguments/outputs with current Spinach source) |
(Update function See also links and function index membership) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:fdlap.m}} __NOTOC__ | {{DISPLAYTITLE:fdlap.m}} __NOTOC__ | ||
| − | |||
Returns a finite-difference representation of the Laplacian for an array with a user-specified finite difference stencil size. The resulting operator is a sparse matrix designed to act on the vectorisation of the array. The dimensions of the array are assumed to be ordered as [X Y Z]. | Returns a finite-difference representation of the Laplacian for an array with a user-specified finite difference stencil size. The resulting operator is a sparse matrix designed to act on the vectorisation of the array. The dimensions of the array are assumed to be ordered as [X Y Z]. | ||
==Syntax== | ==Syntax== | ||
| − | L=fdlap( | + | L=fdlap(npoints,extents,nstenc) |
| − | == | + | ==Parameters== |
| − | dims - a one-element, two-element, or three-element | + | dims - a one-element, two-element, or three-element |
vector specifying the number of discretisation | vector specifying the number of discretisation | ||
points in each dimension of the 1D, 2D, or 3D | points in each dimension of the 1D, 2D, or 3D | ||
| Line 25: | Line 24: | ||
==Outputs== | ==Outputs== | ||
| − | L - a sparse matrix designed to act on the vectori- | + | L - a sparse matrix designed to act on the vectori- |
zation of the 3D array. The dimensions of that | zation of the 3D array. The dimensions of that | ||
array are assumed to be ordered as [X Y Z]. | array are assumed to be ordered as [X Y Z]. | ||
==See also== | ==See also== | ||
| − | + | [[fdvec.m]], [[fdmat.m]], [[fdhess.m]], [[fdkup.m]], [[fdweights.m]], [[fftdiff.m]], [[fourdif.m]], [[fourlap.m]], [[cgsppm2ang.m]], [[corrfun.m]], [[fpl2phan.m]], [[fpl2rho.m]], [[hydrodynamics.m]], [[interpmat.m]], [[oscillator.m]], [[overwound.m]], [[phan2fpl.m]], [[points2mult.m]], [[qform2sph.m]], [[qxspen_kernel.m]], [[spden.m]], [[Hyperfine_shift_module]], [[Kernel_utilities]] | |
| − | [[fdvec.m]], [[fdmat.m]], [[fdhess.m]], [[fdkup.m]], [[fdweights.m]], [[fftdiff.m]], [[fourdif.m]], [[fourlap.m]] | ||
| − | |||
''Version 2.2, authors: [[Ilya Kuprov]]'' | ''Version 2.2, authors: [[Ilya Kuprov]]'' | ||
Latest revision as of 19:36, 6 June 2026
Returns a finite-difference representation of the Laplacian for an array with a user-specified finite difference stencil size. The resulting operator is a sparse matrix designed to act on the vectorisation of the array. The dimensions of the array are assumed to be ordered as [X Y Z].
Syntax
L=fdlap(npoints,extents,nstenc)
Parameters
dims - a one-element, two-element, or three-element
vector specifying the number of discretisation
points in each dimension of the 1D, 2D, or 3D
array of data that the operator will be acting
on, ordered as [X Y Z].
extents - a one-element, two-element, or three-element
vector specifying the size of each dimension
of the array, ordered as [X Y Z].
nstenc - number of finite-difference stencil points for
the finite-difference approximation; periodic
boundary conditions are used
Outputs
L - a sparse matrix designed to act on the vectori-
zation of the 3D array. The dimensions of that
array are assumed to be ordered as [X Y Z].
See also
fdvec.m, fdmat.m, fdhess.m, fdkup.m, fdweights.m, fftdiff.m, fourdif.m, fourlap.m, cgsppm2ang.m, corrfun.m, fpl2phan.m, fpl2rho.m, hydrodynamics.m, interpmat.m, oscillator.m, overwound.m, phan2fpl.m, points2mult.m, qform2sph.m, qxspen_kernel.m, spden.m, Hyperfine_shift_module, Kernel_utilities
Version 2.2, authors: Ilya Kuprov
