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

.. oe:namespace:: OEFF



.. meta::
   :keywords: OEMMFFSheffieldOptions, MMFFSheffieldOptions


.. _OEFF_OEMMFFSheffieldOptions:

.. oe:class:: OEMMFFSheffieldOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEMMFFSheffieldOptions : public OESystem::OEOptions

   This class provides interface to setup options required for :ref:`OEMMFFSheffield <OEFF_OEMMFFSheffield>`
   initialization.
   
   The :ref:`OEMMFFSheffieldOptions <OEFF_OEMMFFSheffieldOptions>` class defines the following public methods:
    * :oe:meth:`GetDielectric<OEFF::OEMMFFSheffieldOptions::GetDielectric>` and
      :oe:meth:`SetDielectric<OEFF::OEMMFFSheffieldOptions::SetDielectric>`
    * :oe:meth:`GetExponent<OEFF::OEMMFFSheffieldOptions::GetExponent>` and
      :oe:meth:`SetExponent<OEFF::OEMMFFSheffieldOptions::SetExponent>`
    * :oe:meth:`GetForceFieldType<OEFF::OEMMFFSheffieldOptions::GetForceFieldType>` and
      :oe:meth:`SetForceFieldType<OEFF::OEMMFFSheffieldOptions::SetForceFieldType>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEMMFFSheffieldOptions()
            OEMMFFSheffieldOptions(const OEMMFFSheffieldOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFSheffieldOptions() -> OEMMFFSheffieldOptions
            OEMMFFSheffieldOptions(arg2: OEMMFFSheffieldOptions) -> OEMMFFSheffieldOptions

      Default and copy constructors.

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

      .. oe:api::

         OEMMFFSheffieldOptions &operator=(const OEMMFFSheffieldOptions &)

      Assignment operator.


   .. oe:method:: GetDielectric

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

         .. oe:api::

            double GetDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectric() -> float

      See :oe:meth:`SetDielectric<OEFF::OEMMFFSheffieldOptions::SetDielectric>` method.

   .. oe:method:: GetExponent

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

         .. oe:api::

            double GetExponent() const

      .. oe:language:: python

         .. oe:api:: python

            GetExponent() -> float

      See :oe:meth:`SetExponent<OEFF::OEMMFFSheffieldOptions::SetExponent>` method.

   .. oe:method:: GetForceFieldType

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

         .. oe:api::

            unsigned int GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      See :oe:meth:`SetForceFieldType<OEFF::OEMMFFSheffieldOptions::SetForceFieldType>` method.

   .. oe:method:: SetDielectric

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

         .. oe:api::

            bool SetDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectric(value: float) -> bool

      The **Dielectric** defines the solvent dielectric constant to be used for
      coulombic interactions with :ref:`OEMMFF <OEMolMMFF_OEMMFF>`.
      **Default: 1.0.**

   .. oe:method:: SetExponent

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

         .. oe:api::

            bool SetExponent(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetExponent(value: float) -> bool

      The **Exponent** defines the coulombic exponent term to be used for
      coulombic interactions with :ref:`OEMMFF <OEMolMMFF_OEMMFF>`.
      **Default: 1.0.**

   .. oe:method:: SetForceFieldType

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

         .. oe:api::

            bool SetForceFieldType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetForceFieldType(value: int) -> bool

      The **ForceFieldType** defines the variation of forcefield to be used. Options 
      are defined in the :oe:constns:`OEFF::OEMMFFSheffieldFFType` namespace.
      **Default:** :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`.
