template.class_template.SymmetryOrbitEQN._dimension_indexing_order

classmethod SymmetryOrbitEQN._dimension_indexing_order()

Indicates whether numpy indexing corresponds to increasing or decreasing values configuration space variable

Returns

tuple :

A tuple of bool, one for each continuous dimension which indicates whether positively increasing indices indicate the ‘positive direction’ in configuration space.

Notes

This is mainly for compatibility for the “upwards” time convention in the field of Physics, used for the Kuramoto-Sivashinsky equation. That is, the last element along the time axis, i.e. index = -1 corresponds to t=0 if False, t=T if True, where T is the temporal period of the Orbit.

User implementation will likely always have True for the number of dimensions.