check_mass_freq_input

legwork.evol.check_mass_freq_input(beta=None, m_1=None, m_2=None, a_i=None, f_orb_i=None)[source]

Check that mass and frequency input is valid

Helper function to check that either beta or (m_1 and m_2) is provided and that a_i or f_orb_i is provided as well as calculate quantities that are not passed as arguments.

Parameters
betafloat/array

Constant defined in Peters and Mathews (1964) Eq. 5.9. See legwork.utils.beta() (if supplied m_1 and m_2 are ignored)

m_1float/array

Primary mass (required if beta is None)

m_2float/array

Secondary mass (required if beta is None)

a_ifloat/array

Initial semi-major axis (if supplied f_orb_i is ignored)

f_orb_ifloat/array

Initial orbital frequency (required if a_i is None)

Returns
betafloat/array

Constant defined in Peters and Mathews (1964) Eq. 5.9. See legwork.utils.beta()

a_ifloat/array

Initial semi-major axis