The astro modules and programs

Module astro_bin_vero

Module : astro_bin_vero

Purpose : Version of centrifugally disorted star to account for phase locked binary.

class star_t
class discfunc_t
star_t_(m, ar) result (st)
Phi_eff_(this, vr) result (Phi_eff)
vg_eff_(this, vr) result (vg_eff)
vn_eff_(this, vr) result (vn_eff)
D_surf_(this, vr) result (D_surf)
Sigma_0_(this) result (Sigma_0)
Sigma_1_(this) result (Sigma_1)
A_surf_(this) result (A_surf)
R_surf_(this, theta) result (R_surf)
s_surf_(this, vr_0, vdr) result (s_surf)
eval_c_(this, z) result (f_z)
read_(hg, st)
write_(hg, st)
bcast_(st, root_rank)

Module astro_hough

Module : astro_hough

Purpose : calculation of Hough eigenvalues & eigenfunctions, incl. hough_t type

class hough_t
hough_t_n_(nu, m, k, n) result (ho)
hough_t_tol_(nu, m, k, tol) result (ho)
Theta_(this, mu) result (Theta)
Theta_xi_(this, mu) result (Theta_xi)
Xi_(nu, m, n, parity)
J_lm_(l, m)
P_lm_series(n, m, x) result (P_lm)
dP_lm_series(n, m, x) result (dP_lm)
N_lm_series(n, m) result (N_lm)
lambda_n_(nu, m, k, n) result (lambda)
lambda_tol_(nu, m, k, tol) result (lambda)
lambda_asymp(nu, m, k) result (lambda)
lambda_3(nu, m, k) result (lambda)
eval_coeffs_(nu, m, k, lambda, b, c_r, c_t, c_p)
eval_eigvecs_(nu, m, k, lambda, b, q, r)
eigen_W_n_(nu, m, k, n, lambda, b)
eigen_W_tol_(nu, m, k, tol, lambda, b)
eigen_A_i_(nu, m, parity, n, i, k, lambda, b)
eval_A_(nu, m, n, parity, A_D, A_E)
assemble_A_(nu, m, n, parity, A_1, A_2n, A_2d, A_3n, A_3d, A_4n, A_4d, A_5, A_D, A_E)
save_ieee_state_(h_over, h_zero, h_inval)
restore_ieee_state_(h_over, h_zero, h_inval)

Module astro_orbit

Module : astro_orbit

Purpose : binary orbits

class orbit_t
class lagrange_func_t
phase_(this, t, t_peri) result (phase)
a_(this, star) result (a)
rho_(this, upsilon, star) result (rho)
rho_dot_(this, upsilon, star) result (rho_dot)
r_(this, phase, star) result (r)
r_dot_(this, phase, star) result (r_dot)
upsilon_(this, phase, star) result (upsilon)
E_5_(e, M) result (E_5)
upsilon_dot_(this, phase, star) result (upsilon_dot)
vr_(this, phase, star) result (vr)
vv_(this, phase, star) result (vv)
vr_L_(this, phase, i) result (vr_L)
eval_c_(this, z) result (f_z)
lagrange_force(lf, x) result (f)

Module astro_star

Module : astro_star

Purpose : centrifugally disorted star

class star_t
class discfunc_t
star_t_(omega) result (st)

Testing the docstrings Another line of doc string Here’s the more complete description that continues on another line

Phi_eff_(this, vr) result (Phi_eff)

Calculate the effective potential (units: G M_star/R_pole) at vr (units: R_pole)

Parameters
  • this – a star_t object

  • vr – a position

Rtype Phi_eff

the potential as position vr

vg_eff_(this, vr) result (vg_eff)
vn_eff_(this, vr) result (vn_eff)
D_surf_(this, vr) result (D_surf)
Sigma_0_(this) result (Sigma_0)
Sigma_1_(this) result (Sigma_1)
A_surf_(this) result (A_surf)
R_surf_(this, theta) result (R_surf)
s_surf_(this, vr_0, vdr) result (s_surf)
eval_c_(this, z) result (f_z)
read_(hg, st)
write_(hg, st)
bcast_(st, root_rank)