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

.. oe:namespace:: OEMolMMFF



.. meta::
   :keywords: OEMMFF, MMFF


.. _OEMolMMFF_OEMMFF:

.. oe:class:: OEMMFF

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEMMFF : public OEMolPotential::OEGenericFF2

   The :ref:`OEMMFF <OEMolMMFF_OEMMFF>` class facilitates creation of an instance of a partial or
   full MMFF94 or MMFF94s force field. In addition, a force field instance can be extended by 
   adding externally defined potential functions.

   .. _figure_OEMMFF_Hierarchy:

   .. figure:: ../images/OEMMFF.*
      :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:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::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:`GetTitle<OEMolPotential::OEForceField::GetTitle>` and
      :oe:meth:`SetTitle<OEMolPotential::OEForceField::SetTitle>`
    * :oe:meth:`HasCoulomb<OEMolPotential::OEForceField::HasCoulomb>`
    * :oe:meth:`HasInternalCharges<OEMolPotential::OEForceField::HasInternalCharges>`
    * :oe:meth:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEForceField::SetNonBondCutoff>`

   The following methods are publicly inherited from :ref:`OEGenericFF2 <OEMolPotential_OEGenericFF2>`:
    * :oe:meth:`AddMolFunc<OEMolPotential::OEGenericFF2::AddMolFunc>`
    * :oe:meth:`GetComponents<OEMolPotential::OEGenericFF2::GetComponents>`
    * :oe:meth:`RemoveMolFunc<OEMolPotential::OEGenericFF2::RemoveMolFunc>`
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEMMFF(const OEMMFFParams& params,
                   const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OEMMFF(const OEMMFF&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFF(params: OEMMFFParams,
                   opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OEMMFF
            OEMMFF(arg2: OEMMFF) -> OEMMFF
            OEMMFF(mmff94s: bool = False, terms: int) -> OEMMFF

      Default and copy constructors.

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

      .. oe:api::

         OEMMFF& operator=(const OEMMFF&)

      The assignment operator.

      Assignment operator.

