shamrock.utils.disc_setup.StandardDisc#

class shamrock.utils.disc_setup.StandardDisc(units: UnitSystem, center_mass: float, disc_mass: float, rin: float, rout: float, H_r_0: float = 0.05, q: float = 0.5, p: float = 1.5, r0: float = 1.0, H_factor: float = 1.0, rotation: Literal['keplerian', 'subkeplerian', 'subkeplerian_3d'] = 'subkeplerian', inner_tapering: bool = False, outer_tapering: bool = False)#

Bases: object

Locally isothermal LP07 disc profiles and Monte Carlo generator helper.

All radii and masses are expressed in the provided code unit system.

Methods

`cs0`	Get the sound speed at the reference radius.
`get_profiles`	Get the profiles of the disc.
`make_generator`	Make a SPH generator for the disc.
`part_mass`	Get the mass of a single particle from the total mass & number of particles.

Attributes

`H_factor`
`H_r_0`
`inner_tapering`
`outer_tapering`
`p`
`q`
`r0`
`rotation`
`units`
`center_mass`
`disc_mass`
`rin`
`rout`

cs0() → float#: Get the sound speed at the reference radius.

get_profiles() → DiscProfiles#: Get the profiles of the disc.

make_generator(setup: Any, npart: int, *, random_seed: int = 666, init_h_factor: float = 0.8)#: Make a SPH generator for the disc.

part_mass(npart: int) → float#: Get the mass of a single particle from the total mass & number of particles.