nlcpy.sca.create_descriptor

nlcpy.sca.create_descriptor(arrays)

Returns one or more stencil descriptors.

Creates stencil descriptor from ndarrays.

Parameters:
arraysndarray or sequence of ndarray

Ndarrays to be used as input or output of stencil calculations.

Returns:
outsequence of nlcpy.sca.descriptor.descriptor

The stencil descriptor.

Note

For usage of the stencil descriptor, see Basic Usage and Advanced Usage.

Examples

>>> import nlcpy as vp
>>> xin = vp.arange(10, dtype='f4')
>>> xout = vp.zeros_like(xin)
>>> dxin, dxout = vp.sca.create_descriptor((xin, xout))