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

.. oe:namespace:: OEMolSmirnoff



.. _OEMolSmirnoff_OESmirnoffImproperData:

.. oe:class:: OESmirnoffImproperData


   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OESmirnoffImproperData : public OEMolSmirnoff::OESmirnoffData

   The OESmirnoffImproperData class provides the ability to add new parameters and modify existing
   improper torsion (out-of-plane bending) parameters in the SMIRNOFF force field that has the functional form: :math:`V_o = V(1+\cos{(p \theta - \gamma)})`
   (see :ref:`section_smirnoff`)

   .. seealso::

      * :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class

   The following methods are publicly inherited from :ref:`OESmirnoffData <OEMolSmirnoff_OESmirnoffData>` class:

    * :oe:meth:`GetID<OEMolSmirnoff::OESmirnoffData::GetID>`
    * :oe:meth:`GetSmarts<OEMolSmirnoff::OESmirnoffData::GetSmarts>`

   The class defines the following public methods:

    * :oe:meth:`GetEneConst<OEMolSmirnoff::OESmirnoffImproperData::GetEneConst>`
    * :oe:meth:`GetPhaseAngle<OEMolSmirnoff::OESmirnoffImproperData::GetPhaseAngle>`
    * :oe:meth:`GetPeriodicity<OEMolSmirnoff::OESmirnoffImproperData::GetPeriodicity>`
    * :oe:meth:`SetParams<OEMolSmirnoff::OESmirnoffImproperData::SetParams>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OESmirnoffImproperData()
            OESmirnoffImproperData(const std::string& id,
                                   const std::string& smarts)
            OESmirnoffImproperData(const OESmirnoffImproperData&)

      .. oe:language:: python

         .. oe:api:: python

            OESmirnoffImproperData() -> OESmirnoffImproperData
            OESmirnoffImproperData(id: str, smarts: str) -> OESmirnoffImproperData
            OESmirnoffImproperData(arg2: OESmirnoffImproperData) -> OESmirnoffImproperData

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

      .. oe:api::

         OESmirnoffImproperData& operator=(const OESmirnoffImproperData&)

      Assignment operator.

   .. _OEMolSmirnoff_GetEneConst:

   .. oe:method:: GetEneConst

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

         .. oe:api::

            double GetEneConst() const

      .. oe:language:: python

         .. oe:api:: python

            GetEneConst() -> float

      Returns the energy constant (:math:`{ V_n}`)  in kcal/mol for the term

   .. _OEMolSmirnoff_GetPhaseAngle:

   .. oe:method:: GetPhaseAngle

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

         .. oe:api::

            double GetPhaseAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetPhaseAngle() -> float

      Returns the phase (:math:`{ \gamma_n}`) in degrees for the term

   .. _OEMolSmirnoff_GetPeriodicity:

   .. oe:method:: GetPeriodicity

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

         .. oe:api::

            unsigned GetPeriodicity() const

      .. oe:language:: python

         .. oe:api:: python

            GetPeriodicity() -> int

      Returns the periodicity (:math:`{ p_n}`) of the term

   .. _OEMolSmirnoff_SetParams:

   .. oe:method:: SetParams

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

         .. oe:api::

            bool SetParams(const double eneConst, const double phase,
                           const unsigned periodicity)

      .. oe:language:: python

         .. oe:api:: python

            SetParams(eneConst: float, phase: float, periodicity: int) -> bool

      Sets the energy constant (:math:`{ V_n}`) , phase (:math:`{ \gamma_n}`) and
      periodicity (:math:`{ p_n}`) of the improper torsion parameter.
