.. oe:namespace:: OESz

.. meta::
   :keywords: OELiganEntropyOptions, LiganEntropyOptions


.. _OESz_OELigandEntropyOptions:

.. oe:class:: OELigandEntropyOptions: public OELigandChargeOptions

   .. oe:api::

      class OELigandEntropyOptions : public OESystem::OEOptions

   Used for entropy estimation of free ligands in solution or in vacuum.

   .. seealso::

      * :ref:`OEEntropyResults <OESz_OEEntropyResults>` class
      * :oe:func:`OESz::OELigandEntropy` function

   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:`OELigandEntropyOptions <OESz_OELigandEntropyOptions>` class defines the following public methods:

    * :ref:`GetEnvironment<OESz_OELigandEntropyOptions_GetEnvironment>` and
      :ref:`SetEnvironment<OESz_OELigandEntropyOptions_SetEnvironment>`
    * :ref:`GetForceField<OESz_OELigandEntropyOptions_GetForceField>`,
      :ref:`GetForceFieldType<OESz_OELigandEntropyOptions_GetForceFieldType>` and
      :ref:`SetForceField<OESz_OELigandEntropyOptions_SetForceField>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OELigandEntropyOptions()
            OELigandEntropyOptions(const OELigandEntropyOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OELigandEntropyOptions() -> OELigandEntropyOptions
            OELigandEntropyOptions(arg2: OELigandEntropyOptions) -> OELigandEntropyOptions

      Default and copy constructors.

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

      .. oe:api::

         OELigandEntropyOptions &operator=(const OELigandEntropyOptions &)

      Assignment operator.


   .. _OESz_OELigandEntropyOptions_GetEnvironment:

   .. oe:method:: GetEnvironment

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

         .. oe:api::

            unsigned int GetEnvironment() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnvironment() -> int

      Returns one of 2 types of environement
      :ref:`Gas <OESz_OEEnvType_Gas>`,
      :ref:`Solution <OESz_OEEnvType_Solution>`

   
   .. _OESz_OELigandEntropyOptions_GetForceField:

   .. oe:method:: GetForceField

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

         .. oe:api::

            const OEMolPotential::OEForceField* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      See :ref:`SetForceField<OESz_OELigandEntropyOptions_SetForceField>` method.


   ..   _OESz_OELigandEntropyOptions_GetForceFieldType:

   .. oe:method:: GetForceFieldType

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

         .. oe:api::

            unsigned GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      See :ref:`SetForceField<OESz_OELigandEntropyOptions_SetForceField>` method.


   .. _OESz_OELigandEntropyOptions_SetEnvironment:

   .. oe:method:: SetEnvironment

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

         .. oe:api::

            bool SetEnvironment(unsigned int etype)

      .. oe:language:: python

         .. oe:api:: python

            SetEnvironment(value: int) -> bool

      Selects solution (etype = :oe:constns:`OESz::OEEnvType::Solution`) or gas
      (etype = :oe:constns:`OESz::OEEnvType::Gas`) state.   
      
           
   .. _OESz_OELigandEntropyOptions_SetForceField:

   .. oe:method:: SetForceField

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

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEMolPotential::OEForceField&)

      .. oe:language:: python

         .. oe:api:: python

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

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