orbithunter.AntisymmetricOrbitKS.dt¶
-
AntisymmetricOrbitKS.
dt
(order=1, array=False, **kwargs)¶ Spectral time derivatives of the current state.
- Parameters
- 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.
- Returns
- orbit_dtnOrbitKS
The class instance whose state is the time derivative in the spatiotemporal mode basis.
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()