Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use generic named variables in coordinates module #656

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

Use generic named variables in coordinates module #656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift click to select a range
93aaba7
this commit addresses #650
TONYOG12 Jan 30, 2024
caeae12
fix failed tests on quality ci
TONYOG12 Jan 30, 2024
7a99950
Update differential.py
TONYOG12 Jan 30, 2024
2647f31
fix failing tests
TONYOG12 Jan 30, 2024
54c7414
fix test conversions.py errors
TONYOG12 Jan 30, 2024
233a8d2
updates to adhere to pep8
TONYOG12 Jan 30, 2024
21e776c
address pep8 issues
TONYOG12 Jan 30, 2024
f3ef3f3
remove _velocities_provided and code duplication
TONYOG12 Jan 31, 2024
e6f0a7a
Update utils.py
TONYOG12 Jan 31, 2024
8a9906c
explicit typing for calculate_coordinates function
TONYOG12 Jan 31, 2024
01e5018
Update utils.py
TONYOG12 Jan 31, 2024
a88d365
Breaking Change
TONYOG12 Apr 27, 2024
164616f
move __str__, __repr__, __getitem__, position and system into the ba…
TONYOG12 May 20, 2024
35efca6
Update differential.py
TONYOG12 May 20, 2024
49ca159
Merge branch 'main' into streamline-the-coordinates-module
TONYOG12 May 29, 2024
b6d8e58
update timelike component of 4-v
TONYOG12 Jun 17, 2024
abfd6f6
Update differential.py
TONYOG12 Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
364 changes: 182 additions & 182 deletions bin/geodesics_units/old_test_geodesics.py
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions ...sualizing Event Horizon and Ergosphere (Singularities) of Kerr Metric or Black Hole.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions src/einsteinpy/bodies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 78,11 @@ def check_units(mass, q, R):
diff = self.coords
if diff:
if isinstance(diff, CartesianDifferential):
self.pos_vec = [diff.x, diff.y, diff.z]
self.vel_vec = [diff.v_x, diff.v_y, diff.v_z]
self.pos_vec = [diff.e1, diff.e2, diff.e3]
self.vel_vec = [diff.u0, diff.u1, diff.u2]
elif isinstance(diff, (SphericalDifferential, BoyerLindquistDifferential)):
self.pos_vec = [diff.r, diff.theta, diff.phi]
self.vel_vec = [diff.v_r, diff.v_th, diff.v_p]
self.pos_vec = [diff.e1, diff.e2, diff.e3]
self.vel_vec = [diff.u0, diff.u1, diff.u2]

def __str__(self):
return dedent(
Expand Down
245 changes: 65 additions & 180 deletions src/einsteinpy/coordinates/conversion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,44 7,42 @@
from einsteinpy.metric import BaseMetric


class CartesianConversion:
class BaseCoordinateConversion:
"""
Class for conversion to and from Cartesian Coordinates in SI units
Base Coordinate conversion class

"""

def __init__(self, t, x, y, z, v_x=None, v_y=None, v_z=None):
def __init__(self, e0, e1, e2, e3, u0=None, u1=None, u2=None):
JeS24 marked this conversation as resolved.
Show resolved Hide resolved
"""
Constructor

Parameters
----------
t : float
e0 : float
Time
x : float
e1 : float
x-Component of 3-Position
y : float
e2 : float
y-Component of 3-Position
z : float
e3 : float
z-Component of 3-Position
v_x : float, optional
u0 : float, optional
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

u0 should correspond to the temporal component of velocity, like how e0 is the temporal component for (4-)position. So, here, you can start at u1, u2, u3 and rename v_t to u0 elsewhere (e.g., in differential.py)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved

x-Component of 3-Velocity
v_y : float, optional
u1 : float, optional
y-Component of 3-Velocity
v_z : float, optional
u2 : float, optional
z-Component of 3-Velocity

"""
self.t_si = t
self.x_si = x
self.y_si = y
self.z_si = z
self.v_x_si = v_x
self.v_y_si = v_y
self.v_z_si = v_z
self._velocities_provided = not (
(v_x is None) or (v_y is None) or (v_z is None)
)
self.e0_si = e0
self.e1_si = e1
self.e2_si = e2
self.e3_si = e3
self.u0_si = u0
self.u1_si = u1
self.u2_si = u2
self._velocities_provided = not ((u0 is None) or (u1 is None) or (u2 is None))

def values(self):
"""
Expand All @@ -53,23 51,30 @@ def values(self):
Returns
-------
tuple
4-Tuple, containing ``t, x, y, z`` in SI units
or 7-tuple, containing ``t, x, y, z, v_x, v_y, v_z`` \
4-Tuple, containing ``e0, e1, e2, e3`` in SI units
or 7-tuple, containing ``e0, e1, e2, e3, u0, u1, u2`` \
in SI units

"""
if self._velocities_provided:
return (
self.t_si,
self.x_si,
self.y_si,
self.z_si,
self.v_x_si,
self.v_y_si,
self.v_z_si,
self.e0_si,
self.e1_si,
self.e2_si,
self.e3_si,
self.u0_si,
self.u1_si,
self.u2_si,
)

return self.t_si, self.x_si, self.y_si, self.z_si
return self.e0_si, self.e1_si, self.e2_si, self.e3_si


class CartesianConversion(BaseCoordinateConversion):
"""
Class for conversion to and from Cartesian Coordinates in SI units

"""

def convert_spherical(self, **kwargs):
"""
Expand All @@ -88,14 93,13 @@ def convert_spherical(self, **kwargs):

"""
return cartesian_to_spherical_fast(
self.t_si,
self.x_si,
self.y_si,
self.z_si,
self.v_x_si,
self.v_y_si,
self.v_z_si,
self._velocities_provided,
self.e0_si,
self.e1_si,
self.e2_si,
self.e3_si,
self.u0_si,
self.u1_si,
self.u2_si,
)

def convert_bl(self, **kwargs):
Expand Down Expand Up @@ -140,82 144,23 @@ def convert_bl(self, **kwargs):
alpha = BaseMetric.alpha(M=M, a=a)

return cartesian_to_bl_fast(
self.t_si,
self.x_si,
self.y_si,
self.z_si,
self.e0_si,
self.e1_si,
self.e2_si,
self.e3_si,
alpha,
self.v_x_si,
self.v_y_si,
self.v_z_si,
self._velocities_provided,
self.u0_si,
self.u1_si,
self.u2_si,
)


class SphericalConversion:
class SphericalConversion(BaseCoordinateConversion):
"""
Class for conversion to and from Spherical Polar Coordinates in SI units

"""

def __init__(self, t, r, theta, phi, v_r=None, v_th=None, v_p=None):
"""
Constructor

Parameters
----------
t : float
Time
r : float
r-Component of 3-Position
theta : float
theta-Component of 3-Position
phi : float
phi-Component of 3-Position
v_r : float, optional
r-Component of 3-Velocity
v_th : float, optional
theta-Component of 3-Velocity
v_p : float, optional
phi-Component of 3-Velocity

"""
self.t_si = t
self.r_si = r
self.th_si = theta
self.p_si = phi
self.v_r_si = v_r
self.v_th_si = v_th
self.v_p_si = v_p
self._velocities_provided = not (
(v_r is None) or (v_th is None) or (v_p is None)
)

def values(self):
"""
Returns components of the coordinates

Returns
-------
tuple
4-Tuple containing ``t, r, theta, phi`` in SI units
or 7-tuple, containing ``t, r, theta, phi, v_r, v_th, v_p`` \
in SI units

"""
if self._velocities_provided:
return (
self.t_si,
self.r_si,
self.th_si,
self.p_si,
self.v_r_si,
self.v_th_si,
self.v_p_si,
)

return self.t_si, self.r_si, self.th_si, self.p_si

def convert_cartesian(self, **kwargs):
"""
Converts to Cartesian Coordinates
Expand All @@ -233,14 178,13 @@ def convert_cartesian(self, **kwargs):

"""
return spherical_to_cartesian_fast(
self.t_si,
self.r_si,
self.th_si,
self.p_si,
self.v_r_si,
self.v_th_si,
self.v_p_si,
self._velocities_provided,
self.e0_si,
self.e1_si,
self.e2_si,
self.e3_si,
self.u0_si,
self.u1_si,
self.u2_si,
)

def convert_bl(self, **kwargs):
Expand Down Expand Up @@ -288,70 232,12 @@ def convert_bl(self, **kwargs):
return cart.convert_bl(M=M, a=a)


class BoyerLindquistConversion:
class BoyerLindquistConversion(BaseCoordinateConversion):
"""
Class for conversion to and from Boyer-Lindquist Coordinates in SI units

"""

def __init__(self, t, r, theta, phi, v_r=None, v_th=None, v_p=None):
"""
Constructor

Parameters
----------
t : float
Time
r : float
r-Component of 3-Position
theta : float
theta-Component of 3-Position
phi : float
phi-Component of 3-Position
v_r : float, optional
r-Component of 3-Velocity
v_th : float, optional
theta-Component of 3-Velocity
v_p : float, optional
phi-Component of 3-Velocity

"""
self.t_si = t
self.r_si = r
self.th_si = theta
self.p_si = phi
self.v_r_si = v_r
self.v_th_si = v_th
self.v_p_si = v_p
self._velocities_provided = not (
(v_r is None) or (v_th is None) or (v_p is None)
)

def values(self):
"""
Returns components of the coordinates

Returns
-------
tuple
4-Tuple containing ``t, r, theta, phi`` in SI units
or 7-tuple, containing ``t, r, theta, phi, v_r, v_th, v_p`` \
in SI units

"""
if self._velocities_provided:
return (
self.t_si,
self.r_si,
self.th_si,
self.p_si,
self.v_r_si,
self.v_th_si,
self.v_p_si,
)

return self.t_si, self.r_si, self.th_si, self.p_si

def convert_cartesian(self, **kwargs):
"""
Converts to Cartesian Coordinates
Expand Down Expand Up @@ -394,15 280,14 @@ def convert_cartesian(self, **kwargs):
alpha = BaseMetric.alpha(M=M, a=a)

return bl_to_cartesian_fast(
self.t_si,
self.r_si,
self.th_si,
self.p_si,
self.e0_si,
self.e1_si,
self.e2_si,
self.e3_si,
alpha,
self.v_r_si,
self.v_th_si,
self.v_p_si,
self._velocities_provided,
self.u0_si,
self.u1_si,
self.u2_si,
)

def convert_spherical(self, **kwargs):
Expand Down
Loading
Loading