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

.. oe:namespace:: OEFF


.. meta::
   :keywords: OEMMFFSheffield, MMFFSheffield


.. _OEFF_OEMMFFSheffield:

.. oe:class:: OEMMFFSheffield

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEMMFFSheffield : public OEMolPotential::OEGenericFF2

   The :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>` is a hybrid force field that combines the
   :ref:`OEMMFF <OEMolMMFF_OEMMFF>` with the :ref:`OESheffield <OESheff_OESheffield>`. This force field
   is designed to be used exactly as that of :ref:`OEMMFF <OEMolMMFF_OEMMFF>` or a variation
   of it, such as a truncated-OEMMFF, OEMMFF without electrostatics, or :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
   with :ref:`OESheffield <OESheff_OESheffield>`.

   .. _figure_OEMMFFSheffield_Hierarchy:

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

   .. seealso::

     * :ref:`sub-section_MMFF-IEFF` section
     * :ref:`section_mmff` section

   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:`PrepMol<OEMolPotential::OEForceField::PrepMol>`
    * :oe:meth:`Set<OEMolPotential::OEForceField::Set>`

   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::

            OEMMFFSheffield(const OEMMFFSheffieldOptions& argOpts = OEMMFFSheffieldOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFSheffield(argOpts: OEMMFFSheffieldOptions = OEMMFFSheffieldOptions()) -> OEMMFFSheffield
            OEMMFFSheffield(arg2: OEMMFFSheffield) -> OEMMFFSheffield

      Default constructor.

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

         .. oe:api::

            OEMMFFSheffield(const OEMMFFSheffieldOptions& argOpts = OEMMFFSheffieldOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFSheffield(argOpts: OEMMFFSheffieldOptions = OEMMFFSheffieldOptions()) -> OEMMFFSheffield
            OEMMFFSheffield(arg2: OEMMFFSheffield) -> OEMMFFSheffield

      Creates the force field with user specified options.

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

      .. oe:api::

         OEMMFFSheffield & operator=(const OEMMFFSheffield &)

      Assignment operator.



