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

.. oe:namespace:: OEMolSmirnoff



.. _OEMolSmirnoff_OESmirnoff:

.. oe:class:: OESmirnoff

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OESmirnoff : public OEMolPotential::OEGenericFF2

   The :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>` class facilitates creation of an instance of SMIRNOFF
   force field (see :ref:`section_smirnoff`). In addition, a force field instance can be extended
   by adding externally defined potential functions.

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

            OESmirnoff(const OESmirnoffParams& params,
                       const OEMolPotential::OENonBondIntcsOptions& opts = OEMolPotential::OENonBondIntcsOptions())
            OESmirnoff(const OESmirnoff&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoff(rcut_vdw: float = 0.0) -> OESmirnoff
            OESmirnoff(params: OESmirnoffParams,
                       opts: OENonBondIntcsOptions = OENonBondIntcsOptions()) -> OESmirnoff
            OESmirnoff(arg2: OESmirnoff) -> OESmirnoff

      Default and copy constructors.

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

      .. oe:api::

         OESmirnoff& operator=(const OESmirnoff&)

      The assignment operator.

      Assignment operator.

