Gradient¶

About the `Gradient` class¶

The WaveBlocks Project

@author: R. Bourquin @copyright: Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016 R. Bourquin @license: Modified BSD License

Inheritance diagram¶

Inheritance diagram of Gradient

Class documentation¶

class WaveBlocksND.Gradient[source]¶

This class implements the computation of the action of the gradient operator $-i \varepsilon^2 \nabla_x$ .

apply_gradient(wavepacket, *, component=None)[source]¶

Compute the effect of the gradient operator $-i \varepsilon^2 \nabla_x$ on the basis functions $\phi(x)$ of a component $\Phi_i$ of a wavepacket $\Psi$ .

Parameters:	wavepacket – The wavepacket $\Psi$ containing $\Phi_i$ . component (Integer or `None`.) – The index $i$ of the component $\Phi_i$ .
Returns:	Extended basis shape $\mathfrak{\dot{K}}$ and new coefficients $c^\prime$ .