The Public API
PeriodicOrbits.PeriodicOrbit
— TypeA structure that contains information about a periodic orbit.
points::StateSpaceSet
- points of the periodic orbit. This container always holds the complete orbit.T::Real
- the period of the orbitstable::Union{Bool, Missing}
- local stability of the periodic orbit. Unknown stability is set tomissing
.
PeriodicOrbits.InitialGuess
— TypeA structure that contains an initial guess for a periodic orbit detection algorithms.
u0::AbstractArray{<:Real}
- guess of a point in the periodic orbitT::Union{Real, Nothing}
- guess of period of the orbit. Some algorithms do not require the period guess to be given, in which caseT
is set tonothing
.
PeriodicOrbits.periodic_orbit
— Functionperiodic_orbit(ds::DynamicalSystem, alg::PeriodicOrbitFinder, ig::InitialGuess = InitialGuess(ds)) → PeriodicOrbit
Try to find single periodic orbit of the dynamical system ds
using the algorithm alg
given some initial guess ig
. For more details on the periodic orbit detection algorithms, see the documentation of the specific algorithm.
PeriodicOrbits.periodic_orbits
— Functionperiodic_orbit(ds::DynamicalSystem, alg::PeriodicOrbitFinder, igs::Vector{InitialGuess} = InitialGuess(ds)) → Vector{PeriodicOrbit}
Try to find multiple periodic orbits of the dynamical system ds
using the algorithm alg
given some initial guesses igs
. For more details on the periodic orbit detection algorithms, see the documentation of the specific algorithm.