.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormConf, FreeFormConf


.. _OESz_OEFreeFormConf:

.. oe:class:: OEFreeFormConf

   .. oe:api::


      class OEFreeFormConf

   The :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` class defines high level interface for conformer
   Free Energies calculation. An advanced interface for conformer Free Energies is provided 
   through the derived class :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`. All the methods of
   :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` are also available through the :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`
   class interface.
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEFreeFormConf(const OEFreeFormConfOptions& opts = OEFreeFormConfOptions())
            OEFreeFormConf(const OEFreeFormConf&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormConf(opts: OEFreeFormConfOptions = OEFreeFormConfOptions()) -> OEFreeFormConf
            OEFreeFormConf(arg2: OEFreeFormConf) -> OEFreeFormConf

      Default and copy constructors.

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

      .. oe:api::

         OEFreeFormConf& operator=(const OEFreeFormConf&)

      Assignment operator.


   .. oe:method:: EstimateFreeEnergies

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

         .. oe:api::

            unsigned int EstimateFreeEnergies(OEChem::OEMCMolBase& mol) const
            unsigned int EstimateFreeEnergies(OEChem::OEMCMolBase& mol,
                                              OEChem::OEMCMolBase& restrictedMol) const

      .. oe:language:: python

         .. oe:api:: python

            EstimateFreeEnergies(argMol: OEMol) -> int
            EstimateFreeEnergies(argMol: OEMol, argRctMol: OEMol) -> int

      Estimates the Gibbs free energy to convert an ensemble of solution conformations into a state where only a 
      single specific conformation is present. Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.

      *mol*
         Represents the input molecule to estimate the conformer free energies, and on return it is 
         modified to represent the corresponding ensemble of solution conformers.  The return ensemble also 
         contains the estimated free energy components.

      *restrictedMol*
         The restricted conformers of the molecule for which to estimate the restriction energies.  The
         estimated restriction energies are tagged on conformers on return. 


   .. oe:method:: FindSimilarConfs

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

         .. oe:api::

            unsigned int FindSimilarConfs(OEChem::OEMCMolBase& mol,
                                          const OEChem::OEMCMolBase& ensemble,
                                          const OEChem::OEConfBase& conf,
                                          const OESystem::OEBinaryPredicate<OEChem::OEConfBase, OEChem::OEConfBase>& condition) const

      .. oe:language:: python

         .. oe:api:: python

            FindSimilarConfs(argMol: OEMol, argEnsemble: OEMol,
                             argRefConf: OEConfBase,
                             argCondition: OEBinaryConfPred) -> int

      Find similar conformers to the specified one from the given ensemble of conformers, based
      on `condition` provided. Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace. A failure is returned when no
      matches are found.

      *mol*
         Contains the conformers that are found on return.  The found conformers are added to 
         any existing conformers.

      *ensemble*
         Ensemble of conformers to search from.

      *conf*
         Reference conformer used for searching.

      *condition*
         Functor defining the similarity condition.
         
