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

.. oe:namespace:: OEMolSmirnoff



.. _OEMolSmirnoff_OESmirnoffParams:

.. oe:class:: OESmirnoffParams


   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OESmirnoffParams : public OEMolPotential::OEFFParams

   The OESmirnoffParams class provides the ability to retrieve
   parameters necessary to perform energy and gradient calculations using the SMIRNOFF
   force field (see :ref:`section_smirnoff`).  By default OESmirnoffParams
   loads the ``Smirnoff99Frost`` force field.

   .. note::

      The inherited methods, :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`,
      :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>` and
      :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`,
      have no meaning in the SMIRNOFF force field and SHOULD NOT be used. When these methods
      are called, they return ``0``, ``none``, and ``false``, respectively.


   The following methods are publicly inherited from :ref:`OEFFParams <OEMolPotential_OEFFParams>`:
    * :oe:meth:`CreateCopy<OEMolPotential::OEFFParams::CreateCopy>`
    * :oe:meth:`GetCoulombParams<OEMolPotential::OEFFParams::GetCoulombParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetAtomTypeIndex<OEMolPotential::OEFFParams::GetAtomTypeIndex>`
    * :oe:meth:`GetEquilibriumAngle<OEMolPotential::OEFFParams::GetEquilibriumAngle>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetAtomTypeName<OEMolPotential::OEFFParams::GetAtomTypeName>`
    * :oe:meth:`GetEquilibriumBondLength<OEMolPotential::OEFFParams::GetEquilibriumBondLength>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`GetVdwRadius<OEMolPotential::OEFFParams::GetVdwRadius>`
    * :oe:meth:`GetContactDistance<OEMolPotential::OEFFParams::GetContactDistance>`
    * :oe:meth:`GetStretchBendParams<OEMolPotential::OEFFParams::GetStretchBendParams>`
    * :oe:meth:`PrepMol<OEMolPotential::OEFFParams::PrepMol>`
    * :oe:meth:`GetVdwParams<OEMolPotential::OEFFParams::GetVdwParams>`
    * :oe:meth:`GetStretchParams<OEMolPotential::OEFFParams::GetStretchParams>`
    * :oe:meth:`GetBendParams<OEMolPotential::OEFFParams::GetBendParams>`
    * :oe:meth:`GetTorsionParams<OEMolPotential::OEFFParams::GetTorsionParams>`
    * :oe:meth:`GetOutOfPlaneParams<OEMolPotential::OEFFParams::GetOutOfPlaneParams>`
    * :oe:meth:`HasVdwParams<OEMolPotential::OEFFParams::HasVdwParams>`
    * :oe:meth:`HasStretchParams<OEMolPotential::OEFFParams::HasStretchParams>`
    * :oe:meth:`HasBendParams<OEMolPotential::OEFFParams::HasBendParams>`
    * :oe:meth:`HasTorsionParams<OEMolPotential::OEFFParams::HasTorsionParams>`
    * :oe:meth:`GetTitle<OEMolPotential::OEFFParams::GetTitle>`

   The :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>` class contains the following methods:
    * :oe:meth:`AddBendData<OEMolSmirnoff::OESmirnoffParams::AddBendData>`
    * :oe:meth:`AddImproperData<OEMolSmirnoff::OESmirnoffParams::AddImproperData>`
    * :oe:meth:`AddStretchData<OEMolSmirnoff::OESmirnoffParams::AddStretchData>`
    * :oe:meth:`AddTorsionData<OEMolSmirnoff::OESmirnoffParams::AddTorsionData>`
    * :oe:meth:`AddVdWData<OEMolSmirnoff::OESmirnoffParams::AddVdWData>`
    * :oe:meth:`GetBendData<OEMolSmirnoff::OESmirnoffParams::GetBendData>`
    * :oe:meth:`GetImproperData<OEMolSmirnoff::OESmirnoffParams::GetImproperData>`
    * :oe:meth:`GetStretchData<OEMolSmirnoff::OESmirnoffParams::GetStretchData>`
    * :oe:meth:`GetTorsionData<OEMolSmirnoff::OESmirnoffParams::GetTorsionData>`
    * :oe:meth:`GetVdWData<OEMolSmirnoff::OESmirnoffParams::GetVdWData>`
    * :oe:meth:`Load<OEMolSmirnoff::OESmirnoffParams::Load>`
    * :oe:meth:`SetBendData<OEMolSmirnoff::OESmirnoffParams::SetBendData>`
    * :oe:meth:`SetImproperData<OEMolSmirnoff::OESmirnoffParams::SetImproperData>`
    * :oe:meth:`SetStretchData<OEMolSmirnoff::OESmirnoffParams::SetStretchData>`
    * :oe:meth:`SetTorsionData<OEMolSmirnoff::OESmirnoffParams::SetTorsionData>`
    * :oe:meth:`SetVdWData<OEMolSmirnoff::OESmirnoffParams::SetVdWData>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OESmirnoffParams()
            OESmirnoffParams(const OESmirnoffParams&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffParams() -> OESmirnoffParams
            OESmirnoffParams(arg2: OESmirnoffParams) -> OESmirnoffParams

      Default and copy constructors.

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

      .. oe:api::

         OESmirnoffParams& operator=(const OESmirnoffParams&)

      The assignment operator.


.. _OEMolSmirnoff_OESmirnoffParams_AddBendData:

      Assignment operator.


   .. oe:method:: AddBendData

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

         .. oe:api::

            bool AddBendData(const OESmirnoffBendData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddBendData(data: OESmirnoffBendData) -> bool

      Adds new bending parameters based on provided :ref:`OESmirnoffBendData <OEMolSmirnoff_OESmirnoffBendData>`.


.. _OEMolSmirnoff_OESmirnoffParams_AddImproperData:

   .. oe:method:: AddImproperData

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

         .. oe:api::

            bool AddImproperData(const OESmirnoffImproperData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddImproperData(data: OESmirnoffImproperData) -> bool

      Adds new improper torsion parameters based on provided :ref:`OESmirnoffImproperData <OEMolSmirnoff_OESmirnoffImproperData>`.


.. _OEMolSmirnoff_OESmirnoffParams_AddStretchData:

   .. oe:method:: AddStretchData

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

         .. oe:api::

            bool AddStretchData(const OESmirnoffStretchData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddStretchData(data: OESmirnoffStretchData) -> bool

      Adds new bond stretching parameters based on provided :ref:`OESmirnoffStretchData <OEMolSmirnoff_OESmirnoffStretchData>`.


.. _OEMolSmirnoff_OESmirnoffParams_AddTorsionData:

   .. oe:method:: AddTorsionData

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

         .. oe:api::

            bool AddTorsionData(const OESmirnoffTorsionData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddTorsionData(data: OESmirnoffTorsionData) -> bool

      Adds new torsion parameters based on provided :ref:`OESmirnoffTorsionData <OEMolSmirnoff_OESmirnoffTorsionData>`.


.. _OEMolSmirnoff_OESmirnoffParams_AddVdWData:

   .. oe:method:: AddVdWData

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

         .. oe:api::

            bool AddVdWData(const OESmirnoffVdWData& data)

      .. oe:language:: python

         .. oe:api:: python

            AddVdWData(data: OESmirnoffVdWData) -> bool

      Adds new Van der Waals parameters based on provided :ref:`OESmirnoffVdWData <OEMolSmirnoff_OESmirnoffVdWData>`.


.. _OEMolSmirnoff_OESmirnoffParams_GetBendData:

   .. oe:method:: GetBendData

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

         .. oe:api::

            const std::vector<OESmirnoffBendData>& GetBendData() const
            bool GetBendData(OESmirnoffBendData& data,
                             const OEChem::OEAtomBase*,
                             const OEChem::OEAtomBase*,
                             const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetBendData() -> SmirnoffBendDataVec
            GetBendData(data: OESmirnoffBendData, arg3: OEAtomBase,
                        arg4: OEAtomBase, arg5: OEAtomBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffBendData <OEMolSmirnoff_OESmirnoffBendData>`
      corresponding to the bending parameters in the forcefield.  The second overload can be used to
      access parameters for the angle specified by the three atoms.


.. _OEMolSmirnoff_OESmirnoffParams_GetImproperData:

   .. oe:method:: GetImproperData

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

         .. oe:api::

            const std::vector<OESmirnoffImproperData>& GetImproperData() const
            bool GetImproperData(OESmirnoffImproperData& data,
                                 const OEChem::OEAtomBase*,
                                 const OEChem::OEAtomBase*,
                                 const OEChem::OEAtomBase*,
                                 const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetImproperData() -> SmirnoffImpDataVec
            GetImproperData(data: OESmirnoffImproperData, arg3: OEAtomBase,
                            arg4: OEAtomBase, arg5: OEAtomBase,
                            arg6: OEAtomBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffImproperData <OEMolSmirnoff_OESmirnoffImproperData>`
      corresponding to the improper torsion parameters in the forcefield.  The second overload can be used to
      access parameters for the plane specified by the four atoms.  The first atom must be the central atom
      of an improper torsion.


.. _OEMolSmirnoff_OESmirnoffParams_GetStretchData:

   .. oe:method:: GetStretchData

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

         .. oe:api::

            const std::vector<OESmirnoffStretchData>& GetStretchData() const
            bool GetStretchData(OESmirnoffStretchData& data,
                                const OEChem::OEBondBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetStretchData() -> SmirnoffStretchDataVec
            GetStretchData(data: OESmirnoffStretchData, arg3: OEBondBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffStretchData <OEMolSmirnoff_OESmirnoffStretchData>`
      corresponding to the bond stretching parameters in the forcefield.  The second overload can be used to
      access parameters for the specified bond.

.. _OEMolSmirnoff_OESmirnoffParams_GetTorsionData:

   .. oe:method:: GetTorsionData

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

         .. oe:api::

            const std::vector<OESmirnoffTorsionData>& GetTorsionData() const
            bool GetTorsionData(OESmirnoffTorsionData& data,
                                const OEChem::OEAtomBase*,
                                const OEChem::OEAtomBase*,
                                const OEChem::OEAtomBase*,
                                const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetTorsionData() -> SmirnoffTorDataVec
            GetTorsionData(data: OESmirnoffTorsionData, arg3: OEAtomBase,
                           arg4: OEAtomBase, arg5: OEAtomBase, arg6: OEAtomBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffTorsionData <OEMolSmirnoff_OESmirnoffTorsionData>`
      corresponding to the torsion parameters in the forcefield.  The second overload can be used to
      access parameters for the torsion specified by the four atoms.


.. _OEMolSmirnoff_OESmirnoffParams_GetVdWData:

   .. oe:method:: GetVdWData

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

         .. oe:api::

            const std::vector<OESmirnoffVdWData>& GetVdWData() const
            bool GetVdWData(OESmirnoffVdWData& data, const OEChem::OEAtomBase*) const

      .. oe:language:: python

         .. oe:api:: python

            GetVdWData() -> SmirnoffVdWDataVec
            GetVdWData(data: OESmirnoffVdWData, arg3: OEAtomBase) -> bool

      The first overload provides all of the :ref:`OESmirnoffVdWData <OEMolSmirnoff_OESmirnoffVdWData>`
      corresponding to the VdW parameters in the forcefield.  The second overload can be used to
      access parameters for the specified atom.


.. _OEMolSmirnoff_OESmirnoffParams_Load:

   .. oe:method:: Load

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

         .. oe:api::

            bool Load(const unsigned int fftype)
            bool Load(const std::string& xml_file_name)
            bool Load(const OEPlatform::oeisstream& ifs)

      .. oe:language:: python

         .. oe:api:: python

            Load(fftype: int) -> bool
            Load(xml_file_name: str) -> bool
            Load(ifs: oeistream) -> bool

      Methods which load force field parameters. The first method is used to load available build-in parameter set,
      defined in the :oe:constns:`OEMolSmirnoff::OESmirnoffType` namespace.
      The second method takes the name of the parameter file in XML format. This file might contain user custom
      parameters. The third method takes a stream object :oe:cls:`OEPlatform::oeisstream` which contains Smirnoff
      parameters. It is a convenience method which might be used in user code when the parameters XML file is 
      converted a stream.


.. _OEMolSmirnoff_OESmirnoffParams_SetBendData:

   .. oe:method:: SetBendData

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

         .. oe:api::

            bool SetBendData(const OESmirnoffBendData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetBendData(data: OESmirnoffBendData) -> bool

      Sets the :ref:`OESmirnoffBendData <OEMolSmirnoff_OESmirnoffBendData>` replacing existing
      parameters with same ID and Smarts.


.. _OEMolSmirnoff_OESmirnoffParams_SetImproperData:

   .. oe:method:: SetImproperData

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

         .. oe:api::

            bool SetImproperData(const OESmirnoffImproperData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetImproperData(data: OESmirnoffImproperData) -> bool

      Sets the :ref:`OESmirnoffImproperData <OEMolSmirnoff_OESmirnoffImproperData>` replacing existing
      parameters with same ID and Smarts.


.. _OEMolSmirnoff_OESmirnoffParams_SetStretchData:

   .. oe:method:: SetStretchData

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

         .. oe:api::

            bool SetStretchData(const OESmirnoffStretchData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetStretchData(data: OESmirnoffStretchData) -> bool

      Sets the :ref:`OESmirnoffStretchData <OEMolSmirnoff_OESmirnoffStretchData>` replacing existing
      parameters with same ID and Smarts.


.. _OEMolSmirnoff_OESmirnoffParams_SetTorsionData:

   .. oe:method:: SetTorsionData

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

         .. oe:api::

            bool SetTorsionData(const OESmirnoffTorsionData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetTorsionData(data: OESmirnoffTorsionData) -> bool

      Sets the :ref:`OESmirnoffTorsionData <OEMolSmirnoff_OESmirnoffTorsionData>` replacing existing
      parameters with same ID and Smarts.


.. _OEMolSmirnoff_OESmirnoffParams_SetVdWData:

   .. oe:method:: SetVdWData

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

         .. oe:api::

            bool SetVdWData(const OESmirnoffVdWData& data)

      .. oe:language:: python

         .. oe:api:: python

            SetVdWData(data: OESmirnoffVdWData) -> bool

      Sets the :ref:`OESmirnoffVdWData <OEMolSmirnoff_OESmirnoffVdWData>` replacing existing
      parameters with same ID and Smarts.
