Merge pull request #444 from morganb-phys/scfnbody

Calculation of SCF expansion based on an N-body representation of the density

AUTHORS.txt

@@ -26,6 +26,7 @@ Samuel Wong (sampleV_interpolate method of quasiisothermaldf)
 James Lane (General mass distributions in MovingObjectPotential)
 Henry Leung (addition of Python and C implementation of Dormand-Prince 8(5,3) integrator)
 Nathaniel Starkman (custom coordinates in bovy_coords, DehnenSphericalPotential, time dependences in potential, amuse-astropy Potential compatibility)
+Morgan Bennett (scf_compute_.._nbody functions for computing SCF expansions for N-body sims)
 
 General help:
 ==============
@@ -36,7 +37,7 @@ Brigitta Sipocz (help with conda build)
 
 Bug reports:
 ============
-(incomplete list, apologies if I forgot anybody!)
+(very incomplete list, apologies if I forgot anybody!)
 
 Alexander de la Vega
 Wai-Hin Ngan
@@ -53,3 +54,4 @@ Ruth Angus
 Anthony Brown
 Larry Widrow
 Jean-François Robitaille
+...

HISTORY.txt

@@ -17,6 +17,10 @@ v1.7 (XXXX-XX-XX)
   sampled, and their velocity moments can be computed. Work started in
   #432 and continued on from there.
 
+- Implemented the calculation of SCF density/potential expansion
+  coefficients based on an N-body representation of the density
+  (#444).
+
 - Added NFWPotential initialization method using rmax and vmax, the
   radius and alue at which the rotation curve peaks; also added rmax
   and vmax methods to NFWPotential to compute these quantities for any

doc/source/reference/potential.rst

@@ -121,7 +121,10 @@ In addition to these, the following methods are available to compute expansion c
 
    scf_compute_coeffs <potentialscfcompute.rst>
    scf_compute_coeffs_axi <potentialscfcomputeaxi.rst>
+   scf_compute_coeffs_axi_nbody <potentialscfcomputeaxinbody.rst>
+   scf_compute_coeffs_nbody <potentialscfcomputenbody.rst>
    scf_compute_coeffs_spherical <potentialscfcomputesphere.rst>
+   scf_compute_coeffs_spherical_nbody <potentialscfcomputespherenbody.rst>
 
 Specific potentials
 +++++++++++++++++++

doc/source/reference/potentialscfcomputeaxinbody.rst

@@ -0,0 +1,13 @@
+.. _scf_compute_coeffs_axi_nbody:
+
+galpy.potential.scf_compute_coeffs_axi_nbody
+============================================
+
+This function is the equivalent to :ref:`scf_compute_coeffs_axi` but computing the coefficients based on an N-body representation of the density.
+
+Note: This function computes Acos and Asin as defined in `Hernquist & Ostriker (1992) <http://adsabs.harvard.edu/abs/1992ApJ...386..375H>`_, except that we multiply Acos by 2 such that the density from :ref:`Galpy's Hernquist Potential <hernquist_potential>` corresponds to :math:`Acos = \delta_{0n}\delta_{0l}\delta_{0m}`.
+
+Further note that this function is a specification of :ref:`scf_compute_coeffs_nbody` where :math:`Acos_{nlm} = 0` at :math:`m\neq0` and :math:`Asin_{nlm} = None`.
+
+.. autofunction:: galpy.potential.scf_compute_coeffs_axi_nbody
+

doc/source/reference/potentialscfcomputenbody.rst

@@ -0,0 +1,11 @@
+.. _scf_compute_coeffs_nbody:
+
+galpy.potential.scf_compute_coeffs_nbody
+========================================
+
+This function is the equivalent to :ref:`scf_compute_coeffs` but computing the coefficients based on an N-body representation of the density.
+
+Note: This function computes Acos and Asin as defined in `Hernquist & Ostriker (1992) <http://adsabs.harvard.edu/abs/1992ApJ...386..375H>`_, except that we multiply Acos and Asin by 2 such that the density from :ref:`Galpy's Hernquist Potential <hernquist_potential>` corresponds to :math:`Acos = \delta_{0n}\delta_{0l}\delta_{0m}` and :math:`Asin = 0`.
+
+.. autofunction:: galpy.potential.scf_compute_coeffs_nbody
+

doc/source/reference/potentialscfcomputespherenbody.rst

@@ -0,0 +1,13 @@
+.. _scf_compute_coeffs_sphere_nbody:
+
+galpy.potential.scf_compute_coeffs_spherical_nbody
+==================================================
+
+This function is the equivalent to :ref:`scf_compute_coeffs_sphere` but computing the coefficients based on an N-body representation of the density.
+
+Note: This function computes Acos and Asin as defined in `Hernquist & Ostriker (1992) <http://adsabs.harvard.edu/abs/1992ApJ...386..375H>`_, except that we multiply Acos by 2 such that the density from :ref:`Galpy's Hernquist Potential <hernquist_potential>` corresponds to :math:`Acos = \delta_{0n}\delta_{0l}\delta_{0m}`.
+
+Futher note that this function is a specification of :ref:`scf_compute_coeffs_nbody` where :math:`Acos_{nlm} = 0` at :math:`l\neq0`
+
+.. autofunction:: galpy.potential.scf_compute_coeffs_spherical_nbody
+