Remove 'Current' observable. (#3973)

Fixes #3679
espressomd · Oct 26, 2020 · 0156f3d · 0156f3d
2 parents fbbddd2 + d95baff
commit 0156f3d
Show file tree

Hide file tree

Showing 5 changed files with 0 additions and 80 deletions.
diff --git a/doc/sphinx/analysis.rst b/doc/sphinx/analysis.rst
@@ -453,8 +453,6 @@ documentation for all available observables in :mod:`espressomd.observables`.
 
 - Observables working on a given set of particles and returning reduced quantities:
 
-   - :class:`~espressomd.observables.Current`: Total current of the system
-
    - :class:`~espressomd.observables.DipoleMoment`: Total electric dipole moment of the system obtained based on unfolded positions
 
    - :class:`~espressomd.observables.MagneticDipoleMoment`: Total magnetic dipole moment of the system based on the :attr:`espressomd.particle_data.ParticleHandle.dip` property.

diff --git a/src/core/observables/Current.hpp b/src/core/observables/Current.hpp
diff --git a/src/python/espressomd/observables.py b/src/python/espressomd/observables.py
@@ -113,26 +113,6 @@ class ComVelocity(Observable):
     _so_name = "Observables::ComVelocity"
 
 
-@script_interface_register
-class Current(Observable):
-
-    """Calculates the electric current for particles with given ids.
-
-    Output format: :math:`\\left(\\sum_i q_i v^x_i, \\sum_i q_i v^y_i, \\sum_i q_i v^z_i, \\right)`
-
-    Parameters
-    ----------
-    ids : array_like of :obj:`int`
-        The ids of (existing) particles to take into account.
-
-    Returns
-    -------
-    (3,) :obj:`ndarray` of :obj:`float`
-
-    """
-    _so_name = "Observables::Current"
-
-
 @script_interface_register
 class DensityProfile(ProfileObservable):
 

diff --git a/src/script_interface/observables/initialize.cpp b/src/script_interface/observables/initialize.cpp
@@ -33,7 +33,6 @@
 #include "core/observables/ComPosition.hpp"
 #include "core/observables/ComVelocity.hpp"
 #include "core/observables/CosPersistenceAngles.hpp"
-#include "core/observables/Current.hpp"
 #include "core/observables/CylindricalDensityProfile.hpp"
 #include "core/observables/CylindricalFluxDensityProfile.hpp"
 #include "core/observables/CylindricalLBFluxDensityProfileAtParticlePositions.hpp"
@@ -127,7 +126,6 @@ void initialize(Utils::Factory<ObjectHandle> *om) {
   REGISTER_PID_OBS(ParticleAngularVelocities);
   REGISTER_PID_OBS(ParticleBodyAngularVelocities);
 #endif
-  REGISTER_PID_OBS(Current);
 #ifdef ELECTROSTATICS
   REGISTER_PID_OBS(DipoleMoment);
 #endif

diff --git a/testsuite/python/observables.py b/testsuite/python/observables.py
@@ -194,16 +194,6 @@ def test_pressure_tensor(self):
             err_msg="Pressure tensor from analysis and observable did not agree",
             decimal=9)
 
-    @utx.skipIfMissingFeatures('ELECTROSTATICS')
-    def test_current(self):
-        obs_data = espressomd.observables.Current(
-            ids=self.system.part[:].id).calculate()
-        part_data = self.system.part[:].q.dot(
-            self.system.part[:].v)
-        self.assertEqual(obs_data.shape, part_data.shape)
-        np.testing.assert_array_almost_equal(
-            obs_data, np.copy(part_data), err_msg="Data did not agree for observable 'Current'", decimal=9)
-
     @utx.skipIfMissingFeatures('ELECTROSTATICS')
     def test_dipolemoment(self):
         obs = espressomd.observables.DipoleMoment(ids=self.system.part[:].id)