gcmotion.Profile.findEnergy#
- Profile.findEnergy(psi: Quantity, theta: float, units: str, potential: bool = True)#
Calculates the Energy of a particle characterized by a (psi, theta) pair. Both Pzeta and mu must be defined.
- Parameters:
- psiQuantity
The particle’s psi Quantity.
- thetafloat
The particle’s \(\theta\) angle.
- unitsstr
The returned Energy units.
- potentialbool, optional
Whether or not to add the electric potential term in the energy. Defaults to True.
- Returns:
- Quantity
The calculated Energy Quantity in the specified units.