orbithunter.core.Orbit.eqn

Orbit.eqn(*args, **kwargs)

Return an instance whose state is an evaluation of the governing equations.

Returns

Orbit :

Orbit instance whose state equals evaluation of governing equation.

Notes

If self.eqn().state = 0. at every point (within some numerical tolerance), then the state constitutes a solution to the governing equation. The instance needs to be in ‘spatiotemporal’ basis prior to computation; this avoids possible mistakes in the optimization process, which would result in a breakdown in performance from redundant transforms. If you do not like this choice then overwrite this method.

Additionally, the equations and state are defined such that state + parameters are required to compute the governing equations. Often it is the case that there will not be an associated component of the equations for the parameters themselves. Therefore, because the parameters in the continuous case define the spatiotemporal domain (tile), it makes sense for these values to be assigned to the “eqn” orbit. That is, the evaluation of the governing equations yields a state defined on the same domain.

Warning

If equation has components for any parameters: However, if the equations of motion have components for the parameters; this will in correctly overwrite the components stored in parameters and this will need an overwrite.