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

.. oe:namespace:: OEFF



.. meta::
   :keywords: OEMMFFIEFF, MMFFIEFF


.. _OEFF_OEMMFFIEFF:

.. oe:class:: OEMMFFIEFF

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEMMFFIEFF : public OEMolPotential::OEGenericFF

   The :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>` class facilitates creation of an instance of a MMFFIEFF
   force field. The MMFFIEFF hybrid force field uses MMFF for intramolecular interactions and
   Amber for intermolecular interactions. In addition, a force field instance can be extended by 
   adding externally defined potential functions.

   .. _figure_OEMMFFIEFF_Hierarchy:

   .. figure:: ../images/OEMMFFIEFF.*
      :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:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEForceField <OEMolPotential_OEForceField>`:
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>` 
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`

   The following methods are publicly inherited from :ref:`OEGenericFF <OEMolPotential_OEGenericFF>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF::RemoveMolFunc>`

   .. oe:method:: Constructors

      .. oe:api::

         OEMMFFIEFF(const OEChem::OEMolBase& host)
         OEMMFFIEFF(const OEChem::OEMolBase& host,
                    const OEMMFFIEFFOptions& options)

      Default and copy constructors.

   The first constructor creates the force field with default options. The second constructor 
   creates the force field with user specified options. The host refers to the host molecule for the interactions.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMMFFIEFF & operator=(const OEMMFFIEFF &)

      Assignment operator.

   

