initialize_star_cluster_Contenta2018

eridanus_pbh.scripts.Contenta18.Contenta18.initialize_star_cluster_Contenta2018(Mcluster: Union[int, unit<MSun>], potential: Any, Rhm: unit<parsec> = quantity<10 parsec>, position: unit<kpc> = quantity<[0.14, 0.0, 0.0] kpc>, velocity=None, vel_dir: unit<kms> = [0, 1, 0], evln_func=<class 'amuse.community.sse.interface.SSE'>, gravity_func=<class 'amuse.community.bhtree.interface.BHTree'>, gravity_kwargs={}, smoothing_length: unit<parsec> = quantity<0.1 parsec>, opening_angle: float = 0.6, number_of_workers=8, timestep: unit<Myr> = quantity<25 kyr>, random=RandomState(MT19937) at 0x11FF44160, make_unbound=True, make_plot=False, logger=<utilipy.utils.logging._LogPrint.LogPrint object at 0x11ff48390>, verbose=None, _scale_to_standard: bool = True, _use_self_gravity: Union[typing_extensions.Literal[0], typing_extensions.Literal[1]] = 1)

Initialize Contenta (2018) star cluster.

Parameters

Mcluster: amuse units.MSun

mass of cluster if unitless, assumed to be number_of_particles the number of particlues is derived using num_particles_from_mtot_given_mass_func

potential: galpy amuse potential

potential of galaxy about which cluster orbits used for calculating a circular orbital velocity (Contenta 2018)

Rhm: amuse units.parsec

half-mass radius

pos: list amuse units.kpc

Galactocentric position

position: amuse distance 3-list quantity, optional (default [0,0,0] pc)

the position of the system in GC coordinates

velocity: amuse velocity quantity, optional (default None)

the velocity magnitude of the system in GC coordinates None will calculate a circular velocity (magnitude) at the position

vel_dir: 3-list

velocity unit direction

evln_func: function, optional (default SeBa)

object evolution function signature of function should be:

func(metallicity, **evln_kwargs)

the metallicity is 0.0008

smoothing_length: amuse distance quantity, optional (default 0 pc)

the smoothing length used in scaling and the gravity

opening_angle: float, optional (default 0.6)

number_of_workers: int, optional (default 1)

number of gravity workers

timestep: amuse time quantity, optional

the timestep for evolving the gravity and stellar evolution default, 0.1 Gyr

random: True or random number generator, optional

(default True) ex: np.random.default_rng(seed=0) will default to random seed

include_unboundbool

whether to also make the unbound cluster (default True)

Returns

bound_system: System

bound_inputs: BoundArgument

BoundArgument to initialize_system, which this function wraps can be used with recreate_system to reconstruct a System.

unbound_systemSystem

if make_unbound is True

unbound_inputsBoundArgument

if make_unbound is True

Raises

TypeError

if Mcluster does not have units of Mass and is not an integer

Notes

metallicity=0.0008