Difference between revisions of "Hydrodynamics.m"
(Sync syntax/arguments/outputs with current Spinach source) |
(Restore pre-bulk-edit wiki content) |
||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
A basic hydrodynamics infrastructure provider, returns first derivative operators with respect to the three sample coordinates. Periodic boundary conditions are used. | A basic hydrodynamics infrastructure provider, returns first derivative operators with respect to the three sample coordinates. Periodic boundary conditions are used. | ||
==Syntax== | ==Syntax== | ||
| − | [Fx,Fy,Fz]=hydrodynamics( | + | [Fx,Fy,Fz]=hydrodynamics(parameters) |
| + | |||
| + | ==Description== | ||
| + | The function returns finite difference or Fourier differentiation matrices for first derivatives, correctly normalised to account for physical sample dimensions. | ||
==Arguments== | ==Arguments== | ||
| − | parameters.dims - dimensions of the sample (meters), | + | parameters.dims - dimensions of the sample (meters), |
one, two, or three-element row | one, two, or three-element row | ||
vector | vector | ||
| Line 23: | Line 24: | ||
boundary conditions | boundary conditions | ||
| − | == | + | ==Returns== |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | Fx, Fy, Fz - derivative matrices, SI units | |
| − | |||
==Examples== | ==Examples== | ||
| − | |||
This function is used by [[imaging.m]] context in situations when spatial dynamics, such as diffusion and flow, is present in the sample. | This function is used by [[imaging.m]] context in situations when spatial dynamics, such as diffusion and flow, is present in the sample. | ||
==Notes== | ==Notes== | ||
| − | |||
Empty arrays are returned for inactive dimensions. The direct product order is Z(x)Y(x)X(x)Spin, this corresponds to a column-wise vectorization of a 3D array with dimensions ordered as [X Y Z]. | Empty arrays are returned for inactive dimensions. The direct product order is Z(x)Y(x)X(x)Spin, this corresponds to a column-wise vectorization of a 3D array with dimensions ordered as [X Y Z]. | ||
==See also== | ==See also== | ||
| − | |||
[[imaging.m]], [[fdmat.m]], [[v2fplanck.m]], [[fourdif.m]] | [[imaging.m]], [[fdmat.m]], [[v2fplanck.m]], [[fourdif.m]] | ||
''Version 1.10, authors: [[Ahmed Allami]], [[Ilya Kuprov]]'' | ''Version 1.10, authors: [[Ahmed Allami]], [[Ilya Kuprov]]'' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 15:49, 5 April 2026
A basic hydrodynamics infrastructure provider, returns first derivative operators with respect to the three sample coordinates. Periodic boundary conditions are used.
Syntax
[Fx,Fy,Fz]=hydrodynamics(parameters)
Description
The function returns finite difference or Fourier differentiation matrices for first derivatives, correctly normalised to account for physical sample dimensions.
Arguments
parameters.dims - dimensions of the sample (meters),
one, two, or three-element row
vector
parameters.npts - number of points in each dimension
of the sample, one, two, or three-
element row vector
parameters.deriv - {'fourier'} requests Fourier diffe-
rentiation matrices; {'period',n}
requests n-point central finite-
difference matrices with periodic
boundary conditions
Returns
Fx, Fy, Fz - derivative matrices, SI units
Examples
This function is used by imaging.m context in situations when spatial dynamics, such as diffusion and flow, is present in the sample.
Notes
Empty arrays are returned for inactive dimensions. The direct product order is Z(x)Y(x)X(x)Spin, this corresponds to a column-wise vectorization of a 3D array with dimensions ordered as [X Y Z].
See also
imaging.m, fdmat.m, v2fplanck.m, fourdif.m
Version 1.10, authors: Ahmed Allami, Ilya Kuprov
