PotentialBase
=============

.. currentmodule:: gala.potential.potential

.. autoclass:: PotentialBase
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~PotentialBase.ndim
      ~PotentialBase.units

   .. rubric:: Methods Summary

   .. autosummary::

      ~PotentialBase.__call__
      ~PotentialBase.acceleration
      ~PotentialBase.as_interop
      ~PotentialBase.circular_velocity
      ~PotentialBase.density
      ~PotentialBase.energy
      ~PotentialBase.gradient
      ~PotentialBase.hessian
      ~PotentialBase.integrate_orbit
      ~PotentialBase.mass_enclosed
      ~PotentialBase.plot_contours
      ~PotentialBase.plot_density_contours
      ~PotentialBase.plot_rotation_curve
      ~PotentialBase.replace_units
      ~PotentialBase.replicate
      ~PotentialBase.save
      ~PotentialBase.to_galpy_potential
      ~PotentialBase.to_latex
      ~PotentialBase.to_sympy
      ~PotentialBase.total_energy
      ~PotentialBase.value

   .. rubric:: Attributes Documentation

   .. autoattribute:: ndim
   .. autoattribute:: units

   .. rubric:: Methods Documentation

   .. automethod:: __call__
   .. automethod:: acceleration
   .. automethod:: as_interop
   .. automethod:: circular_velocity
   .. automethod:: density
   .. automethod:: energy
   .. automethod:: gradient
   .. automethod:: hessian
   .. automethod:: integrate_orbit
   .. automethod:: mass_enclosed
   .. automethod:: plot_contours
   .. automethod:: plot_density_contours
   .. automethod:: plot_rotation_curve
   .. automethod:: replace_units
   .. automethod:: replicate
   .. automethod:: save
   .. automethod:: to_galpy_potential
   .. automethod:: to_latex
   .. automethod:: to_sympy
   .. automethod:: total_energy
   .. automethod:: value