virialize

clustertools.cluster.operations.virialize(cluster, qvir=0.5, specific=True, full=True, projected=False, softening=0.0)

Adjust stellar velocities so cluster is in virial equilibrium

Parameters:

clusterclass

StarCluster

qvirfloat

value you wish to virial parameter to be (default: 0.5)

specificbool

find specific energies (default: True)

full: bool

do full array of stars at once with numba (default: full_default)

projectedbool

use projected values when calculating energies (default: False)

softeningfloat

Plummer softening length in cluster.units (default: 0.0)

Returns

——-

qvfloat

scaling factor used to adjust velocities