Move sph module from utils to analysis package

dmentipl · Aug 10, 2020 · 1dc4f18 · 1dc4f18
1 parent c195cff
commit 1dc4f18
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 5 deletions.
diff --git a/docs/source/api/analysis.rst b/docs/source/api/analysis.rst
@@ -38,5 +38,5 @@ SPH summation
 
 This section contains functions to perform SPH summation and derivatives.
 
-.. autofunction:: plonk.utils.sph.derivative
-.. autofunction:: plonk.utils.sph.summation
+.. autofunction:: plonk.analysis.sph.derivative
+.. autofunction:: plonk.analysis.sph.summation
diff --git a/docs/source/api/miscellaneous.rst b/docs/source/api/miscellaneous.rst
@@ -10,3 +10,9 @@ Here are some useful utility functions.
 .. autofunction:: plonk.utils.math.norm
 .. autofunction:: plonk.utils.utils.is_documented_by
 .. autofunction:: plonk.utils.utils.time_string
+.. autofunction:: plonk.utils.kernels.kernel_cubic
+.. autofunction:: plonk.utils.kernels.kernel_quintic
+.. autofunction:: plonk.utils.kernels.kernel_wendland_c4
+.. autofunction:: plonk.utils.kernels.kernel_gradient_cubic
+.. autofunction:: plonk.utils.kernels.kernel_gradient_quintic
+.. autofunction:: plonk.utils.kernels.kernel_gradient_wendland_c4
diff --git a/plonk/analysis/__init__.py b/plonk/analysis/__init__.py
@@ -28,7 +28,16 @@
 >>> Roche = sinks.Roche_sphere(m1, m2, separation)
 """
 
-from . import discs, filters, particles, sinks, total
+from . import discs, filters, particles, sinks, sph, total
 from .profile import Profile, load_profile
 
-__all__ = ['Profile', 'discs', 'filters', 'load_profile', 'particles', 'sinks', 'total']
+__all__ = [
+    'Profile',
+    'discs',
+    'filters',
+    'load_profile',
+    'particles',
+    'sinks',
+    'sph',
+    'total',
+]
diff --git a/plonk/utils/sph.py → plonk/analysis/sph.py b/plonk/utils/sph.py → plonk/analysis/sph.py
@@ -10,7 +10,7 @@
 from numpy import ndarray
 
 from .._logging import logger
-from .kernels import (
+from ..utils.kernels import (
     kernel_cubic,
     kernel_gradient_cubic,
     kernel_gradient_quintic,