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

.. oe:namespace:: OEFF



.. _OEFF_OEFF14SBSmirnoffParams:

.. oe:class:: OEFF14SBSmirnoffParams


   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEFF14SBSmirnoffParams : public OEMolPotential::OEFFParams

   The :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>` class provides the ability to retrieve parameters
   necessary to perform energy and gradient calculations using OEFF14SBSmirnoff force field.  
   By default parameters for the ``Smirnoff99Frost`` force field are used to handle nonprotein
   part of the molecular system. 

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

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEFF14SBSmirnoffParams()
            OEFF14SBSmirnoffParams(const OEFF14SBSmirnoffParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEFF14SBSmirnoffParams() -> OEFF14SBSmirnoffParams
            OEFF14SBSmirnoffParams(arg2: OEFF14SBSmirnoffParams) -> OEFF14SBSmirnoffParams

      Default and copy constructors.

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

      .. oe:api::

         OEFF14SBSmirnoffParams& operator=(const OEFF14SBSmirnoffParams&)

      The assignment operator.

      Assignment operator.


   .. oe:method:: Load

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

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

      Methods which load force field parameters for the SMIRNOFF/Parsley part of the potential. 
      First method is used to load available build-in parameter set defined in the
      :oe:constns:`OEMolSmirnoff::OESmirnoffType` namespace.
      Second method takes the name of the parameter file in XML format. This file might contain user custom
      parameters. Third method takes a stream object :ref:`oeisstream <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 to a stream.
