Circular Restricted Three Body Problem (CRTBP)

CrtbpP1

Empty struct identifying the first (usually larger) primary in the CRTBP.

See also: CrtbpP2

CrtbpP2

Empty struct identifying the second (usually smaller) primary in the CRTBP.

See also: CrtbpP1

CrtbpSystem{T, D <: Union{T, Nothing}}(μ::T, name::String, char_mass::D, char_length::D, char_time::D)

Struct defining the parameters for the Crtbp System. Contains the mass ratio parameter, $\mu$, as well as the system name and characteristic quantities.

See also: mass_ratio, characteristic_mass, characteristic_time, characteristic_length, characteristic_velocity

mass_ratio(::CrtbpSystem)

Retrieve the mass ratio, μ, of the specified system.

See also: CrtbpSystem, characteristic_mass, characteristic_time, characteristic_length, characteristic_velocity

characteristic_mass(::CrtbpSystem)

Retrieve the characteristic mass of the CRTBP system specified. This mass is usually defined as the sum of the masses of the two primaries.

See also: CrtbpSystem, mass_ratio, characteristic_time, characteristic_length, characteristic_velocity

characteristic_length(::CrtbpSystem)

Retrieve the characteristic length of the CRTBP system specified. This length is usually defined as the semi-major axis of the circular orbit of P2 in the CRTBP.

See also: CrtbpSystem, mass_ratio, characteristic_mass, characteristic_time, characteristic_velocity

characteristic_length(::CrtbpSystem)

Retrieve the characteristic time of the CRTBP system specified. This time is usually defined as the time such that the universal gravitational constant in the non-dimensional system is unity.

See also: CrtbpSystem, mass_ratio, characteristic_mass, characteristic_length, characteristic_velocity

characteristic_velocity(::CrtbpSystem)

Retrieve the characteristic velocityof the CRTBP system specified. This is equivalent to the characteristic length divided by the characteristic time.

See also: CrtbpSystem, mass_ratio, characteristic_mass, characteristic_length

dimensionalize(::CrtbpSystem{T,T}, ::PositionVelocity)

Dimensionalize the position and velocity components using the characteristic quantities associated with the CRTBP system.

See also: nondimensionalize CrtbpSystem, characteristic_length, characteristic_velocity

nondimensionalize(::CrtbpSystem{T,T}, ::PositionVelocity)

Nondimensionalize the position and velocity components using the characteristic quantities associated with the CRTBP system.

See also: dimensionalize CrtbpSystem, characteristic_length, characteristic_velocity

pseudopotential(::CrtbpSystem, ::PositionVelocity)

Calculate the CRTBP pseudopotential of the specified position-velocity vector.

See also: pseudopotential_gradient, pseudopotential_hessian

pseudopotential_gradient(::CrtbpSystem, ::PositionVelocity)

Calculate the partials of the CRTBP pseudopotential with respect to all 6 state components in the position-velocity vector.

See also: pseudopotential, pseudopotential_hessian

pseudopotential_hessian(::CrtbpSystem, ::PositionVelocity)

Calculate the second order partials of the CRTBP pseudopotential with respect to all 6 state components in the position-velocity vector.

See also: pseudopotential, pseudopotential_gradient

jacobi_constant(::CrtbpSystem, ::PositionVelocity)

Calculate the Jacobi constant of a state in the CRTBP.

See also: jacobi_constant_gradient

jacobi_constant_gradient(::CrtbpSystem, ::PositionVelocity)

Calculate the gradient of Jacobi constant with respect to all 6 position-velocity variables.

See also: jacobi_constant

crtbp_eom(pv::AbstractArray, sys::CrtbpSystem, t)

Evaluate the equations of motion for the Circular Restricted Three Body Problem (CRTBP) at the state specified by pv in the system specified by sys. The time input, t, while required due to compatibility with DifferentialEquations.jl, is not used.

Note, here, pv can be any AbstractArray due to compatibility with DifferentialEquations. However, if a PositionVelocity is not constructible via PositionVelocity(pv), an error will be thrown.

See also: crtbp_jacobian, PositionVelocity

crtbp_jacobian(pv::AbstractArray, sys::CrtbpSystem, t)

Evaluate the jacobian of equations of motion for the Circular Restricted Three Body Problem (CRTBP) at the state specified by pv in the system specified by sys. The time input, t, while required due to compatibility with DifferentialEquations.jl, is not used.

Note, here, pv can be any AbstractArray due to compatibility with DifferentialEquations. However, if a PositionVelocity is not constructible via PositionVelocity(pv), an error will be thrown.

See also: crtbp_eom, PositionVelocity