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

.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEMolFunc1, MolFunc1


.. _OEMolPotential_OEMolFunc1:

.. oe:class:: OEMolFunc1

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMolFunc1 : public OEOpt::OEFunc1, public OEMolFunc0

   The :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` is an abstract base class. This
   class defines the interface for stateful functions which operate on
   molecules and conformers, compute a function
   value, and has defined analytical gradients.
   :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` combines :ref:`OEFunc1 <OEOpt_OEFunc1>`
   with :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>` interface.
   Classes derived from :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>` are intended
   for use with optimizers which require gradients but do not require second
   derivatives.

   .. _figure_OEMolFunc1_Hierarchy:

   .. figure:: ../images/OEMolFunc1.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Set<OEMolPotential::OEMolFunc::Set>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following classes derive from this class:   
    * :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`
    * :ref:`OEForceField <OEMolPotential_OEForceField>`
    * :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`
    * :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`
    * :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
    * :ref:`OEMolAdaptor <OEMolPotential_OEMolAdaptor>`
    * :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
    * :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
    * :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
    * :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`
    * :ref:`OENumericMolFunc2 <OEMolPotential_OENumericMolFunc2>`
    * :ref:`OEScaledMolFunc <OEMolPotential_OEScaledMolFunc>`
    * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
    * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
    * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
    * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
    * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
    * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
    * :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`
    * :ref:`OEInterMolFunc2 <OEMolPotential_OEInterMolFunc2>`
    * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
    * :ref:`OEHarmonicPotential <OEConstr_OEHarmonicPotential>`
    * :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
    * :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
    * :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
    * :ref:`OESheffield <OESheff_OESheffield>`
    * :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
    * :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`
    * :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
    * :ref:`OEExactShapeFunc <OEShape_OEExactShapeFunc>`
    * :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`
    * :ref:`OEHermiteShapeFunc <OEShape_OEHermiteShapeFunc>`
    * :ref:`OEGridShapeFunc <OEShape_OEGridShapeFunc>`
    * :ref:`OEColorFunc <OEShape_OEColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`
