.. oe:namespace:: OEProton

.. meta::
   :keywords: ChargeEngine

.. include:: ../../toolkit-substitutions


.. _OEProton_OESpreadMetalCharges:

.. oe:class:: OESpreadMetalCharges

   .. oe:api::


      class OESpreadMetalCharges : public OEChargeEngineBase

   Charge engine derived from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`
   that spreads partial charges from a metal to its chelation bonding parters.

   The following methods are publicly inherited from :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`:

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`GetRepairRequestedHint<OEProton::OEChargeEngineBase::GetRepairRequestedHint>` :oe:meth:`TransferCharge<OEProton::OEChargeEngineBase::TransferCharge>`
   :oe:meth:`CheckCharges<OEProton::OEChargeEngineBase::CheckCharges>`                     :oe:meth:`GetRequirements<OEProton::OEChargeEngineBase::GetRequirements>`
   :oe:meth:`CreateCopy<OEProton::OEChargeEngineBase::CreateCopy>`                         :oe:meth:`IsValid<OEProton::OEChargeEngineBase::IsValid>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESpreadMetalCharges(double chargeAliquot = 0.25,
                                 double radiusMargin = 0.25,
                                 double maxNbrDist = 6.0)

      .. oe:language:: python

         .. oe:api:: python

            OESpreadMetalCharges(chargeAliquot: float = 0.25,
                                 radiusMargin: float = 0.25,
                                 maxNbrDist: float = 6.0) -> OESpreadMetalCharges

      Constructor with input arguments of the incremental amount of charge that should be spread from the metal to each chelating atom (`chargeAliquot`), the distance beyond the radial-radial distance from which the nearest neighbors cutoff is defined (`radiusMargin`), and the maximum distance separating the metal and the chelating atoms (`maxNbrDist`). Parameters also have getter and setter methods.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEChargeEngineBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEChargeEngineBase

      Creates a copy of the charge engine class. This class does not own the returned memory.

   .. oe:method:: GetChargeAliquot

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetChargeAliquot() const

      .. oe:language:: python

         .. oe:api:: python

            GetChargeAliquot() -> float

      Returns the amount of the charge that will be removed from the metal per chelating atom.

   .. oe:method:: GetMaxNbrDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMaxNbrDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNbrDist() -> float

      Returns the maximum nearest neighbors distance (minus the `radiusMargin`) from the metal to the chelating atoms.

   .. oe:method:: GetRadiusMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetRadiusMargin() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadiusMargin() -> float

      Returns the extra marginal amount of distance such that two atoms can be considered chelators of each other.

   .. oe:method:: SetChargeAliquot

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetChargeAliquot(double aliquot)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeAliquot(aliquot: float) -> None

      Sets the amount of charge that should be spread from the metal to each  chelating atom.

   .. oe:method:: SetMaxNbrDist

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMaxNbrDist(double distance)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNbrDist(distance: float) -> None

      Sets the maximum nearest neighbors distance (minus the `radiusMargin`) from the metal to the chelating atoms.

   .. oe:method:: SetRadiusMargin

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetRadiusMargin(double distance)

      .. oe:language:: python

         .. oe:api:: python

            SetRadiusMargin(distance: float) -> None

      Sets the extra marginal amount of distance that two atoms can be considered chelators of each other.
