galpy.potential.toPlanarPotential

galpy.potential.toPlanarPotential(Pot)

Convert an Potential to a planarPotential in the mid-plane (z=0).

Parameters:

Pot (Potential instance or a combined potential formed using addition (pot1+pot2+…)) – Existing planarPotential instances are just copied to the output.

Returns:

instance(s)

Return type:

planarPotential, planarCompositePotential, or planarDissipativeForce

Notes

• 2016-06-11: Written - Bovy (UofT)

• 2024-11-27: Updated to return planarCompositePotential for multiple potentials - Copilot