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

.. oe:namespace:: OEMolSmirnoff



.. _OEMolSmirnoff_OESmirnoffStretchData:

.. oe:class:: OESmirnoffStretchData


   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OESmirnoffStretchData : public OEMolSmirnoff::OESmirnoffData

   The OESmirnoffStretchData class provides the ability to add new parameters and modify existing
   bond stretching parameters in the SMIRNOFF force field that has the functional
   form: :math:`V_b = k_b(r - r_0)^2` (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:`GetEquilibriumBondLength<OEMolSmirnoff::OESmirnoffStretchData::GetEquilibriumBondLength>`
    * :oe:meth:`GetEneConst<OEMolSmirnoff::OESmirnoffStretchData::GetEneConst>`
    * :oe:meth:`SetParams<OEMolSmirnoff::OESmirnoffStretchData::SetParams>`

   .. oe:method:: Constructors

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

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

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

      .. oe:api::

         OESmirnoffStretchData& operator=(const OESmirnoffStretchData&)

      Assignment operator.

   .. oe:method:: GetEquilibriumBondLength

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

         .. oe:api::

            double GetEquilibriumBondLength() const

      .. oe:language:: python

         .. oe:api:: python

            GetEquilibriumBondLength() -> float

      Returns the equilibrium bond length (:math:`r_0`) in Angstrom associated with the parameter

   .. 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:`k_b`) :math:`{kcal/mol/Angstrom^{2}}` associated with the parameter

   .. oe:method:: SetParams

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

         .. oe:api::

            bool SetParams(const double eneConst, const double bondLength)

      .. oe:language:: python

         .. oe:api:: python

            SetParams(eneConst: float, bondLength: float) -> bool

      Sets equilibrium bond length and energy constant for the the parameter

