Skip to content

Commit

Permalink
celestial bodies rotational elements interface
Browse files Browse the repository at this point in the history
  • Loading branch information
andreapasquale94 committed May 31, 2024
1 parent 6fc9be4 commit 4e679a5
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "JSMDInterfaces"
uuid = "6b30ee2f-618e-4a15-bf4e-7df7b496e609"
authors = ["JSMD Team"]
version = "1.5.0"
version = "1.6.0"

[deps]
Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
Expand Down
52 changes: 52 additions & 0 deletions src/Bodies.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
module Bodies

"""
body_rotational_elements(T, ::Val{id})
Interface to compute the rotational elements of a body with ID `id`.
Rotational elements includes `α`, `δ` and `W` that identifies the north pole
of the body and its prime meridian.
The north pole is that pole of rotation that lies on the north side of the
invariable plane of the solar system. Its direction is specified by the values
of its right ascension `α`, declination `δ` .
The location of the prime meridian is then given by `W`, which is a rotation
in the body equator of date.
"""
function body_rotational_elements end
function ∂body_rotational_elements end
function ∂²body_rotational_elements end
function ∂³body_rotational_elements end

"""
body_pole(T, ::Val{id})
Interface to compute the north pole direction of the `id` body.
"""
function body_pole end

"""
body_right_ascension(T, ::Val{id})
Interface to compute the right ascension of the north pole of a
body identified by `id`.
"""
function body_right_ascension end

"""
body_declination(T, ::Val{id})
Interface to compute the declination of the north pole of a
body identified by `id`.
"""
function body_declination end

"""
body_prime_meridian(T, ::Val{id})
Interface to compute the prime meridian angle of a body identified by `id`.
"""
function body_prime_meridian end

end
1 change: 1 addition & 0 deletions src/JSMDInterfaces.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ include("Frames.jl")
include("Math.jl")
include("Ephemeris.jl")
include("Models.jl")
include("Bodies.jl")

end

0 comments on commit 4e679a5

Please sign in to comment.