shamrock.utils.disc_setup.StandardDisc Class Reference

Public Member Functions
None	__post_init__ (self)
DiscProfiles	get_profiles (self)
float	part_mass (self, int npart)
float	cs0 (self)
	make_generator (self, Any setup, int npart, *, int random_seed=666, float init_h_factor=0.8)

Static Public Attributes
shamrock	units .UnitSystem
float	H_r_0 = 0.05
float	q = 0.5
float	p = 1.5
float	r0 = 1.0
float	H_factor = 1.0
RotationMode	rotation = "subkeplerian"
bool	inner_tapering = False
bool	outer_tapering = False

Protected Member Functions
float	_G (self)
Any	_get_sigma (self)
Any	_get_vtheta_kepler (self)
Any	_get_omega_k (self, Any vtheta_kepler)
Any	_get_cs (self, Any vtheta_kepler)
Any	_get_H (self, Any cs, Any omega_k)
Any	_get_vtheta_subkeplerian (self, Any vtheta_kepler, Any cs)
Any	_get_velocity_vertical (self, Any vtheta_kepler, Any cs)
tuple[Any, Any]	_get_rotation (self, Any vtheta_kepler, Any cs)

Detailed Description

Locally isothermal LP07 disc profiles and Monte Carlo generator helper.

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

Definition at line 34 of file disc_setup.py.

Member Function Documentation

__post_init__()

None shamrock.utils.disc_setup.StandardDisc.__post_init__

(

self

)

Definition at line 55 of file disc_setup.py.

_G()

float shamrock.utils.disc_setup.StandardDisc._G ( self )

protected

Definition at line 65 of file disc_setup.py.

_get_cs()

Any shamrock.utils.disc_setup.StandardDisc._get_cs ( self, Any vtheta_kepler )

protected

Definition at line 100 of file disc_setup.py.

_get_H()

Any shamrock.utils.disc_setup.StandardDisc._get_H ( self, Any cs, Any omega_k )

protected

Definition at line 111 of file disc_setup.py.

_get_omega_k()

Any shamrock.utils.disc_setup.StandardDisc._get_omega_k ( self, Any vtheta_kepler )

protected

Definition at line 94 of file disc_setup.py.

_get_rotation()

tuple[Any, Any] shamrock.utils.disc_setup.StandardDisc._get_rotation ( self, Any vtheta_kepler, Any cs )

protected

Definition at line 147 of file disc_setup.py.

_get_sigma()

Any shamrock.utils.disc_setup.StandardDisc._get_sigma ( self )

protected

Definition at line 68 of file disc_setup.py.

_get_velocity_vertical()

Any shamrock.utils.disc_setup.StandardDisc._get_velocity_vertical ( self, Any vtheta_kepler, Any cs )

protected

Definition at line 127 of file disc_setup.py.

_get_vtheta_kepler()

Any shamrock.utils.disc_setup.StandardDisc._get_vtheta_kepler ( self )

protected

Definition at line 85 of file disc_setup.py.

_get_vtheta_subkeplerian()

Any shamrock.utils.disc_setup.StandardDisc._get_vtheta_subkeplerian ( self, Any vtheta_kepler, Any cs )

protected

Definition at line 119 of file disc_setup.py.

cs0()

float shamrock.utils.disc_setup.StandardDisc.cs0

(

self

)

Get the sound speed at the reference radius.

Definition at line 181 of file disc_setup.py.

Here is the call graph for this function:

get_profiles()

DiscProfiles shamrock.utils.disc_setup.StandardDisc.get_profiles

(

self

)

Get the profiles of the disc.

Definition at line 154 of file disc_setup.py.

Here is the call graph for this function:

make_generator()

shamrock.utils.disc_setup.StandardDisc.make_generator	(		self,
		Any	setup,
		int	npart,
		*	,
		int	random_seed = 666,
		float	init_h_factor = 0.8 )

Make a SPH generator for the disc.

Definition at line 187 of file disc_setup.py.

Here is the call graph for this function:

part_mass()

float shamrock.utils.disc_setup.StandardDisc.part_mass	(		self,
		int	npart )

Get the mass of a single particle from the total mass & number of particles.

Definition at line 175 of file disc_setup.py.

Member Data Documentation

H_factor

float shamrock.utils.disc_setup.StandardDisc.H_factor = 1.0

static

Definition at line 50 of file disc_setup.py.

H_r_0

float shamrock.utils.disc_setup.StandardDisc.H_r_0 = 0.05

static

Definition at line 46 of file disc_setup.py.

inner_tapering

bool shamrock.utils.disc_setup.StandardDisc.inner_tapering = False

static

Definition at line 52 of file disc_setup.py.

outer_tapering

bool shamrock.utils.disc_setup.StandardDisc.outer_tapering = False

static

Definition at line 53 of file disc_setup.py.

p

float shamrock.utils.disc_setup.StandardDisc.p = 1.5

static

Definition at line 48 of file disc_setup.py.

q

float shamrock.utils.disc_setup.StandardDisc.q = 0.5

static

Definition at line 47 of file disc_setup.py.

r0

shamrock.utils.disc_setup.StandardDisc.r0 = 1.0

static

Definition at line 49 of file disc_setup.py.

rotation

RotationMode shamrock.utils.disc_setup.StandardDisc.rotation = "subkeplerian"

static

Definition at line 51 of file disc_setup.py.

units

shamrock.utils.disc_setup.StandardDisc.units .UnitSystem

static

Definition at line 41 of file disc_setup.py.

---

The documentation for this class was generated from the following file:

• pylib/shamrock/utils/disc_setup.py