Docstrings

Documentation for all types, and functions in GeneralAstrodynamics.

`CoordinateFrames`

GeneralAstrodynamics.CoordinateFrames.BarycentricInertial — Type

abstract type BarycentricInertial <: Inertial

abstract type BarycentricInertial <: Inertial

A supertype for all barycentric-ineretial coordinate frames in space.

source

GeneralAstrodynamics.CoordinateFrames.BarycentricRotating — Type

abstract type BarycentricRotating <: Rotating

abstract type BarycentricRotating <: Rotating

A supertype for all barycentric-rotating coordinate frames in space.

source

GeneralAstrodynamics.CoordinateFrames.BodycentricInertial — Type

abstract type BodycentricInertial <: Inertial

abstract type BodycentricInertial <: Inertial

A supertype for all bodycentric-inertial coordinate frames in space.

source

GeneralAstrodynamics.CoordinateFrames.BodycentricRotating — Type

abstract type BodycentricRotating <: Rotating

abstract type BodycentricRotating <: Rotating

A supertype for all bodycentric-rotating coordinate frames in space.

source

GeneralAstrodynamics.CoordinateFrames.Inertial — Type

abstract type Inertial <: OrbitalFrame

abstract type Inertial <: OrbitalFrame

A supertype for all inertial coordinate frames in space.

source

GeneralAstrodynamics.CoordinateFrames.OrbitalFrame — Type

abstract type OrbitalFrame

abstract type OrbitalFrame

A supertype for all coordinate frames used in space.

source

GeneralAstrodynamics.CoordinateFrames.OrbitalFrameTransform — Type

abstract type OrbitalFrameTransform

abstract type OrbitalFrameTransform

A supertype for all astrodynamics coordinate frame transformations.

source

GeneralAstrodynamics.CoordinateFrames.Rotating — Type

abstract type Rotating <: OrbitalFrame

abstract type Rotating <: OrbitalFrame

A supertype for all rotating coordinate frames in space.

source

GeneralAstrodynamics.CoordinateFrames.Transform — Type

struct Transform{F1<:OrbitalFrame, F2<:OrbitalFrame, T1<:CoordinateTransformations.Transformation, T2<:CoordinateTransformations.Transformation} <: GeneralAstrodynamics.CoordinateFrames.OrbitalFrameTransform

struct Transform{F1<:OrbitalFrame, F2<:OrbitalFrame, T1<:CoordinateTransformations.Transformation, T2<:CoordinateTransformations.Transformation} <: GeneralAstrodynamics.CoordinateFrames.OrbitalFrameTransform

A generic frame transformation between two OrbitalFrame types. Converts F1 toF2.

transform_position::CoordinateTransformations.Transformation
transform_velocity::CoordinateTransformations.Transformation

source

GeneralAstrodynamics.CoordinateFrames.Transform — Method

Transform(position_transform, velocity_transform, from, to)

An outer constructor for Transform instances. Provide position and velocity transformations, and the initial and final reference frames via function arguments. This is an alternate syntax for Transform{InitialFrame, FinalFrame}(position_transform, velocity_transform).

source

GeneralAstrodynamics.CoordinateFrames.isbarycentric — Method

isbarycentric(_)

isbarycentric(_)

Returns true or false to indicate whether the provided frame is barycentric.

source

GeneralAstrodynamics.CoordinateFrames.isbodycentric — Method

isbodycentric(_)

isbodycentric(_)

Returns true or false to indicate whether the provided frame is bodycentric.

source

GeneralAstrodynamics.CoordinateFrames.isinertial — Method

isinertial(_)

isinertial(_)

Returns true or false to indicate whether the provided frame is Inertial.

source

GeneralAstrodynamics.CoordinateFrames.isrotating — Method

isrotating(_)

isrotating(_)

Returns true or false to indicate whether the provided frame is Rotating.

source

`Calculations`

GeneralAstrodynamics.Calculations.Circular — Type

abstract type Circular <: GeneralAstrodynamics.Calculations.ConicSection

An abstract type representing the Circular conic section.

source

GeneralAstrodynamics.Calculations.ConicSection — Type

abstract type ConicSection

An abstract type for all conic sections.

source

GeneralAstrodynamics.Calculations.Elliptical — Type

abstract type Elliptical <: GeneralAstrodynamics.Calculations.ConicSection

An abstract type representing the Elliptical conic section.

source

GeneralAstrodynamics.Calculations.Hyperbolic — Type

abstract type Hyperbolic <: GeneralAstrodynamics.Calculations.ConicSection

An abstract type representing the Hyperbolic conic section.

source

GeneralAstrodynamics.Calculations.Parabolic — Type

abstract type Parabolic <: GeneralAstrodynamics.Calculations.ConicSection

An abstract type representing the Parabolic conic section.

source

GeneralAstrodynamics.Calculations.C3 — Method

C3(r, v, μ)

Returns C3 value.

source

GeneralAstrodynamics.Calculations.LancasterBlanchard — Method

LancasterBlanchard(x, q, m)

The following code was converted to Julia, from a GitHub repository that hosts the MATLAB implementation. At the time of writing, the respository has a BSD license. I'm providing the copyright notice here, as instructed by the license text.

Copyright (c) 2018, Rody Oldenhuis
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of this project.

source

GeneralAstrodynamics.Calculations.SOA — Method

SOA(a, m, M)

Sphere of activity.

source

GeneralAstrodynamics.Calculations.SOI — Method

SOI(a, m, M)

Sphere of influence.

source

GeneralAstrodynamics.Calculations.analyticalhalo — Method

analyticalhalo(μ; Az, ϕ, steps, L, hemisphere)

Returns an analytical solution for a Halo orbit about L.

Arguments:

μ: Non-dimensional mass parameter for the CR3BP system.
Az: Desired non-dimensional Z-amplitude for Halo orbit.
ϕ: Desired Halo orbit phase.
steps: Number of non-dimensional timepoints in returned state.
L: Lagrange point to orbit (L1 or L2).
hemisphere: Specifies northern or southern Halo orbit.

Outputs:

Synodic position vector r::Array{<:AbstractFloat}
Synodic velocity vector v::Array{<:Abstractfloat}.
Halo orbit period Τ.
Throws ArgumentError if L is not 1 or 2.

References:

Rund, 2018.

source

GeneralAstrodynamics.Calculations.apoapsis_radius — Method

apoapsis_radius(a, e)

Returns apoapsis distance, rₐ.

source

GeneralAstrodynamics.Calculations.cartesian — Method

cartesian(e, a, i, Ω, ω, ν, μ)

Returns a Cartesian representation of a Keplerian two-body orbital state in an inertial frame, centered at the center of mass of the central body. Algorithm taught in ENAE601.

source

GeneralAstrodynamics.Calculations.conic — Method

conic(e)

Returns the conic section, as specified by eccentricity e.

source

GeneralAstrodynamics.Calculations.distance — Method

distance(p, e, ν)

Returns distance, r.

source

GeneralAstrodynamics.Calculations.distance_to_primary — Method

distance_to_primary(r, μ)

Returns synodic distance to primary body.

source

GeneralAstrodynamics.Calculations.distnace_to_secondary — Method

distnace_to_secondary(r, μ)

Returns synodic distance to secondary body.

source

GeneralAstrodynamics.Calculations.eccentricity — Method

eccentricity(rᵢ, vᵢ, μ)

Returns orbital eccentricity, e.

source

GeneralAstrodynamics.Calculations.eccentricity_vector — Method

eccentricity_vector(rᵢ, vᵢ, μ)

Returns orbital eccentricity vector e̅.

source

GeneralAstrodynamics.Calculations.hohmann — Method

hohmann(r₁, r₂, μ)

Computes a Hohmann transfer, and returns the departure and arrival velocity vectors.

source

GeneralAstrodynamics.Calculations.inertial — Function

inertial(vecₛ, t)
inertial(vecₛ, t, ω)

Given the Synodic frame vector, returns the vector in the barycenteric-inertial reference frame.

source

GeneralAstrodynamics.Calculations.jacobi_constant — Method

jacobi_constant(r, v, μ)

Returns the Jacobi Constant, C in the Synodic frame with Normalized units.

source

GeneralAstrodynamics.Calculations.kepler — Function

kepler(r, v, μ)
kepler(r, v, μ, Δt; tol, max_iter)

Solves Kepler's Problem for orbit and Δtᵢ.

source

GeneralAstrodynamics.Calculations.keplerian — Method

keplerian(rᵢ, vᵢ, μ)

Returns a Keplarian representation of a Cartesian orbital state. Algorithm taught in ENAE601.

source

GeneralAstrodynamics.Calculations.lagrange — Function

lagrange(μ)
lagrange(μ, L)

Returns the lagrange points for a CR3BP system.

Arguments:

μ: Non-dimensional mass parameter for the CR3BP system.
L: Langrange points requested, must be in range [1,5]

Outputs:

Tuple of Lagrange points
Throws ArgumentError if L is out of range [1,5]

References:

Rund, 2018

source

GeneralAstrodynamics.Calculations.lambert — Method

lambert(r1vec, r2vec, tf, m, muC)

The following code was converted to Julia, from a GitHub repository that hosts a MATLAB implementation. At the time of writing, this respository has a BSD license. I'm providing the copyright notice here, as instructed by the license text.

Copyright (c) 2018, Rody Oldenhuis
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of this project.

source

GeneralAstrodynamics.Calculations.lambert — Method

lambert(r1, r2, tf, m, mu)

Wrapper for Unitful inputs.

source

GeneralAstrodynamics.Calculations.lambert_lancaster_blanchard — Method

lambert_lancaster_blanchard(
    r̲₁,
    r̲₂,
    μ,
    Δt;
    revolutions,
    branch,
    trajectory,
    tolerance,
    max_iter,
    output_extrema
)

Copyright (c) 2018, Rody Oldenhuis
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of this project.

source

GeneralAstrodynamics.Calculations.lambert_universal — Method

lambert_universal(
    r̅₁,
    r̅₂,
    μ,
    Δt;
    trajectory,
    tolerance,
    max_iter
)

Solves Lambert's problem through the use of univeral variables.

source

GeneralAstrodynamics.Calculations.mean_motion — Method

mean_motion(a, μ)

Returns mean motion, n.

source

GeneralAstrodynamics.Calculations.minmax_distances — Method

minmax_distances(r̲₁, r̲₂, r₁, r₂, δₜ, a, v̲₁, v̲₂, m, μ)

Copyright (c) 2018, Rody Oldenhuis
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of this project.

source

GeneralAstrodynamics.Calculations.nondimensional_radius — Method

nondimensional_radius(r, xᵢ)

Returns the spacecraft's nondimensional position w.r.t. body 1 (or 2).

source

GeneralAstrodynamics.Calculations.periapsis_radius — Method

periapsis_radius(a, e)

Returns periapsis distance, rₚ.

source

GeneralAstrodynamics.Calculations.perifocal — Method

perifocal(a, e, ν, μ)

Returns position and velocity vectors in the Perifocal frame.

source

GeneralAstrodynamics.Calculations.period — Method

period(a, μ)

Returns the orbital period.

source

GeneralAstrodynamics.Calculations.potential_energy — Method

potential_energy(r, μ)

Returns the potential energy U in the Synodic frame with Normalized units.

source

GeneralAstrodynamics.Calculations.primary_position — Method

primary_position(μ)

Position of primary body.

source

GeneralAstrodynamics.Calculations.redimension — Method

redimension(rₙ, vₙ, tₙ, μₙ, DU, TU)

Redimensionalizes a CR3BP orbit in the rotating reference frame.

source

GeneralAstrodynamics.Calculations.secondary_position — Method

secondary_position(μ)

Position of primary body.

source

GeneralAstrodynamics.Calculations.semi_parameter — Method

semi_parameter(a, e)

Returns semilatus parameter, p.

source

GeneralAstrodynamics.Calculations.semimajor_axis — Method

semimajor_axis(r, v, μ)

Returns semimajor axis parameter, a.

source

GeneralAstrodynamics.Calculations.spatial — Method

spatial(i, Ω, ω, rₚ, vₚ)

Returns a spatial representation of the provied Perifocal state.

source

GeneralAstrodynamics.Calculations.specific_angular_momentum — Method

specific_angular_momentum(rᵢ, vᵢ)

Returns scalar specific angular momentum vector, h.

source

GeneralAstrodynamics.Calculations.specific_angular_momentum_vector — Method

specific_angular_momentum_vector(rᵢ, vᵢ)

Returns specific angular momentum vector, h̅.

source

GeneralAstrodynamics.Calculations.specific_energy — Method

specific_energy(a, μ)

Returns specific orbital energy, ϵ.

source

GeneralAstrodynamics.Calculations.specific_potential_energy — Method

specific_potential_energy(r, μ)

Returns potential energy for an orbit about a RestrictedTwoBodySystem.

source

GeneralAstrodynamics.Calculations.speed — Method

speed(p, e, ν, a, μ)

Returns the instantaneous velocity, v, for any orbital representation.

source

GeneralAstrodynamics.Calculations.speed — Method

speed(r, a, μ)

Returns instantaneous velocity, v, for any orbital representation.

source

GeneralAstrodynamics.Calculations.synodic — Method

synodic(state, t)

Given an InertialCartesianState, returns the state in the synodic (rotating) reference frame.

source

GeneralAstrodynamics.Calculations.time_since_periapsis — Method

time_since_periapsis(n, e, E)

Returns time since periapsis, t.

source

GeneralAstrodynamics.Calculations.true_anomoly — Method

true_anomoly(r, h, e, μ)

Returns true anomoly, ν.

source

GeneralAstrodynamics.Calculations.v_infinity — Method

v_infinity(r, v, μ)

Returns v∞.

source

GeneralAstrodynamics.Calculations.zerovelocity_curves — Method

zerovelocity_curves(r, v, μ; nondimensional_range)

Returns a Vector of Matrix values. Each Matrix contains a 3-column nondimensional position trajectory in the Synodic frame which represents a Zero Velocity Curve.

source

GeneralAstrodynamics.Calculations.σmax — Method

σmax(y)

Copyright (c) 2018, Rody Oldenhuis
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of this project.

source

LinearAlgebra.normalize — Method

normalize(r, v, t, a, μs; lengthunit, timeunit)

Normalizes a CR3BP orbit in the rotating reference frame.

source

`States`

GeneralAstrodynamics.States.AbstractOrbit — Type

abstract type AbstractOrbit{FR, F, MU, LU, TU, AU, E, S<:(GeneralAstrodynamics.States.AbstractState{F, LU, TU, AU}), P<:(GeneralAstrodynamics.States.ParameterVector{F, MU, LU, TU, AU})}

A supertype for all single-point orbit descriptions. Parameterized by coordinate frame, floating point type, mass unit, lenth unit, time unit, epoch type, state type, and parameter type (in order).

source

GeneralAstrodynamics.States.AbstractState — Type

abstract type AbstractState{F, LU, TU, AU, T} <: GeneralAstrodynamics.States.ParameterizedLabelledArray{F, 1, T, LabelledArrays.LArray{F, 1, StaticArraysCore.MArray{Tuple{6}, F, 1, 6}, T}}

A supertype for all states in astrodynamics.

source

GeneralAstrodynamics.States.CR3BPOrbit — Type

mutable struct Orbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:(Union{var"#s233", var"#s232"} where {var"#s233"<:CartesianState, var"#s232"<:CartesianStateWithSTM}), var"#s232"<:CR3BPParameters} <: GeneralAstrodynamics.States.AbstractOrbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:(Union{var"#s233", var"#s232"} where {var"#s233"<:CartesianState, var"#s232"<:CartesianStateWithSTM}), var"#s232"<:CR3BPParameters}

An alias for Orbit instances about CR3BP systems.

source

GeneralAstrodynamics.States.CR3BPParameters — Type

struct CR3BPParameters{F, MU, LU, TU, AU, B} <: GeneralAstrodynamics.States.ParameterVector{F, MU, LU, TU, AU, 1, (:μ,), B}

All parameters required for the Circular Restricted Three-body Problem.

source

GeneralAstrodynamics.States.CartesianOrbit — Type

mutable struct Orbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:(Union{var"#s233", var"#s232"} where {var"#s233"<:CartesianState, var"#s232"<:CartesianStateWithSTM}), var"#s232"<:GeneralAstrodynamics.States.ParameterVector} <: GeneralAstrodynamics.States.AbstractOrbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:(Union{var"#s233", var"#s232"} where {var"#s233"<:CartesianState, var"#s232"<:CartesianStateWithSTM}), var"#s232"<:GeneralAstrodynamics.States.ParameterVector}

An alias for Orbit instances about any systems with CartesianState descriptions.

source

GeneralAstrodynamics.States.CartesianOrbitWithSTM — Type

mutable struct Orbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:CartesianStateWithSTM, var"#s232"<:GeneralAstrodynamics.States.ParameterVector} <: GeneralAstrodynamics.States.AbstractOrbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:CartesianStateWithSTM, var"#s232"<:GeneralAstrodynamics.States.ParameterVector}

An alias for Orbit instances about any systems with CartesianStateWithSTM descriptions.

source

GeneralAstrodynamics.States.CartesianR2BPOrbit — Type

mutable struct Orbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:(Union{var"#s233", var"#s232"} where {var"#s233"<:CartesianState, var"#s232"<:CartesianStateWithSTM}), var"#s232"<:R2BPParameters} <: GeneralAstrodynamics.States.AbstractOrbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:(Union{var"#s233", var"#s232"} where {var"#s233"<:CartesianState, var"#s232"<:CartesianStateWithSTM}), var"#s232"<:R2BPParameters}

An alias for Orbit instances about R2BP systems with CartesianState descriptions.

source

GeneralAstrodynamics.States.CartesianState — Type

mutable struct CartesianState{F, LU, TU, AU} <: GeneralAstrodynamics.States.StateVector{F, LU, TU, AU, (x = 1, y = 2, z = 3, ẋ = 4, ẏ = 5, ż = 6, r = 1:3, v = 4:6)}

A Cartesian state vector with length 6. Internally uses MVector and LVector to store data. Data is accessible via labels, which are x, y, z, ẋ, ẏ, ż, r, v, where r access x,y,z and v accesses ẋ, ẏ, ż.

source

GeneralAstrodynamics.States.CartesianState — Method

Constructs a CartesianState from provided position and velocity vectors.

source

GeneralAstrodynamics.States.CartesianState — Method

Constructs a CartesianState.

source

GeneralAstrodynamics.States.CartesianState — Method

Returns a CartesianState, given a CartesianStateWithSTM.

source

GeneralAstrodynamics.States.CartesianStateWithSTM — Type

Returns a CartesianStateWithSTM, given a CartesianState.

source

GeneralAstrodynamics.States.CartesianStateWithSTM — Type

mutable struct CartesianStateWithSTM{F, LU, TU, AU} <: GeneralAstrodynamics.States.StateVectorWithSTM{F, LU, TU, AU, (x = 1, y = 2, z = 3, ẋ = 4, ẏ = 5, ż = 6, r = 1:3, v = 4:6, Φ = 7:42)}

A Cartesian state vector with local linearization and length 42. Internally uses MVector and LVector to store data. Data is accessible via labels, which are x, y, z, ẋ, ẏ, ż, r, v, where r access x,y,z and v accesses ẋ, ẏ, ż.

source

GeneralAstrodynamics.States.CartesianStateWithSTM — Method

Outer constructor for CartesianStateWithSTM.

source

GeneralAstrodynamics.States.KeplerianR2BPOrbit — Type

mutable struct Orbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:KeplerianState, var"#s232"<:R2BPParameters} <: GeneralAstrodynamics.States.AbstractOrbit{FR, F, MU, LU, TU, AU, E, var"#s233"<:KeplerianState, var"#s232"<:R2BPParameters}

An alias for Orbit instances about R2BP systems with KeplerianState descriptions.

source

GeneralAstrodynamics.States.KeplerianState — Type

mutable struct KeplerianState{F, LU, TU, AU} <: GeneralAstrodynamics.States.StateVector{F, LU, TU, AU, (e = 1, a = 2, i = 3, Ω = 4, ω = 5, ν = 6)}

A Keplerian state vector with length 6. Internally uses MVector and LVector to store data. Data is accessible via labels, which are e, a, i, Ω, ω, ν.

source

GeneralAstrodynamics.States.KeplerianState — Method

Constructs a KeplerianState from provided position and velocity vectors.

source

GeneralAstrodynamics.States.KeplerianState — Method

Constructs a KeplerianState from any AbstractVector.

source

GeneralAstrodynamics.States.Orbit — Type

Outer constructor for Orbits.

source

GeneralAstrodynamics.States.Orbit — Type

mutable struct Orbit{FR, F, MU, LU, TU, AU, E, S, P} <: GeneralAstrodynamics.States.AbstractOrbit{FR, F, MU, LU, TU, AU, E, S, P}

An orbit, described by a StateVector, with parameters described by a ParameterVector.

source

GeneralAstrodynamics.States.Orbit — Type

Outer constructor for Orbits.

source

GeneralAstrodynamics.States.ParameterVector — Type

abstract type ParameterVector{F, MU, LU, TU, AU, N, T, B} <: GeneralAstrodynamics.States.ParameterizedLabelledArray{F, 1, T, LabelledArrays.SLArray{Tuple{N}, F, 1, N, T}}

A supertype for parameter representations in astrodynamics.

source

GeneralAstrodynamics.States.ParameterizedLabelledArray — Type

abstract type ParameterizedLabelledArray{F, N, T, L} <: DenseArray{F, N}

abstract type ParameterizedLabelledArray{F, N, T, L} <: DenseArray{F, N}

A supertype for types that function like LabelledArray.LArray or LabelledArray.SLArray instances, but are under a new type tree. This is used in GeneralAstrodynamics for parameterizing astrodynamics state vectors by physical units.

Note

All subtypes must have only one field: a LabelledArrays.LArray or LabelledArrays.SLArray field called __rawdata. All methods on this abstract type require this field to be called __rawdata!

Nearly all code which acts on this type is copied and / or modified from LabelledArrays.jl source code. All credit goes to LabelledArrays.jl developers. The LabelledArrays.jl LICENSE file is provided in this docstring under Julia's Extended Help docstring section.

Extended help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

GeneralAstrodynamics.States.R2BPOrbit — Type

mutable struct Orbit{FR, F, MU, LU, TU, AU, E, S<:Union{KeplerianState, Union{var"#s233", var"#s232"} where {var"#s233"<:CartesianState, var"#s232"<:CartesianStateWithSTM}}, P<:R2BPParameters} <: GeneralAstrodynamics.States.AbstractOrbit{FR, F, MU, LU, TU, AU, E, S<:Union{KeplerianState, Union{var"#s233", var"#s232"} where {var"#s233"<:CartesianState, var"#s232"<:CartesianStateWithSTM}}, P<:R2BPParameters}

An alias for Orbit instances about R2BP systems.

source

GeneralAstrodynamics.States.R2BPParameters — Type

struct R2BPParameters{F, MU, LU, TU, AU, B} <: GeneralAstrodynamics.States.ParameterVector{F, MU, LU, TU, AU, 1, (:μ,), B}

All parameters required for the Restricted Two-body Problem.

source

GeneralAstrodynamics.States.StateVector — Type

abstract type StateVector{F, LU, TU, AU, T} <: GeneralAstrodynamics.States.AbstractState{F, LU, TU, AU, T}

A supertype for all state representations in astrodynamics.

source

GeneralAstrodynamics.States.StateVectorWithSTM — Type

abstract type StateVectorWithSTM{F, LU, TU, AU, T} <: GeneralAstrodynamics.States.AbstractState{F, LU, TU, AU, T}

A supertype for all state representations with local linearizations in astrodynamics.

source

ArrayInterface.restructure — Method

restructure(x, y)

restructure(x, y)

Reshapes a ParameterizedLabelledArray.

This source code which provides this functionality was copied directly from LabelledArrays.jl source code. The LabelledArrays.jl license text is provided in Julia's Extended Help section (accessible via @doc, or ?? in Julia's REPL).

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.convert — Method

convert(_, x)

convert(_, x)

Converts the underlying floating point type for a ParameterizedLabelledArray.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.convert — Method

convert(_, state)

Converts types and units for a CartesianState.

source

Base.convert — Method

convert(_, state)

Converts types and units for a CartesianState.

source

Base.convert — Method

convert(_, system)

Converts types and units for a CR3BPParameters.

source

Base.convert — Method

convert(_, system)

Converts types and units for a R2BPParameters.

source

Base.convert — Method

convert(_, x)

convert(_, x)

Converts the underlying floating point type for a ParameterizedLabelledArray.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.convert — Method

convert(_, x)

convert(_, x)

Converts the underlying floating point type for a ParameterizedLabelledArray.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.copy — Method

copy(x)

copy(x)

Shallow copies a ParameterizedLabelledArray.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.copyto! — Method

copyto!(x, y)

copyto!(x, y)

Copies one ParameterizedLabelledArray to another.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.dataids — Method

dataids(A)

dataids(A)

Implements dataids for a ParameterizedLabelledArray instance.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.deepcopy — Method

deepcopy(x)

deepcopy(x)

Deep copies a ParameterizedLabelledArray.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.elsize — Method

elsize(_)

elsize(_)

Returns the memory stride for any ParameterizedLabelledArray.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.getindex — Method

getindex(state, args)

getindex(state, args)

Returns the index of the ParameterizedLabelledArray.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.getproperty — Method

getproperty(x, s)

getproperty(x, s)

Overrides Base.getproperty for all ParameterizedLabelledArray instances.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.length — Method

length(_)

The length of any StateVector is 6!

source

Base.length — Method

length(_)

The length of any StateVector is 6!

source

Base.length — Method

length(_)

Returns the length of the parameter vector.

source

Base.one — Method

one(x)

one(x)

Overrides one for ParameterizedLabelledArray instances.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.propertynames — Method

propertynames(_)

propertynames(_)

Returns dot-accessible property names for a ParameterizedLabelledArray.

source

Base.setindex! — Method

setindex!(state, args)

setindex!(state, args)

Sets the index of the ParameterizedLabelledArray.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.setproperty! — Method

setproperty!(x, s, y)

setproperty!(x, s, y)

Sets indices of a ParameterizedLabelledArray via label.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.show — Method

show(io, sys; showfloats, space)

Displays a CR3BPParameters instance.

source

Base.show — Method

show(io, state; showfloats, space)

Displays a CartesianStateWithSTM.

source

Base.show — Method

show(io, state; showfloats, space)

Displays a CartesianState.

source

Base.show — Method

show(io, state; showfloats, space)

Displays a KeplerianState.

source

Base.show — Method

show(io, orbit)

Shows all Orbit instances.

source

Base.show — Method

show(io, state; showfloats, space)

Displays R2BPParameters.

source

Base.similar — Method

similar(x, _)

similar(x, _)

Overrides similar for ParameterizedLabelledArray instances.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.similar — Method

similar(x)

similar(x)

Overrides similar for ParameterizedLabelledArray instances.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.similar — Method

similar(x, dims)

similar(x, dims)

Overrides similar for ParameterizedLabelledArray instances.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.size — Method

size(_)

The size of any StateVector is (6,)!

source

Base.size — Method

size(_)

The size of any StateVector is (6,)!

source

Base.size — Method

size(_)

Returns the size of the parameter vector.

source

Base.unsafe_convert — Method

unsafe_convert(_, a)

unsafe_convert(_, a)

Provides unsafe_convert for ParameterizedLabelledArray types for use with LAPACK.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

Base.zero — Method

zero(x)

zero(x)

Overrides zero for ParameterizedLabelledArray instances.

Extended Help

LabelledArrays.jl License

The LabelledArrays.jl package is licensed under the MIT "Expat" License:

source

GeneralAstrodynamics.States.angularunit — Method

angularunit(_)

Returns the angularunit of the state vector.

source

GeneralAstrodynamics.States.angularunit — Method

angularunit(_)

Returns the angular unit of the parameter vector.

source

GeneralAstrodynamics.States.angularunit — Method

angularunit(_)

Returns the angularunit for an Orbit.

source

GeneralAstrodynamics.States.defaultframe — Method

defaultframe(system)

Returns a default frame.

source

GeneralAstrodynamics.States.epoch — Method

epoch(orbit)

Returns the epoch (timestamp) for the Orbit.

source

GeneralAstrodynamics.States.frame — Method

frame(_)

Returns the OrbitalFrame for the Orbit.

source

GeneralAstrodynamics.States.get_a — Method

get_a(state)

Returns a.

source

GeneralAstrodynamics.States.get_e — Method

get_e(state)

Returns e.

source

GeneralAstrodynamics.States.get_i — Method

get_i(state)

Returns i.

source

GeneralAstrodynamics.States.get_r — Method

get_r(state)

Returns r.

source

GeneralAstrodynamics.States.get_stm — Method

get_stm(state)

Returns the state transition matrix.

source

GeneralAstrodynamics.States.get_v — Method

get_v(state)

Returns v.

source

GeneralAstrodynamics.States.get_x — Method

get_x(state)

Returns x.

source

GeneralAstrodynamics.States.get_y — Method

get_y(state)

Returns y.

source

GeneralAstrodynamics.States.get_z — Method

get_z(state)

Returns z.

source

GeneralAstrodynamics.States.get_ż — Method

get_ż(state)

Returns ż.

source

GeneralAstrodynamics.States.get_Ω — Method

get_Ω(state)

Returns Ω.

source

GeneralAstrodynamics.States.get_μ — Method

get_μ(sys)

Returns the normalized mass parameter, μ.

source

GeneralAstrodynamics.States.get_μ — Method

get_μ(sys)

Returns the normalized mass parameter, μ.

source

GeneralAstrodynamics.States.get_ν — Method

get_ν(state)

Returns ν.

source

GeneralAstrodynamics.States.get_ω — Method

get_ω(state)

Returns `ω.

source

GeneralAstrodynamics.States.get_ϕ — Method

get_ϕ(state)

Returns ϕ.

source

GeneralAstrodynamics.States.get_ẋ — Method

get_ẋ(state)

Returns ẋ.

source

GeneralAstrodynamics.States.get_ẏ — Method

get_ẏ(state)

Returns ẏ.

source

GeneralAstrodynamics.States.isnormalized — Method

isnormalized(state)

Returns true if the AbstractState has lengthunit and timeunit parameters of some type T <: AbstractQuantity. This is intended to be used for normalizing CartesianState vectors.

source

GeneralAstrodynamics.States.lengthunit — Method

lengthunit(_)

Returns the lengthunit of the state vector.

source

GeneralAstrodynamics.States.lengthunit — Method

lengthunit(_)

Returns the length unit of the parameter vector.

source

GeneralAstrodynamics.States.lengthunit — Method

lengthunit(_)

Returns the lengthunit for an Orbit.

source

GeneralAstrodynamics.States.massparameter — Method

massparameter(system)

Returns the mass parameter of the CR3BP system.

source

GeneralAstrodynamics.States.massparameter — Method

massparameter(system)

Returns the mass parameter of the R2BP system.

source

GeneralAstrodynamics.States.massparameters — Method

massparameters(system)

Returns the mass parameters of the CR3BP system.

source

GeneralAstrodynamics.States.massparamunit — Method

massparamunit(orbit)

Returns the massparamunit for an Orbit.

source

GeneralAstrodynamics.States.massparamunit — Method

massparamunit(_)

Returns the mass-parameter unit of the state vector.

source

GeneralAstrodynamics.States.massunit — Method

massunit(_)

Returns the mass unit of the parameter vector.

source

GeneralAstrodynamics.States.massunit — Method

massunit(_)

Returns the massunit for an Orbit.

source

GeneralAstrodynamics.States.model — Method

model(_)

model(_)

Returns the ModelingToolkit.ODESystem associated with CR3BPParameters, provided by AstrodynamicalModels.

source

GeneralAstrodynamics.States.model — Method

model(_)

model(_)

Returns the ModelingToolkit.ODESystem associated with R2BPParameters, provided by AstrodynamicalModels.

source

GeneralAstrodynamics.States.name — Method

name(_)

Returns the name of the parameter vector.

source

GeneralAstrodynamics.States.primary_massparameter — Method

primary_massparameter(system)

Returns the primary mass parameter of the CR3BP system.

source

GeneralAstrodynamics.States.secondary_massparameter — Method

secondary_massparameter(system)

Returns the secondary mass parameter of the CR3BP system.

source

GeneralAstrodynamics.States.state — Method

state(orbit)

Returns the state vector for the Orbit.

source

GeneralAstrodynamics.States.statevector — Method

statevector(state)

Returns the whole state vector, without units.

source

GeneralAstrodynamics.States.statevector — Method

statevector(state)

Returns the whole state vector, without units.

source

GeneralAstrodynamics.States.statevector — Method

statevector(state)

Returns the whole state vector, without units.

source

GeneralAstrodynamics.States.system — Method

system(orbit)

Returns the parameter vector for the Orbit.

source

GeneralAstrodynamics.States.timeunit — Method

timeunit(_)

Returns the timeunit of the state vector.

source

GeneralAstrodynamics.States.timeunit — Method

timeunit(_)

Returns the time unit of the parameter vector.

source

GeneralAstrodynamics.States.timeunit — Method

timeunit(_)

Returns the timeunit for an Orbit.

source

GeneralAstrodynamics.States.vectorfield — Method

vectorfield(_)

vectorfield(_)

Returns the DifferentialEquations.ODEFunction associated with CR3BPParameters, provided by AstrodynamicalModels.

source

GeneralAstrodynamics.States.vectorfield — Method

vectorfield(_)

vectorfield(_)

Returns the DifferentialEquations.ODEFunction associated with R2BPParameters, provided by AstrodynamicalModels.

source

GeneralAstrodynamics.States.velocityunit — Method

velocityunit(orbit)

Returns the velocityunit for an Orbit.

source

GeneralAstrodynamics.States.velocityunit — Method

velocityunit(_)

Returns the angularunit of the state vector.

source

GeneralAstrodynamics.States.velocityunit — Method

velocityunit(_)

Returns the velocity unit of the state vector.

source

`Propagation`

GeneralAstrodynamics.Propagation.AbstractOrbitalEnsembleSolution — Type

abstract type AbstractEnsembleSolution{T, N, var"#s11"<:AbstractArray{U<:Trajectory, 1}} <: AbstractVectorOfArray{T, N, var"#s11"<:AbstractArray{U<:Trajectory, 1}}

An alias for some abstract EnsembleSolution with States state vector and parameter vector types.

source

GeneralAstrodynamics.Propagation.AbstractOrbitalODESolution — Type

abstract type AbstractODESolution{T, N, var"#s1"<:AbstractArray{U<:GeneralAstrodynamics.States.AbstractState, 1}} <: SciMLBase.AbstractTimeseriesSolution{T, N, var"#s1"<:AbstractArray{U<:GeneralAstrodynamics.States.AbstractState, 1}}

An alias for some abstract ODESolution with States state vector and parameter vector types.

source

GeneralAstrodynamics.Propagation.Manifold — Type

struct Manifold{FR, S, P, E, O<:(SciMLBase.AbstractEnsembleSolution{T, N, <:AbstractVector{U}} where {T, N, U<:Trajectory})}

An wrapper for a SciMLBase.ODESolution with a GeneralAstrodynamics.States.AbstractState state vector type. This represents a Manifold in space!

source

GeneralAstrodynamics.Propagation.Trajectory — Type

struct Trajectory{FR, S, P, E, O<:(SciMLBase.AbstractODESolution{T, N, <:AbstractVector{U}} where {T, N, U<:GeneralAstrodynamics.States.AbstractState})}

An wrapper for a SciMLBase.ODESolution with a GeneralAstrodynamics.States.AbstractState state vector type. This represents an object's Trajectory in space!

source

GeneralAstrodynamics.Propagation.Trajectory — Method

A wrapper for (::ODESolution-like)(args...). Returns a state of type initialstate) at time t past epoch.

source

GeneralAstrodynamics.States.Orbit — Method

Returns an Orbit at time t.

source

SciMLBase.EnsembleProblem — Method

Returns an EnsembleProblem which represents perturbations off of a Halo orbit onto a stable or unstable manifold. Use kwargdirection=Val{:stable} or direction=Val{:unstable} to specify whether you want to solve for the stable or unstable invariant manifold about the provided Halo orbit. All kwargs arguments are passed directly to DifferentialEquations solvers.

source

SciMLBase.EnsembleProblem — Method

source

SciMLBase.ODEProblem — Method

Create's an ODEProblem for a R2BP orbit.

source

SciMLBase.ODEProblem — Method

Create's an ODEProblem for a R2BP orbit.

source

Base.eltype — Method

eltype(traj)

Returns the eltype of the Trajectory.

source

Base.getindex — Method

getindex(man, args)

Calls the underlying solution's getindex function to return the CartesianState of the Manifold at time t past the initialepoch.

source

Base.getindex — Method

getindex(traj, args)

Calls the underlying solution's getindex function to return the CartesianState of the Trajectory at time t past the initialepoch.

source

Base.lastindex — Method

lastindex(man)

Returns the last index of a Manifold.

source

Base.lastindex — Method

lastindex(traj)

Returns the last index of a Trajectory.

source

Base.length — Method

length(man)

The length of a Manifold.

source

Base.length — Method

length(traj)

The length of a Trajectory.

source

Base.position — Method

position(traj, t)

Returns the position of the Trajectory at ttimeunit's from the initialstate's epoch.

source

Base.show — Method

show(io, man)

Show a Trajectory.

source

Base.show — Method

show(io, traj)

Show a Trajectory.

source

Base.size — Method

size(man)

The size of a Manifold.

source

Base.size — Method

size(traj)

The size of a Trajectory.

source

GeneralAstrodynamics.Calculations.distance — Method

distance(traj, t)

Returns the scalar distance of the Trajectory at ttimeunit's from the initialstate's epoch.

source

GeneralAstrodynamics.Calculations.speed — Method

speed(traj, t)

Returns the scalar distance of the Trajectory at ttimeunit's from the initialstate's epoch.

source

GeneralAstrodynamics.Propagation.DistributedManifoldIteration — Method

DistributedManifoldIteration(
    traj,
    V,
    dur;
    trajectories,
    eps
)

Distributed perturbation for EnsembleProblem itration.

source

GeneralAstrodynamics.Propagation.ManifoldIteration — Method

ManifoldIteration(traj, V, dur; trajectories, eps)

Non-distributed perturbation for EnsembleProblem itration.

source

GeneralAstrodynamics.Propagation.ManifoldSolutionOutput — Method

ManifoldSolutionOutput(traj)

Maps a solution iteration within an EnsembleProblem solver to a Trajectory.

source

GeneralAstrodynamics.Propagation.ManifoldTrajectoryOutput — Method

ManifoldTrajectoryOutput(traj)

Maps a solution iteration within an EnsembleProblem solver to a Trajectory.

source

GeneralAstrodynamics.Propagation.UnitfulToAstroTime — Method

UnitfulToAstroTime(t)

Converts Unitful types to AstroTime types. Throws an ArgumentError if the unit of quantity t is not a second, minute, hour, day, or year.

source

GeneralAstrodynamics.Propagation.halo — Function

halo(sys)
halo(sys, epoch; Az, kwargs...)

A halo wrapper! Returns a CircularRestrictedThreeBodyOrbit. Returns a tuple: halo_orbit, halo_period.

source

GeneralAstrodynamics.Propagation.halo — Method

halo(
    μ;
    Az,
    L,
    hemisphere,
    tolerance,
    max_iter,
    reltol,
    abstol,
    nan_on_fail,
    disable_warnings
)

Returns a numerical solution for a Halo orbit about L.

Arguments:

μ: Non-dimensional mass parameter for the CR3BP system.
Az: Desired non-dimensional Z-amplitude for Halo orbit.
ϕ: Desired Halo orbit phase.
L: Lagrange point to orbit (L1 or L2).
hemisphere: Specifies northern or southern Halo orbit.

Outputs:

Tuple of initial states: (r, v) where r::Vector{<:AbstractFloat}, v::Vector{<:Abstractfloat}.
Throws ArgumentError if L is not :L1 or :L2

References:

The iterative scheme was pulled from directly from literature and sample code, including Rund 2018, and Dr. Mireles' lecture notes and EarthSunHaloOrbit_NewtonMewhod.m file available on their website. Specifically, the half-period iterative scheme (the F matrix in the source code, and corresponding "next guess" computation) was ported directly from Dr. Mireles' public code and notes, which are available online.

source

GeneralAstrodynamics.Propagation.initialepoch — Method

initialepoch(traj)

Returns the start epoch. Typically, This is a type defined in AstroTime.Epochs.

source

GeneralAstrodynamics.Propagation.initialstate — Method

initialstate(traj)

Returns the initial condition associated with the Trajectory.

source

GeneralAstrodynamics.Propagation.isperiodic — Method

isperiodic(orbit, T; reltol, abstol)

Returns true if a RestrictedThreeBodySystem is numerically periodic.

source

GeneralAstrodynamics.Propagation.manifold — Method

manifold(orbit, period; duration, trajectories, kwargs...)

Perturbs a periodic orbit's Trajectory in the direction of the stable or unstable eigenvector of its monodromy matrix to form a stable or unstable manifold.

source

GeneralAstrodynamics.Propagation.manifold — Method

manifold(
    traj;
    duration,
    eps,
    direction,
    algorithm,
    ensemble_algorithm,
    trajectories,
    reltol,
    abstol,
    kwargs...
)

Perturbs a periodic orbit traj in the direction of the stable or unstable eigenvector of its monodromy matrix to form a stable or unstable manifold.

source

GeneralAstrodynamics.Propagation.monodromy — Method

monodromy(orbit, T; verify, reltol, abstol)

Returns the Monodromy Matrix for a Halo orbit.

source

GeneralAstrodynamics.Propagation.perturb — Method

perturb(state, V; eps)

Perturbs a CartesianStateWithSTM in the direction of an eigenvector V.

source

GeneralAstrodynamics.Propagation.perturb — Method

perturb(traj, t, V; eps)

Returns an orbit perturbed in the direction of the local linearization right-multiplied by the provided eigenvector V. Only available for Trajectory instances with CartesianStateWithSTM state types.

source

GeneralAstrodynamics.Propagation.propagate — Method

propagate(orbit, Δt; algorithm, kwargs...)

Propagates an orbit forward or backward in time. Use algorithm to set the desired numerical integration algorithm, e.g. algorithm = Tsit5(). All other kwargs are passed directly to DifferentialEquations.solve.

source

GeneralAstrodynamics.Propagation.solution — Method

solution(man)

Returns the solution for the Manifold. Typically, this is a DifferentialEquations.ODESolution.

source

GeneralAstrodynamics.Propagation.solution — Method

solution(traj)

Returns the solution for the Trajectory. Typically, this is a DifferentialEquations.ODESolution.

source

GeneralAstrodynamics.Propagation.stable_eigenvector — Method

stable_eigenvector(monodromy; atol)

Calculates the eigenvector associated with the stable manifold of a Monodromy matrix.

source

GeneralAstrodynamics.Propagation.unstable_eigenvector — Method

unstable_eigenvector(monodromy; atol)

Calculates the eigenvector associated with the unstable manifold of a Monodromy matrix.

source

GeneralAstrodynamics.States.angularunit — Method

angularunit(man)

Returns the angular unit for the Trajectory.

source

GeneralAstrodynamics.States.angularunit — Method

angularunit(traj)

Returns the angular unit for the Trajectory.

source

GeneralAstrodynamics.States.epoch — Method

epoch(traj, t)

Returns an epoch at time t past initialepoch.

source

GeneralAstrodynamics.States.frame — Method

frame(_)

Returns the OrbitalFrame of the Manifold.

source

GeneralAstrodynamics.States.frame — Method

frame(_)

Returns the OrbitalFrame of the Trajectory.

source

GeneralAstrodynamics.States.lengthunit — Method

lengthunit(man)

Returns the length unit for the Trajectory.

source

GeneralAstrodynamics.States.lengthunit — Method

lengthunit(traj)

Returns the length unit for the Trajectory.

source

GeneralAstrodynamics.States.massparamunit — Method

massparamunit(man)

Returns the mass parameter unit for the Trajectory.

source

GeneralAstrodynamics.States.massparamunit — Method

massparamunit(traj)

Returns the mass parameter unit for the Trajectory.

source

GeneralAstrodynamics.States.massunit — Method

massunit(man)

Returns the mass unit for the Manifold.

source

GeneralAstrodynamics.States.massunit — Method

massunit(traj)

Returns the mass unit for the Trajectory.

source

GeneralAstrodynamics.States.state — Method

state(traj, t)

Returns a state of type typeof(initialstate) at time t.

source

GeneralAstrodynamics.States.system — Method

system(man)

Returns the system associated with the Manifold.

source

GeneralAstrodynamics.States.system — Method

system(traj)

Returns the system associated with the Trajectory.

source

GeneralAstrodynamics.States.timeunit — Method

timeunit(man)

Returns the time unit for the Trajectory.

source

GeneralAstrodynamics.States.timeunit — Method

timeunit(traj)

Returns the time unit for the Trajectory.

source

GeneralAstrodynamics.States.velocity — Method

velocity(traj, t)

Returns the position of the Trajectory at ttimeunit's from the initialstate's epoch.

source

GeneralAstrodynamics.States.velocityunit — Method

velocityunit(man)

Returns the velocity unit for the Trajectory.

source

GeneralAstrodynamics.States.velocityunit — Method

velocityunit(traj)

Returns the velocity unit for the Trajectory.

source

`Visualizations`

GeneralAstrodynamics.Visualizations.process_vars — Method

process_vars(vars)

Rather than supply indices, users can use Symbol instances to select indices for plotting.

Example

traj = propagate(orbit, period) plot(traj; vars=:tx) plot(traj; vars=xyz) plot(traj; vars=xẋ)

source

GeneralAstrodynamics.Visualizations.zerovelocityplot! — Method

zerovelocityplot!(
    fig,
    orbit;
    nondimensional_range,
    kwargs...
)

Plot the zero velocity curves for the Synodic, normalized CR3BP system to the last figure.

source

GeneralAstrodynamics.Visualizations.zerovelocityplot — Method

zerovelocityplot(orbit; nondimensional_range, kwargs...)

Plot the zero velocity curves for the Synodic, normalized CR3BP system.

source