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

.. oe:namespace:: OESz

.. meta::
   :keywords: OETorConstraintOptOptions


.. _OESz_OETorConstraintOptOptions:

.. oe:class:: OETorConstraintOptOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OETorConstraintOptOptions

   This class provides an interface to modify the options for an all-torsion-constrained optimization of a ligand molecule.

   .. seealso::

      * :ref:`OELigandOptOptions <OESz_OELigandOptOptions>` class

   The :ref:`OETorConstraintOptOptions <OESz_OETorConstraintOptOptions>` class inherits the following methods from the :ref:`OELigandOptOptions <OESz_OELigandOptOptions>` class.
    * :oe:meth:`GetForceField<OESz::OELigandOptOptions::GetForceField>`
    * :oe:meth:`GetForceFieldType<OESz::OELigandOptOptions::GetForceFieldType>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandOptOptions::GetLigandCharge>`
    * :oe:meth:`GetLigandChargeType<OESz::OELigandOptOptions::GetLigandChargeType>`
    * :oe:meth:`GetNonBondCutoff<OESz::OELigandOptOptions::GetNonBondCutoff>`
    * :oe:meth:`GetGradTolerance<OESz::OELigandOptOptions::GetGradTolerance>`
    * :oe:meth:`GetMaxIter<OESz::OELigandOptOptions::GetMaxIter>`
    * :oe:meth:`GetSolventModel<OESz::OELigandOptOptions::GetSolventModel>`
    * :oe:meth:`SetForceField<OESz::OELigandOptOptions::SetForceField>`
    * :oe:meth:`SetLigandCharge<OESz::OELigandOptOptions::SetLigandCharge>`
    * :oe:meth:`SetNonBondCutoff<OESz::OELigandOptOptions::SetNonBondCutoff>`
    * :oe:meth:`SetGradTolerance<OESz::OELigandOptOptions::SetGradTolerance>`
    * :oe:meth:`SetMaxIter<OESz::OELigandOptOptions::SetMaxIter>`
    * :oe:meth:`SetSolventModel<OESz::OELigandOptOptions::SetSolventModel>`

   The :ref:`OETorConstraintOptOptions <OESz_OETorConstraintOptOptions>` class defines the following public methods:
    * :oe:meth:`GetPenaltyForceConstant<OESz::OETorConstraintOptOptions::GetPenaltyForceConstant>`
    * :oe:meth:`GetUseInternalCoord<OESz::OETorConstraintOptOptions::GetUseInternalCoord>`
    * :oe:meth:`SetPenaltyForceConstant<OESz::OETorConstraintOptOptions::SetPenaltyForceConstant>`
    * :oe:meth:`SetUseInternalCoord<OESz::OETorConstraintOptOptions::SetUseInternalCoord>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OETorConstraintOptOptions()
            OETorConstraintOptOptions(const OETorConstraintOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OETorConstraintOptOptions() -> OETorConstraintOptOptions
            OETorConstraintOptOptions(arg2: OETorConstraintOptOptions) -> OETorConstraintOptOptions

      Default and copy constructors.


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

      .. oe:api::

         OETorConstraintOptOptions& operator=(const OETorConstraintOptOptions&)


.. _OESz_OETorConstraintOptOptions_GetPenaltyForceConstant:

      Assignment operator.


   .. oe:method:: GetPenaltyForceConstant

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

         .. oe:api::

            double GetPenaltyForceConstant() const

      .. oe:language:: python

         .. oe:api:: python

            GetPenaltyForceConstant() -> float

      See :ref:`SetPenaltyForceConstant <OESz_OETorConstraintOptOptions_SetPenaltyForceConstant>` method.


.. _OESz_OETorConstraintOptOptions_GetUseInternalCoord:

   .. oe:method:: GetUseInternalCoord

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

         .. oe:api::

            bool GetUseInternalCoord() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseInternalCoord() -> bool

      See :ref:`SetUseInternalCoord <OESz_OETorConstraintOptOptions_SetUseInternalCoord>` method.


.. _OESz_OETorConstraintOptOptions_SetPenaltyForceConstant:

   .. oe:method:: SetPenaltyForceConstant

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

         .. oe:api::

            bool SetPenaltyForceConstant(double pfc)

      .. oe:language:: python

         .. oe:api:: python

            SetPenaltyForceConstant(value: float) -> bool

      Overwrites the default value (``1e4``) for force constant in dihedral angle constraint
      used for optimization.  Method returns ``false`` if invalid value of force
      constant is passed.


.. _OESz_OETorConstraintOptOptions_SetUseInternalCoord:

   .. oe:method:: SetUseInternalCoord

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

         .. oe:api::

            bool SetUseInternalCoord(bool useInt)

      .. oe:language:: python

         .. oe:api:: python

            SetUseInternalCoord(value: bool) -> bool

      When the parameter ``useInt`` is set to ``true``, optimization is performed in internal coordinates.
      Overwrites a default method for torsion constraint, which  applies a large enough penalty force
      to keep the value of the dihedral angle constant during optimization.
