Aquila-Consortium/csiborgtools
0
0
Fork 0
mirror of https://github.com/Richard-Sti/csiborgtools.git synced 2024-12-22 22:28:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add docs

Browse source
This commit is contained in:
rstiskalek 2022-10-21 19:58:59 +01:00
parent dd34036219
commit ba15264eb8
1 changed files with 24 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
csiborgtools/units/box_units.py
View file

@ -24,7 +24,7 @@ from ..io import read_info
# Conversion factors # Conversion factors
MSUNCGS = constants.M_sun.cgs.value MSUNCGS = constants.M_sun.cgs.value
KPC_TO_CM = 3.08567758149137e21 KPC_TO_CM = 3.0856775814913673e+21
PI = 3.1415926535897932384626433 PI = 3.1415926535897932384626433
@ -62,7 +62,8 @@ class BoxUnits:
def box2kpc(self, length): def box2kpc(self, length):
r""" r"""
Convert length from box units to :math:`\mathrm{kpc}`. Convert length from box units to :math:`\mathrm{kpc}` (with
:math:`h=0.705`).
Parameters Parameters
---------- ----------
@ -78,7 +79,8 @@ class BoxUnits:
def kpc2box(self, length): def kpc2box(self, length):
r""" r"""
Convert length from :math:`\mathrm{kpc}` to box units. Convert length from :math:`\mathrm{kpc}` (with :math:`h=0.705`) to
box units.
Parameters Parameters
---------- ----------
@ -94,7 +96,7 @@ class BoxUnits:
def solarmass2box(self, mass): def solarmass2box(self, mass):
r""" r"""
Convert mass from :math:`M_\odot` to box units. Convert mass from :math:`M_\odot` (with :math:`h=0.705`) to box units.
Parameters Parameters
---------- ----------
@ -106,15 +108,11 @@ class BoxUnits:
mass : float mass : float
Mass in box units. Mass in box units.
""" """
m = mass * MSUNCGS # In cgs return mass / self.unit_d / (self.unit_l**3 / MSUNCGS)
unit_m = self.unit_d * self.unit_l ** 3
return m / unit_m
def box2solarmass(self, mass): def box2solarmass(self, mass):
r""" r"""
Convert mass from box units to :math:`M_\odot`. Convert mass from box units to :math:`M_\odot` (with :math:`h=0.705`).
TODO: check this.
Parameters Parameters
---------- ----------
@ -126,41 +124,38 @@ class BoxUnits:
mass : float mass : float
Mass in :math:`M_\odot`. Mass in :math:`M_\odot`.
""" """
unit_m = self.unit_d * self.unit_l**3 return mass * self.unit_d * self.unit_l**3 / MSUNCGS
m = mass * unit_m # In cgs
m = m / MSUNCGS
return m
def box2dens(self, density): def box2dens(self, density):
r""" r"""
Convert density from box units to :math:`M_\odot / \mathrm{pc}^3`. Convert density from box units to :math:`M_\odot / \mathrm{pc}^3`
(with :math:`h=0.705`).
TODO: check this.
Parameters Parameters
---------- ----------
density : float density : float
Density in box units. Density in box units.
box : `BoxConstants`
Simulation box class with units.
Returns Returns
------- -------
density : float density : float
Density in :math:`M_\odot / \mathrm{pc}^3`. Density in :math:`M_\odot / \mathrm{pc}^3`.
""" """
rho = density * self.unit_d # In cgs return density * self.unit_d / MSUNCGS * (KPC_TO_CM * 1e-3)**3
rho = rho * (KPC_TO_CM * 1e-3)**3 # In g/pc^3
rho = rho / MSUNCGS
return rho
def dens2box(self, density): def dens2box(self, density):
r""" r"""
Convert density from M_sun / pc^3 Convert density from :math:`M_\odot / \mathrm{pc}^3`
(with :math:`h=0.705`) to box units.
TODO: check this and write documentation. Parameters
----------
density : float
Density in :math:`M_\odot / \mathrm{pc}^3`.
Returns
-------
density : float
Density in box units.
""" """
rho = density * MSUNCGS return density / self.unit_d * MSUNCGS / (KPC_TO_CM * 1e-3)**3
rho = rho / (KPC_TO_CM * 1e-3)**3 # In g/cm^3
rho = rho / self.unit_d
return rho