from typing import Dict, TYPE_CHECKING
from TidalPy.utilities.performance import njit
from ...eccentricity_funcs import orderl2, orderl3, orderl4, orderl5, orderl6
if TYPE_CHECKING:
from TidalPy.utilities.types import FloatArray
from ...eccentricity_funcs import EccenOutput
[docs]
@njit(cacheable=True)
def eccentricity_truncation_2_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 2
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc2(eccentricity),
3: orderl3.eccentricity_funcs_trunc2(eccentricity),
4: orderl4.eccentricity_funcs_trunc2(eccentricity),
5: orderl5.eccentricity_funcs_trunc2(eccentricity),
6: orderl6.eccentricity_funcs_trunc2(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_4_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 4
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc4(eccentricity),
3: orderl3.eccentricity_funcs_trunc4(eccentricity),
4: orderl4.eccentricity_funcs_trunc4(eccentricity),
5: orderl5.eccentricity_funcs_trunc4(eccentricity),
6: orderl6.eccentricity_funcs_trunc4(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_6_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 6
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc6(eccentricity),
3: orderl3.eccentricity_funcs_trunc6(eccentricity),
4: orderl4.eccentricity_funcs_trunc6(eccentricity),
5: orderl5.eccentricity_funcs_trunc6(eccentricity),
6: orderl6.eccentricity_funcs_trunc6(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_8_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 8
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc8(eccentricity),
3: orderl3.eccentricity_funcs_trunc8(eccentricity),
4: orderl4.eccentricity_funcs_trunc8(eccentricity),
5: orderl5.eccentricity_funcs_trunc8(eccentricity),
6: orderl6.eccentricity_funcs_trunc8(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_10_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 10
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc10(eccentricity),
3: orderl3.eccentricity_funcs_trunc10(eccentricity),
4: orderl4.eccentricity_funcs_trunc10(eccentricity),
5: orderl5.eccentricity_funcs_trunc10(eccentricity),
6: orderl6.eccentricity_funcs_trunc10(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_12_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 12
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc12(eccentricity),
3: orderl3.eccentricity_funcs_trunc12(eccentricity),
4: orderl4.eccentricity_funcs_trunc12(eccentricity),
5: orderl5.eccentricity_funcs_trunc12(eccentricity),
6: orderl6.eccentricity_funcs_trunc12(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_14_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 14
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc14(eccentricity),
3: orderl3.eccentricity_funcs_trunc14(eccentricity),
4: orderl4.eccentricity_funcs_trunc14(eccentricity),
5: orderl5.eccentricity_funcs_trunc14(eccentricity),
6: orderl6.eccentricity_funcs_trunc14(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_16_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 16
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc16(eccentricity),
3: orderl3.eccentricity_funcs_trunc16(eccentricity),
4: orderl4.eccentricity_funcs_trunc16(eccentricity),
5: orderl5.eccentricity_funcs_trunc16(eccentricity),
6: orderl6.eccentricity_funcs_trunc16(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_18_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 18
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc18(eccentricity),
3: orderl3.eccentricity_funcs_trunc18(eccentricity),
4: orderl4.eccentricity_funcs_trunc18(eccentricity),
5: orderl5.eccentricity_funcs_trunc18(eccentricity),
6: orderl6.eccentricity_funcs_trunc18(eccentricity)
}
return result_by_orderl
[docs]
@njit(cacheable=True)
def eccentricity_truncation_20_maxl_6(eccentricity: 'FloatArray') -> Dict[int, 'EccenOutput']:
""" Calculates eccentricity functions (squared) for a given maximum tidal order (going through each l)
Truncation level = 20
Max Supported l = 6
Parameters
----------
eccentricity : FloatArray
Orbital Eccentricity
Returns
-------
result_by_orderl : Dict[int, EccenOutput]
Eccentricity function G^2_lpq truncated. Stored by order-l.
"""
result_by_orderl = {
2: orderl2.eccentricity_funcs_trunc20(eccentricity),
3: orderl3.eccentricity_funcs_trunc20(eccentricity),
4: orderl4.eccentricity_funcs_trunc20(eccentricity),
5: orderl5.eccentricity_funcs_trunc20(eccentricity),
6: orderl6.eccentricity_funcs_trunc20(eccentricity)
}
return result_by_orderl