.. oe:namespace:: OESz

.. meta::
   :keywords: OEProteinLigandOptOptions, ProteinLigandOptOptions


.. _OESz_OEProteinLigandOptOptions:

.. oe:class:: OEProteinLigandOptOptions

   .. oe:api::

      class OEProteinLigandOptOptions : public OELigandChargeOptions

   This class provides an interface to setup options required for optimization with 
   :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>` and :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>`.

   The following methods are publicly inherited from :ref:`OELigandChargeOptions <OESz_OELigandChargeOptions>`:
    * :oe:meth:`GetGenerateElfConfs<OESz::OELigandChargeOptions::GetGenerateElfConfs>` and
      :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandChargeOptions::GetLigandCharge>`,
      :oe:meth:`GetLigandChargeType<OESz::OELigandChargeOptions::GetLigandChargeType>`, and
      :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>`

   The :ref:`OEProteinLigandOptOptions <OESz_OEProteinLigandOptOptions>` class defines the following public methods:
    * :oe:meth:`GetGradTolerance<OESz::OEProteinLigandOptOptions::GetGradTolerance>` and
      :oe:meth:`SetGradTolerance<OESz::OEProteinLigandOptOptions::SetGradTolerance>`
    * :oe:meth:`GetForceField<OESz::OEProteinLigandOptOptions::GetForceField>` and
      :oe:meth:`SetForceField<OESz::OEProteinLigandOptOptions::SetForceField>`
    * :oe:meth:`GetMaxIter<OESz::OEProteinLigandOptOptions::GetMaxIter>` and
      :oe:meth:`SetMaxIter<OESz::OEProteinLigandOptOptions::SetMaxIter>`
    * :oe:meth:`GetNonBondCutoff<OESz::OEProteinLigandOptOptions::GetNonBondCutoff>` and
      :oe:meth:`SetNonBondCutoff<OESz::OEProteinLigandOptOptions::SetNonBondCutoff>`
    * :oe:meth:`GetOptimizationType<OESz::OEProteinLigandOptOptions::GetOptimizationType>` and
      :oe:meth:`SetOptimizationType<OESz::OEProteinLigandOptOptions::SetOptimizationType>`
    * :oe:meth:`GetSolventModel<OESz::OEProteinLigandOptOptions::GetSolventModel>` and
      :oe:meth:`SetSolventModel<OESz::OEProteinLigandOptOptions::SetSolventModel>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEProteinLigandOptOptions()
            OEProteinLigandOptOptions(const OEProteinLigandOptOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEProteinLigandOptOptions() -> OEProteinLigandOptOptions
            OEProteinLigandOptOptions(arg2: OEProteinLigandOptOptions) -> OEProteinLigandOptOptions

      Default and copy constructors.

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

      .. oe:api::

         OEProteinLigandOptOptions &operator=(const OEProteinLigandOptOptions &)

   ..   _OESz_OEProteinLigandOptOptions_GetGradTolerance:

      Assignment operator.



   .. oe:method:: GetGradTolerance

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

         .. oe:api::

            double GetGradTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetGradTolerance() -> float

      See :oe:meth:`SetGradTolerance<OESz::OEProteinLigandOptOptions::SetGradTolerance>` method.

   ..   _OESz_OEProteinLigandOptOptions_GetForceField:

   .. oe:method:: GetForceField

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

         .. oe:api::

            const OEFF::OEComplexFF* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEComplexFF

      See :oe:meth:`SetForceField<OESz::OEProteinLigandOptOptions::SetForceField>` method.


   ..   _OESz_OEProteinLigandOptOptions_GetMaxIter:

   .. oe:method:: GetMaxIter

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

         .. oe:api::

            unsigned GetMaxIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxIter() -> int

      See :oe:meth:`SetMaxIter<OESz::OEProteinLigandOptOptions::SetMaxIter>` method.


   ..   _OESz_OEProteinLigandOptOptions_GetNonBondCutoff:

   .. oe:method:: GetNonBondCutoff

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

         .. oe:api::

            double GetNonBondCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonBondCutoff() -> float

      See :oe:meth:`SetNonBondCutoff<OESz::OEProteinLigandOptOptions::SetNonBondCutoff>` method.


   ..   _OESz_OEProteinLigandOptOptions_GetOptimizationType:

   .. oe:method:: GetOptimizationType

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

         .. oe:api::

            unsigned GetOptimizationType() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizationType() -> int

      See :oe:meth:`SetOptimizationType<OESz::OEProteinLigandOptOptions::SetOptimizationType>` method.


   ..   _OESz_OEProteinLigandOptOptions_GetSolventModel:

   .. oe:method:: GetSolventModel

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

         .. oe:api::

            unsigned GetSolventModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventModel() -> int

      See :ref:`SetSolventModel <OESz_OEProteinLigandOptOptions_SetSolventModel>` method.


   ..   _OESz_OEProteinLigandOptOptions_SetGradTolerance:

   .. oe:method:: SetGradTolerance

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

         .. oe:api::

            bool SetGradTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGradTolerance(value: float) -> bool

      Sets the **gradient tolerance** for optimization. Default: 1.e-6.

   ..   _OESz_OEProteinLigandOptOptions_SetForceField:

   .. oe:method:: SetForceField

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

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEFF::OEComplexFF&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEComplexFF) -> bool

      Sets the **force field** for optimization.  The first overload takes an `unsigned` 
      from the :oe:constns:`OESz::OEComplexFFType` namespace, and the second overload
      takes corresponding string values. The final overload allows the use of a user-defined
      :ref:`OEComplexFF <OEFF_OEComplexFF>`. Method returns ``false`` when the invalid selection
      is chosen, ``true`` otherwise.
      **Default:** :oe:const:`OESz::OEComplexFFType::FF14SB_SAGE`


   ..   _OESz_OEProteinLigandOptOptions_SetMaxIter:

   .. oe:method:: SetMaxIter

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

         .. oe:api::

            bool SetMaxIter(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxIter(value: int) -> bool

      Sets the **maximum iterations** for optimization. Default: 1000.


   ..   _OESz_OEProteinLigandOptOptions_SetNonBondCutoff:

   .. oe:method:: SetNonBondCutoff

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

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(value: float) -> bool

      Sets the **Non-bonded interactions cutoff** for optimization.
      Setting a value of ``0.0`` or less assumes that all interactions should be
      included without any cutoff.
      Default: 0.0.


   ..   _OESz_OEProteinLigandOptOptions_SetOptimizationType:

   .. oe:method:: SetOptimizationType

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

         .. oe:api::

            bool SetOptimizationType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizationType(value: int) -> bool

      Sets the **type** for optimization. Allowed methods are defined in the
      :oe:constns:`OESz::OEOptimizationType` namespace.
      Default is :oe:const:`OESz::OEOptimizationType::PoseCartesian`.

   ..   _OESz_OEProteinLigandOptOptions_SetSolventModel:

   .. oe:method:: SetSolventModel

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

         .. oe:api::

            bool SetSolventModel(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventModel(value: int) -> bool

      Sets the **solvent model to be used** during optimization. Allowed methods are 
      :oe:const:`OESz::OESolventModel::NoSolv` and :oe:const:`OESz::OESolventModel::Sheffield`, 
      as defined in the :oe:constns:`OESz::OESolventModel` namespace.
      Default is :oe:const:`OESz::OESolventModel::NoSolv`.


