Sink quantities¶

Calculate extra quantities on the sinks.

plonk.analysis.sinks.Hill_radius(primary, secondary)¶

Calculate the Hill radius.

Parameters

primary (Sinks) – The primary, i.e. heavy object, as a Sinks object. It must have one sink.
secondary (Sinks) – The secondary, i.e. light objects, as a Sinks object. It can have more than one sink, e.g. when calculating the Hill radiius for multiple planets orbiting a star.

Returns

Return type

Quantity

plonk.analysis.sinks.Roche_sphere(sinks)¶

Calculate an estimate of the Roche sphere for two bodies.

The Roche sphere radius is calculated around the first of the two sinks. Uses the formula from Eggleton (1983) ApJ 268, 368-369.

plonk.analysis.sinks.eccentricity(sinks)¶

Calculate the eccentricity.

plonk.analysis.sinks.gravitational_potential_energy(sinks)¶

Calculate the total gravitational potential energy.

plonk.analysis.sinks.inclination(sinks)¶

Calculate the inclination for two bodies.

plonk.analysis.sinks.kinetic_energy(sinks)¶

Calculate the total kinetic energy.

plonk.analysis.sinks.mean_motion(sinks)¶

Calculate the mean motion for two bodies.

plonk.analysis.sinks.orbital_period(sinks)¶

Calculate the orbital period for two bodies.

plonk.analysis.sinks.semi_major_axis(sinks)¶

Calculate the semi-major axis for two bodies.

plonk.analysis.sinks.specific_angular_momentum(sinks)¶

Calculate the specific orbital energy for two bodies.

plonk.analysis.sinks.specific_orbital_energy(sinks)¶

Calculate the specific orbital energy for two bodies.

Global quantities

Accretion discs