Welcome to RichSuiteDocs’s documentation!¶
Introduction:
Users' Manuals:
Developers' Manuals
- Generating the fortran doc
- The pyRich tools
- Main code
- The field modules and programs
- Module mag_dipole_line
- Module mag_field_line
- Module mag_field_line_bin
- Module mag_field_vol
- Module mag_field_vol_bin
- Module mag_harmonic
- Module mag_pot_field
- Module build_field_line
- Module build_field_lines
- Module build_field_map
- Module build_pot_field
- Module calc_b_z
- Module dipole_params
- Module measure_loops
- Module test_mag_harmonic
- The ADM modules and programs
- The astro modules and programs
- The core modules and programs
- Module core_bracket
- Module core_c
- Module core_constants
- Module core_cspline
- Module core_env
- Module core_func
- Module core_hgroup
- Module core_integ
- Module core_interp
- Module core_kinds
- Module core_legendre
- Module core_linalg
- Module core_list
- Module core_lspline
- Module core_memory
- Module core_multi_func
- Module core_order
- Module core_parallel
- Module core_random
- Module core_spline
- Module core_string
- Module core_system
- Module core_table
- Module core_volume
- The mag_common modules and programs
- The field modules and programs
testing format here¶
-
class
astro_star¶ -
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)¶
-