.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormConfOptions, FreeFormConfOptions


.. _OESz_OEFreeFormConfOptions:

.. oe:class:: OEFreeFormConfOptions

   .. oe:api::


      class OEFreeFormConfOptions : public OESystem::OEOptions

   This class represents options for setting up FreeFormConf calculations. 
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEFreeFormConfOptions()
            OEFreeFormConfOptions(const OEFreeFormConfOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormConfOptions() -> OEFreeFormConfOptions
            OEFreeFormConfOptions(arg2: OEFreeFormConfOptions) -> OEFreeFormConfOptions

      Default and copy constructors.

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

      .. oe:api::

         OEFreeFormConfOptions& operator=(const OEFreeFormConfOptions&)

      Assignment operator.


   .. oe:method:: GetCorrSolventOptions

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

         .. oe:api::

            OESzybkiSolventOptions& GetCorrSolventOptions()
            const OESzybkiSolventOptions& GetCorrSolventOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetCorrSolventOptions() -> OESzybkiSolventOptions

      Returns a reference to the :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance as currently set for solvent correction. When desired, these
      options are used in applying energetic corrections to the free
      energy calculations.

   .. oe:method:: GetIonicState

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

         .. oe:api::

            unsigned GetIonicState() const

      .. oe:language:: python

         .. oe:api:: python

            GetIonicState() -> int

      Returns the ionic state to be used for OEFreeFormConf calculations, as
      `unsigned int` from the :oe:constns:`OESz::OEFreeFormIonicState`
      namespace.

   .. oe:method:: GetOmegaOptions

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

         .. oe:api::

            OEOmegaOptions& GetOmegaOptions()
            const OEOmegaOptions& GetOmegaOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOmegaOptions() -> OEOmegaOptions

      Returns a reference to the :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>`
      instance as currently set for ensemble generation. When desired,
      these options are used in generating the initial ensemble of conformers.

   .. oe:method:: GetOptimizeOptions

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

         .. oe:api::

            OESzybkiOptOptions& GetOptimizeOptions()
            const OESzybkiOptOptions& GetOptimizeOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizeOptions() -> OESzybkiOptOptions

      Returns a reference to the :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance as currently set for tight optimization. These options are
      used in tight optimization of conformers.

   .. oe:method:: GetPreOptimizeOptions

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

         .. oe:api::

            OESzybkiOptOptions& GetPreOptimizeOptions()
            const OESzybkiOptOptions& GetPreOptimizeOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPreOptimizeOptions() -> OESzybkiOptOptions

      Returns a reference to the :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance as currently set for pre-optimization. These options are used in 
      loose pre-optimization of conformers to pre-screen and reduce the size of
      conformers ensemble.

   .. oe:method:: GetSolventOptions

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

         .. oe:api::

            OESzybkiSolventOptions& GetSolventOptions()
            const OESzybkiSolventOptions& GetSolventOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventOptions() -> OESzybkiSolventOptions

      Returns a reference to the :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance as currently set for solvent. These options are used in
      defining the solvent for conformers minimization and subsequent entropy
      calculation.

   .. oe:method:: GetSzybkiGeneralOptions

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

         .. oe:api::

            OESzybkiGeneralOptions& GetSzybkiGeneralOptions()
            const OESzybkiGeneralOptions& GetSzybkiGeneralOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSzybkiGeneralOptions() -> OESzybkiGeneralOptions

      Returns a reference to the :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>`
      instance as currently set. These options are used in defining general
      environment for all szybki calculations performed from FreeFormConf.

   .. oe:method:: GetUseInputEnsemble

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

         .. oe:api::

            bool GetUseInputEnsemble() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseInputEnsemble() -> bool

      Returns the current state of the use input ensemble flag. If true, the
      input set of ensemble is used as the initial conformers ensemble and no
      new conformers are generated during FreeFormConf calculations.

   .. oe:method:: GetUseSolventCorr

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

         .. oe:api::

            bool GetUseSolventCorr() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseSolventCorr() -> bool

      Returns the current state of the use solvent correction flag. If true,
      energetic correction due to solvent interactions is applied after
      entropy calculation.

.. oe:method:: SetCorrSolventOptions

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

         .. oe:api::

            void SetCorrSolventOptions(const OESzybkiSolventOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetCorrSolventOptions(opts: OESzybkiSolventOptions) -> None

      Sets the correction solvent options by passing in an 
      :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>` instance. When desired, these
      options are used in applying energetic corrections to the free energy
      calculations.
      Default solvent model: :oe:const:`OESz::OESolventModel::PB`,
      default atomic radii type: :oe:const:`OESz::OEAtomicRadii::ZAP9`,
      default charge model: :ref:`OEChargeEngineNoOp <OEProton_OEChargeEngineNoOp>`.

   .. oe:method:: SetIonicState

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

         .. oe:api::

            bool SetIonicState(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetIonicState(value: int) -> bool

      Sets the ionic state to be used for OEFreeFormConf calculations, as
      `unsigned int` from the :oe:constns:`OESz::OEFreeFormIonicState`
      namespace.  The method returns ``false`` when the invalid selection
      is chosen, ``true`` otherwise.
      Default: :oe:const:`OESz::OEFreeFormIonicState::PH74`.

   .. oe:method:: SetOmegaOptions

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

         .. oe:api::

            void SetOmegaOptions(const OEOmegaOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOmegaOptions(opts: OEOmegaOptions) -> None

      Sets the omega options by passing in an
      :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` instance. When desired, these
      options are used in generating the initial ensemble of conformers.
      Default search force field:
      :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94S_SHEFF`,
      default EnergyWindow: 10.0, default IncludeInput: ``false``,
      default MaxRotors: 20.

   .. oe:method:: SetOptimizeOptions

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

         .. oe:api::

            void SetOptimizeOptions(const OESzybkiOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizeOptions(opts: OESzybkiOptOptions) -> None

      Sets the optimization options by passing in an
      :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance. These options are used in tight optimization of conformers.
      Default optimizer type: :oe:const:`OESz::OEOptType::NEWTON`,
      default MaxIter: 1000.

   .. oe:method:: SetPreOptimizeOptions

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

         .. oe:api::

            void SetPreOptimizeOptions(const OESzybkiOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetPreOptimizeOptions(opts: OESzybkiOptOptions) -> None

      Sets the pre-optimization options by passing in an 
      :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>` instance. These options are
      used in loose pre-optimization of conformers to pre-screen 
      and reduce the size of conformers ensemble.
      Default optimizer type: :oe:const:`OESz::OEOptType::BFGS`,
      default MaxIter: 1000, default GradTolerance: 0.005.

   .. oe:method:: SetSolventOptions

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

         .. oe:api::

            void SetSolventOptions(const OESzybkiSolventOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventOptions(opts: OESzybkiSolventOptions) -> None

      Sets the solvent options by passing in an
      :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance. These options are used in defining the
      solvent for conformers minimization and subsequent entropy calculation.
      Default solvent model: :oe:const:`OESz::OESolventModel::Sheffield`,
      default atomic radii type: :oe:const:`OESz::OEAtomicRadii::ZAP9`,
      default charge model: :ref:`OEAM1BCCELF10Charges <OEProton_OEAM1BCCELF10Charges>`.

   .. oe:method:: SetSzybkiGeneralOptions

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

         .. oe:api::

            void SetSzybkiGeneralOptions(const OESzybkiGeneralOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSzybkiGeneralOptions(opts: OESzybkiGeneralOptions) -> None

      Sets the general szybki options by passing in an
      :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>` instance. These options
      are used in defining the general environment for all szybki calculations 
      performed from FreeFormConf. Default force field:
      :oe:const:`OESz::OEForceFieldType::MMFF94S`, 
      default temperature: 298.15K.

   .. oe:method:: SetUseInputEnsemble

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

         .. oe:api::

            bool SetUseInputEnsemble(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseInputEnsemble(value: bool) -> bool

      Sets the current state of the use input ensemble flag. If true, the
      input set of ensemble is used as the initial conformers ensemble and no
      new conformers are generated during FreeFormConf calculations.
      Default: ``false``.

   .. oe:method:: SetUseSolventCorr

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

         .. oe:api::

            bool SetUseSolventCorr(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseSolventCorr(value: bool) -> bool

      Sets the current state of the use solvent correction flag. If true,
      energetic correction due to solvent interactions is applied after
      entropy calculation. Default: ``false``.
