.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormConfAdvanced, FreeFormConfAdvanced


.. _OESz_OEFreeFormConfAdvanced:

.. oe:class:: OEFreeFormConfAdvanced

   .. oe:api::


      class OEFreeFormConfAdvanced

   Advanced interface for conformer free-energy calculations, extending
   :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` with additional controls.

   The following methods are publicly inherited from :ref:`OEFreeFormConf <OESz_OEFreeFormConf>`:

   * :oe:meth:`EstimateFreeEnergies<OESz::OEFreeFormConf::EstimateFreeEnergies>`
   * :oe:meth:`FindSimilarConfs<OESz::OEFreeFormConf::FindSimilarConfs>`
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEFreeFormConfAdvanced(const OEFreeFormConfOptions& opts = OEFreeFormConfOptions())
            OEFreeFormConfAdvanced(const OEFreeFormConfAdvanced&)

      .. oe:language:: python

         .. oe:api:: python

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

      Default and copy constructors.

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

      .. oe:api::

         OEFreeFormConfAdvanced& operator=(const OEFreeFormConfAdvanced&)

      Assignment operator.


   .. oe:method:: EstimateEnergies

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

         .. oe:api::

            unsigned int EstimateEnergies(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            EstimateEnergies(argMol: 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. This method assumes that a duplicate free solution ensemble is
      provided as input. Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace. The molecule conformers
      contain the estimated free energy components on return.

   .. oe:method:: EstimateRestrictionEnergy

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

         .. oe:api::

            unsigned int EstimateRestrictionEnergy(OEChem::OEMCMolBase& freeMol,
                                                   const OEChem::OEMCMolBase& restrictedMol) const

      .. oe:language:: python

         .. oe:api:: python

            EstimateRestrictionEnergy(argFreeMol: OEMol, argRstrMol: OEMol) -> int

      Estimates the restriction energies on the restricted conformers.
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  

      *freeMol*
         Molecule with unrestricted conformers identified from the set of solution ensemble, corresponding 
         to the restricted conformers.  The estimated restriction energies are tagged on conformers on return.

      *restrictedMol*
         Molecule with the restricted conformers for which to estimate the restriction energies.

   .. oe:method:: IdentifyConformer

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

         .. oe:api::

            unsigned int IdentifyConformer(OEChem::OEMCMolBase& mol,
                                           const OEChem::OEMCMolBase& ensemble) const

      .. oe:language:: python

         .. oe:api:: python

            IdentifyConformer(argMol: OEMol, argEnsemble: OEMol) -> int

      Identifies the given conformers from the solution ensemble.
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  

      *mol*
         Molecule with conformers to be identified from the set of solution ensemble.  
         Conformer free energies from identified conformers are tagged on these conformers on return.

      *ensemble*
         Molecule with the solution ensemble with corresponding conformer free energies.

   .. oe:method:: Optimize

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

         .. oe:api::

            unsigned int Optimize(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            Optimize(argMol: OEMol) -> int

      Optimize the molecule conformers using the optimization options. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  The molecule
      conformers contain optimized geometry and are tagged with estimated energies on return.

   .. oe:method:: OptimizeRestraint

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

         .. oe:api::

            unsigned int OptimizeRestraint(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            OptimizeRestraint(argMol: OEMol) -> int

      Perform restraint optimization of the molecule conformers using the optimization options.
      A harmonic restraint is applied to retain the shape of the given conformers. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  The molecule
      conformers contain optimized geometry and are tagged with estimated energies on return.

   .. oe:method:: PreOptimizeEnsemble

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

         .. oe:api::

            unsigned int PreOptimizeEnsemble(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            PreOptimizeEnsemble(argMol: OEMol) -> int

      Optimize the molecule conformers using the pre-optimization options. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  The molecule
      conformers contain optimized geometry and are tagged with estimated energies on return.

   .. oe:method:: PrepareEnsemble

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

         .. oe:api::

            unsigned int PrepareEnsemble(OEChem::OEMCMolBase& mol) const
            unsigned int PrepareEnsemble(OEChem::OEMCMolBase& mol,
                                         OEChem::OEMCMolBase& restrictionMol,
                                         OEChem::OEMCMolBase& freeMol) const

      .. oe:language:: python

         .. oe:api:: python

            PrepareEnsemble(argMol: OEMol) -> int
            PrepareEnsemble(argMol: OEMol, argRstrMol: OEMol, argFreeMol: OEMol) -> int

      
      Generates a comprehensive set of conformer ensemble when desired, using OEOmega. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.  The input molecule
      is filled with the generated ensemble on return.

      Prepares the conformer ensemble for subsequent FreeForm calculations, this includes generation
      of a comprehensive set of conformers using OEOmega as desired, validation
      of the structures and charge assignment.  The second overload is provided for preparing an
      ensemble that would include un-restricted (free) conformers corresponding to a set of given 
      restriction ensemble of conformers. Charges are also assigned on the given restriction ensemble
      of conformers.
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.

      *mol*
         Molecule with the solution ensemble prepared for FreeFormConf calculations.

      *restrictionMol*
         Molecule with the restricted conformers.

      *freeMol*
         Molecule with the un-restricted conformers, corresponding to the restricted conformers.

   .. oe:method:: RemoveDuplicates

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

         .. oe:api::

            unsigned int RemoveDuplicates(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            RemoveDuplicates(argMol: OEMol) -> int

      Removes duplicates from the given ensemble of molecule conformers. 
      Function returns a success or failure code as `unsigned int` 
      from the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.

