.. oe:namespace:: OEProton


.. meta::
   :keywords: OEAM1BCCCharges, AM1BCCCharges, ChargeEngine


.. _OEProton_OEAM1BCCCharges:

.. oe:class:: OEAM1BCCCharges

   .. oe:api::


      class OEAM1BCCCharges : public OEChargeEngineBase

   Charge engine input to :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>`
   to assign AM1 Mulliken-type partial charges with bond-charge corrections.

   The input must be a 3D molecule with a number of atoms no larger than a
   defined maximum. The default is 300 atoms,
   see :oe:meth:`constructors<OEProton::OEAM1BCCCharges::Constructors>`.
   Parameters must be available for each atom and bond type.
   If permissive BCCs are requested, no correction is applied when a BCC
   is missing.

   .. seealso:
      :ref:`chapter_molchargetheory` for an description of AM1BCC


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

   ======================================================================================= ======================================================================================= =======================================================================================
   :oe:meth:`operator!=<OEProton::OEChargeEngineBase::operator!=>`                         :oe:meth:`GetName<OEProton::OEChargeEngineBase::GetName>`                               :oe:meth:`SetRepairRequestedHint<OEProton::OEChargeEngineBase::SetRepairRequestedHint>`
   :oe:meth:`operator==<OEProton::OEChargeEngineBase::operator==>`                         :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:meth:`GetExpectValidMol<OEProton::OEChargeEngineBase::GetExpectValidMol>`           :oe:meth:`SetExpectValidMol<OEProton::OEChargeEngineBase::SetExpectValidMol>`
   ======================================================================================= ======================================================================================= =======================================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAM1BCCCharges(bool optimize = true, bool symmetrize = true,
                            bool permissiveBCCs = false,
                            unsigned maxAtoms = 300)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1BCCCharges(optimize: bool = True, symmetrize: bool = True,
                            permissiveBCCs: bool = False, maxAtoms: int = 300) -> OEAM1BCCCharges

      Constructor. Parameters also have getter and setter methods.

      .. seealso:
         * :oe:meth:`SetOptimize<OEProton::OEAM1BCCCharges::SetOptimize>`
         * :oe:meth:`SetSymmetrize<OEProton::OEAM1BCCCharges::SetSymmetrize>`
         * :oe:meth:`SetPermissiveBCCs<OEProton::OEAM1BCCCharges::SetPermissiveBCCs>`
         * :oe:meth:`SetSizeLimit<OEProton::OEAM1BCCCharges::SetSizeLimit>`

   .. oe:method:: GetOptimize

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

         .. oe:api::

            bool GetOptimize() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimize() -> bool

      Returns ``true`` if the geometry of the input molecule will be optimized
      during charge assignment.

      .. seealso:
         :oe:meth:`SetOptimize<OEProton::OEAM1BCCCharges::SetOptimize>`

   .. oe:method:: GetPermissiveBCCs

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

         .. oe:api::

            bool GetPermissiveBCCs() const

      .. oe:language:: python

         .. oe:api:: python

            GetPermissiveBCCs() -> bool

      Returns ``true`` if a missing BCC will be treated as a correction of zero
      rather than an error.

      .. seealso:
         :oe:meth:`SetPermissiveBCCs<OEProton::OEAM1BCCCharges::SetPermissiveBCCs>`

   .. oe:method:: GetSizeLimit

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

         .. oe:api::

            unsigned GetSizeLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetSizeLimit() -> int

      Returns the maximum number of atoms permitted.

      .. seealso:
         :oe:meth:`SetSizeLimit<OEProton::OEAM1BCCCharges::SetSizeLimit>`

   .. oe:method:: GetSymmetrize

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

         .. oe:api::

            bool GetSymmetrize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSymmetrize() -> bool

      Returns ``true`` if charges will be symmetrized with respect to
      bond-topologically equivalent atoms.

      .. seealso:
         :oe:meth:`SetSymmetrize<OEProton::OEAM1BCCCharges::SetSymmetrize>`

   .. oe:method:: SetOptimize

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

         .. oe:api::

            void SetOptimize(bool optimize = true)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimize(optimize: bool = True) -> None

      Defines whether the geometry of the input molecule will be optimized
      during charge assignment. Optimization is lightly restrained to
      starting coordinates.

   .. oe:method:: SetPermissiveBCCs

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

         .. oe:api::

            void SetPermissiveBCCs(bool permissive = true)

      .. oe:language:: python

         .. oe:api:: python

            SetPermissiveBCCs(permissive: bool = True) -> None

      Defines whether a missing BCC will be treated as a correction of zero
      or as an error.

   .. oe:method:: SetSizeLimit

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

         .. oe:api::

            void SetSizeLimit(unsigned maxAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetSizeLimit(maxAtoms: int) -> None

      Defines the maximum number of atoms permitted in the input molecule.

   .. oe:method:: SetSymmetrize

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

         .. oe:api::

            void SetSymmetrize(bool symmetrize = true)

      .. oe:language:: python

         .. oe:api:: python

            SetSymmetrize(symmetrize: bool = True) -> None

      Defines whether charges on the molecule are symmetrized with respect to
      bond-topologically equivalent atoms.
