.. oe:namespace:: OESz



.. meta::
   :keywords: OESzybkiEnsembleResults, SzybkiEnsembleResults


.. _OESz_OESzybkiEnsembleResults:

.. oe:class:: OESzybkiEnsembleResults

   .. oe:api::


      class OESzybkiEnsembleResults

   Container for ensemble geometry optimization results.

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESzybkiEnsembleResults()
            OESzybkiEnsembleResults(const OESzybkiEnsembleResults &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiEnsembleResults() -> OESzybkiEnsembleResults
            OESzybkiEnsembleResults(arg2: OESzybkiEnsembleResults) -> OESzybkiEnsembleResults

      Default and copy constructors.

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

      .. oe:api::

         OESzybkiEnsembleResults &operator=(const OESzybkiEnsembleResults &)

      Assignment operator.


   .. oe:method:: NumConfs

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

         .. oe:api::

            unsigned int NumConfs() const

      .. oe:language:: python

         .. oe:api:: python

            NumConfs() -> int

      Returns the number of unique conformations in the ensemble.

   .. oe:method:: GetTemperature

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

         .. oe:api::

            double GetTemperature() const

      .. oe:language:: python

         .. oe:api:: python

            GetTemperature() -> float

      Returns the temperature in K. This is a convenience method returning the
      same information as the method of the same name in the OESzybki class.

   .. oe:method:: GetTotalEntropy

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

         .. oe:api::

            double GetTotalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEntropy() -> float

      Returns the total entropy of the ligand in J/(mol K).   

   .. oe:method:: GetEntropicEnergy

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

         .. oe:api::

            double GetEntropicEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEntropicEnergy() -> float

      Returns the product of total entropy and temperature, :math:`ST` in kcal/mol.

   .. oe:method:: GetChargeType

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

         .. oe:api::

            unsigned int GetChargeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetChargeType() -> int

      Returns the type of atomic partial charges used in entropy estimation.
      The returned type are is either :oe:const:`OEProton::OECharges::AM1BCCNoSymSPt`
      or :oe:const:`OEProton::OECharges::NoOp`.

   .. oe:method:: GetConfigurationalEntropy

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

         .. oe:api::

            double GetConfigurationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfigurationalEntropy() -> float

      Returns the ensemble configurational entropy. For gas-phase ligands that value is 
      the same as the value returned by :oe:meth:`OESz::OESzybkiEnsembleResults::GetTotalEntropy`. 
      For solution ligands the configurational entropy made by translational-vibrational-rotational 
      entropy, and for protein-bound ligands it represents vibrational entropy.

   .. oe:method:: GetEnsembleLigSolvEntropy

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

         .. oe:api::

            double GetEnsembleLigSolvEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnsembleLigSolvEntropy() -> float

      Returns the value of the ensemble solvation entropy for a ligand in solution. The method
      returns zero for gas-phase and protein-bound ligands.

   .. oe:method:: GetEnsembleLigPartialSolvEntropy

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

         .. oe:api::

            double GetEnsembleLigPartialSolvEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnsembleLigPartialSolvEntropy() -> float

      Returns the value of solvation entropy for the protein-bound ligand partially exposed to solvent.

   .. oe:method:: GetEnsembleProtDesolvEntropy

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

         .. oe:api::

            double GetEnsembleProtDesolvEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnsembleProtDesolvEntropy() -> float

      Returns the value of protein desolvation entropy upon ligand binding.

   .. oe:method:: GetResultsForConformations

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

         .. oe:api::

            OESystem::OEIterBase<OESzybkiResults>* GetResultsForConformations() const

      .. oe:language:: python

         .. oe:api:: python

            GetResultsForConformations() -> Iterable[OESzybkiResults]

      Returns the iterator whose elements are :ref:`OESzybkiResults <OESz_OESzybkiResults>` objects for
      the ensemble of conformation members optimized during the entropy estimation. Data only for
      unique conformations are represented in the returned set.   

   .. oe:method:: HasEntropy

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

         .. oe:api::

            bool HasEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            HasEntropy() -> bool

      Returns ``true`` if the :ref:`OESzybkiEnsembleResults <OESz_OESzybkiEnsembleResults>` object contains calculated
      entropy, ``false`` is returned otherwise. 
