.. oe:namespace:: OEBio

..  _oebio_oeplacehydrogensmoverclass:

.. oe:constnamespace:: OEPlaceHydrogensMoverClass

   This namespace contains constants used by the
   :ref:`OEPlaceHydrogensMoverNote <OEBio_OEPlaceHydrogensMoverNote>`
   class to describe each "mover" (movable functional group processed by
   :oe:func:`OEPlaceHydrogens<OEBio::OEPlaceHydrogens>`).


   .. oe:constant:: AmideNO

      Terminal amide group, as in asparagine or glutamine (flippable).

   .. oe:constant:: AroN

      Aromatic nitrogen other than an imidazole,
      deprotonated when coordinating a metal.

   .. oe:constant:: AroCH3

      Aromatic methyl group. Has two rotational states,
      always placing one methyl hydrogen in the ring plane.

   .. oe:constant:: Background

      Collection of non-moving atoms surrounding another mover. For waters,
      other movers are treated as background.

   .. oe:constant:: COOH

      Protonated carboxylic acid (or analog). Hydrogen is rotated and group flipped.

   .. oe:constant:: DH

      Donor with rotatable hydrogen, as in serene, theonine, tyrosine,
      cysteine, or ribose. Rotational states based on interactions with nearby
      hydrogen bond donors and acceptors.

   .. oe:constant:: Imidazole

      Imidazole group, as in histidine (maximum of six states:
      two flip states times three protonation states HD1, HE2,
      and plus (+) charged with both HD1 & HE2). If between two metals,
      can instead be doubly deprotonated with a negative (-) charge.

   .. oe:constant:: Max

      The total number of different mover classes.

   .. oe:constant:: N

      Non-aromatic nitrogen deprotonated when coordinating a metal.

   .. oe:constant:: NHsp2Only

      Secondary amine with a sp2 geometry.

   .. oe:constant:: NHsp3Only

      Secondary amine with a sp3 geometry.

   .. oe:constant:: NHsp2sp3

      Secondary amine with a hybrid sp2/2p3 geometry.

   .. oe:constant:: NH2

      Neutral amine in aniline analog (pyramidal, six H2 orientations).

   .. oe:constant:: NH3

      Ionized primary amine, as in lysine (rotates).

   .. oe:constant:: SCH3

      Methyl attached to a sulfur, as in methionine (low rotational barrier,
      high number of orientations sampled).

   .. oe:constant:: Water

      Water or hydrogen sulfide, a water analog
      (each can have many orientation states). Waters are not included in
      mover clusters to avoid combinatorial explosion, instead they
      are optimized after other movers.

   .. seealso::

      * :ref:`section_place_hydrogens` section
      * :oe:func:`OEBio::OEPlaceHydrogens` function
      * :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` class
      * :ref:`OEPlaceHydrogensMoverNote <OEBio_OEPlaceHydrogensMoverNote>` class
