GradientLCWP¶

About the `GradientLCWP` class¶

The WaveBlocks Project

Inheritance diagram¶

Class documentation¶

class WaveBlocksND.GradientLCWP[source]¶

This class implements the computation of the action of the gradient operator $-i \varepsilon^2 \nabla_x$ applied to a linear combination $\Upsilon$ of arbitrary wavepackets.

apply_gradient(lincomb, component=None)[source]¶

Compute the effect of the gradient operator $-i \varepsilon^2 \nabla_x$ applied to a linear combination $\Upsilon$ of arbitrary wavepackets.

Parameters:	lincomb (A `LinearCombinationOfWPs` instance.) – The lincomb $\Upsilon$ containing the wavepackets $\Psi_j$ . component (Integer or `None`.) – The index $i$ of the component $\Phi_i$ of each $\Psi_j$ .
Returns:	A list of linear combinations of the gradients of all packets from the given linearcombination. There are $D$ linearcombinations $\Upsilon_d$ , one for each space variable component $\partial_{x_d}$ of the gradient.