src.gridmind.utils.divergence.base_divergence_detector
======================================================

.. py:module:: src.gridmind.utils.divergence.base_divergence_detector


Classes
-------

.. autoapisummary::

   src.gridmind.utils.divergence.base_divergence_detector.BaseDivergenceDetector


Module Contents
---------------

.. py:class:: BaseDivergenceDetector(stop_on_divergence: bool = True)

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: stop_on_divergence
      :value: True



   .. py:method:: detect_divergence(**kwargs)
      :abstractmethod: