synthpop.modules.kinematics.velocity_gradient

Velocity gradient kinematics module

This module applies solid body rotation until it reaches the LSR rotation velocity, then uses that value. It can apply velocity dispersions in three dimensions.

Classes

VelocityGradient

Velocity gradient kinematics module

Module Contents

class synthpop.modules.kinematics.velocity_gradient.VelocityGradient(sigma_u: float, sigma_v: float, sigma_w: float, sun: types.ModuleType = None, vel_grad: float = 60.0, **kwargs)

Bases: synthpop.modules.kinematics._kinematics.Kinematics

Velocity gradient kinematics module

Attributes

kinematics_func_namestr

name of the Kinematics Class

sigma_ufloat

velocity dispersion in x direction

sigma_vfloat

velocity dispersion in y direction

sigma_wfloat

velocity dispersion in z direction

vel_gradfloat

rotation velocity gradient

Methods

draw_random_velocity(self, x: ndarray, y: ndarray, z: ndarray, mass: ndarray = None,

all_x: ndarray = None, all_y: ndarray = None, all_z: ndarray = None, all_mass: ndarray = None ) : ndarray [km/s]

returns a random velocity of a star in km/s.

kinematics_func_name = 'VelocityGradient'

sun = None

sigma_u

sigma_v

sigma_w

vel_grad = 60.0

draw_random_velocity(x: np.ndarray or float, y: np.ndarray or float, z: np.ndarray or float, **kwargs) → Tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray]

Generate a random velocities u,v,w by using a velocity dispersion

Parameters

x, y, znparray, float [kpc]

galactocentric coordinates

Returns

u, v, wndarray [km/s]

velocity in galactocentric x,y,and z direction.