virial_radius

clustertools.analysis.functions.virial_radius(cluster, method='inverse_distance', full=True, H=70.0, Om=0.3, overdens=200.0, projected=False, plot=False, **kwargs)

Calculate virial radius of the cluster - Virial radius is calculated using either: – the average inverse distance between particles, weighted by their masses (default) – the radius at which the density is equal to the critical density of the Universe at the redshift of the system, multiplied by an overdensity constant Parameters ———- cluster : class

StarCluster

methodstr

method for calculating virial radius (default: ‘inverse_distance’, alternative: ‘critical_density’)

Returns:

rvfloat

virial radius

Other Parameters:

fullbool

Use Numba to calculate average inverse distance between stars (default:True)

Hfloat

Hubble constant

Omfloat

density of matter

overdensfloat

overdensity constant

projectedbool

calculate projected virial radius (default: False)

plotbool

plot cluster density profile and illustrate virial radius calculation

kwargsstr

key word arguments for plotting function