orbithunter.OrbitKS.dx

OrbitKS.dx(**kwargs)

Spatial derivative of the current state.

Parameters

kwargs :

order :int

The order of the derivative.

arraybool

Whether or not to return a numpy array. Used for efficiency/avoiding construction of redundant Orbit instances.

computation_basisstr

The basis in which to compute the derivative.

return_basisstr

Which basis to return the ShiftReflectionOrbitKS in, if array=False.

Returns

orbit_dxnOrbitKS or subclass instance

Class instance whose spatiotemporal state represents the spatial derivative in the the basis of the original state.

Notes

It is very often the case that the derivative in the field basis is desired. Instead of forcing the user to write self.transform(to=’modes’).dt().transform(to=’field’), the functions are written to incur extra overhead by transforming behind the scenes. To avoid unnecessary slow down, the OrbitKS instances must be in the modes basis to compute self.eqn()