.. oe:namespace:: OEProton

.. oe:constnamespace:: OECharges

   This namespace contains constants used by the deprecated function
   :oe:func:`OEAssignPartialCharges<OEProton::OEAssignPartialCharges>` to
   define which charge model to apply. This function is being replaced by
   :oe:func:`OEAssignCharges<OEProton::OEAssignCharges>` which uses an
   object that defines the charge model and any required pre-processing.

   .. seealso:

         * :oe:func:`OEProton::OEAssignCharges` function
         * :oe:func:`OEProton::OEAssignPartialCharges` function
         * :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>` abstract base class

   .. _OEProton_OECharges_AM1:

   .. oe:constant:: AM1

      AM1 Mulliken-type charges. A full AM1 geometry optimization is done.

   .. _OEProton_OECharges_AM1BCC:

   .. oe:constant:: AM1BCC

      AM1 Mulliken-type charges with bond-charge corrections.
      The AM1 optimization is lightly restrained to starting coordinates but no
      partial charge symmetrization is done (same as :oe:const:`OEProton::OECharges::AM1BCCNoSym`).

      .. note::

         Note that this differs from the "standard" *AM1BCC* charging scheme as published,
         where symmetrization is done (same as :oe:const:`OEProton::OECharges::AM1BCCSym`).

   .. _OEProton_OECharges_AM1BCCNoSym:

   .. oe:constant:: AM1BCCNoSym

      AM1 Mulliken-type charges with bond-charge corrections.
      The AM1 optimization is lightly restrained to starting coordinates but no
      partial charge symmetrization is done.

   .. _OEProton_OECharges_AM1BCCNoSymSPt:

   .. oe:constant:: AM1BCCNoSymSPt

      AM1 Mulliken-type charges with bond-charge corrections. Neither AM1 geometry optimization
      nor partial charge symmetrization is done.

   .. _OEProton_OECharges_AM1BCCSPt:

   .. oe:constant:: AM1BCCSPt

      AM1 Mulliken-type charges with bond-charge corrections. Neither AM1 geometry optimization
      nor partial charge symmetrization is done.
      (same as :oe:const:`OEProton::OECharges::AM1BCCNoSymSPt`).

   .. _OEProton_OECharges_AM1BCCSym:

   .. oe:constant:: AM1BCCSym

      AM1 Mulliken-type charges with bond-charge corrections.
      The AM1 optimization is lightly restrained to starting coordinates and
      partial charges are symmetrized with respect to bond-topologically equivalent atoms.

   .. _OEProton_OECharges_AM1BCCSymSPt:

   .. oe:constant:: AM1BCCSymSPt

      AM1 Mulliken-type charges with bond-charge corrections; no AM1 geometry optimization is done.
      Partial charges are symmetrized with respect to bond-topologically equivalent atoms.

   .. _OEProton_OECharges_AM1SPt:

   .. oe:constant:: AM1SPt

      AM1 Mulliken-type charges; no AM1 geometry optimization is done.

   .. _OEProton_OECharges_AmberFF94:

   .. oe:constant:: AmberFF94

      Amber force field 94 charges for standard amino acids.

   .. _OEProton_OECharges_AmberFF99:

   .. oe:constant:: AmberFF99

      Amber force field 99 charges
      (same charges as :oe:const:`OEProton::OECharges::AmberFF94`).

   .. _OEProton_OECharges_AmberFF99SB:

   .. oe:constant:: AmberFF99SB

      Amber force field 99SB charges
      (same charges as :oe:const:`OEProton::OECharges::AmberFF94`).

   .. _OEProton_OECharges_AmberFF99bsc0:

   .. oe:constant:: AmberFF99bsc0

      Amber force field 99bc0 charges
      (same charges as :oe:const:`OEProton::OECharges::AmberFF94`).

   .. _OEProton_OECharges_Default:

   .. oe:constant:: Default

      The current default charges, which are :oe:const:`OEProton::OECharges::MMFF94`.

   .. _OEProton_OECharges_Formal:

   .. oe:constant:: Formal

      Copies the formal charge field of atoms into the partial charge
      field.

   .. _OEProton_OECharges_Gasteiger:

   .. oe:constant:: Gasteiger

      Assigns Gasteiger partial charges.

   .. _OEProton_OECharges_Initial:

   .. oe:constant:: Initial

      Smears unit charges in the partial charge
      field onto resonance shared atoms.

   .. _OEProton_OECharges_MMFF94:

   .. oe:constant:: MMFF94

      Assigns MMFF94 partial charges.

   .. _OEProton_OECharges_Max:

   .. oe:constant:: Max

      Number of charge type constants.

   .. _OEProton_OECharges_NoOp:

   .. oe:constant:: NoOp

      No operation is performed.  This setting is useful for indicating that
      charges originated elsewhere, such as user input, and have not been
      changed.

   .. _OEProton_OECharges_None:

   .. oe:constant:: None

      Remove all partial charges.

   .. _OEProton_OECharges_OPLS:

   .. oe:constant:: OPLS

      OPLS protein dictionary charges.

      .. warning::

         This charging model is deprecated.
         The :oe:func:`OEProton::OEAssignPartialCharges` function will throw a deprecated
         warning message when calling it with this charging model.
