.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEOmegaOptions, OmegaOptions


.. _OEConfGen_OEOmegaOptions:

.. oe:class:: OEOmegaOptions

   .. oe:api::

      class OEOmegaOptions : public OESystem::OEOptions

   .. seealso::

      * :ref:`OEOmega <OEConfGen_OEOmega>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_simple_omega` example
      * :ref:`section_examples_dens_omega` example
      * :ref:`section_examples_stereo_and_torsion` example

   There is a :ref:`list of suboption default values <OEConfGen_OEOmegaOptions_Defaults>` later in this section.

   The :ref:`OEOmegaOptions <OEConfGen_OEOmegaOptions>` class defines the following public methods:

    * :oe:meth:`GetConfFixOptions<OEConfGen::OEOmegaOptions::GetConfFixOptions>` and
      :oe:meth:`SetConfFixOptions<OEConfGen::OEOmegaOptions::SetConfFixOptions>`
    * :oe:meth:`GetEnergyWindow<OEConfGen::OEOmegaOptions::GetEnergyWindow>` and
      :oe:meth:`SetEnergyWindow<OEConfGen::OEOmegaOptions::SetEnergyWindow>`
    * :oe:meth:`GetIncludeInput<OEConfGen::OEOmegaOptions::GetIncludeInput>` and
      :oe:meth:`SetIncludeInput<OEConfGen::OEOmegaOptions::SetIncludeInput>`
    * :oe:meth:`GetMaxConfs<OEConfGen::OEOmegaOptions::GetMaxConfs>` and
      :oe:meth:`SetMaxConfs<OEConfGen::OEOmegaOptions::SetMaxConfs>`
    * :oe:meth:`GetMolBuilderOptions<OEConfGen::OEOmegaOptions::GetMolBuilderOptions>` and
      :oe:meth:`SetMolBuilderOptions<OEConfGen::OEOmegaOptions::SetMolBuilderOptions>`
    * :oe:meth:`GetSliceEnsembleOptions<OEConfGen::OEOmegaOptions::GetSliceEnsembleOptions>` and
      :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OEOmegaOptions::SetSliceEnsembleOptions>`
    * :oe:meth:`GetStrictStereo<OEConfGen::OEOmegaOptions::GetStrictStereo>` and
      :oe:meth:`SetStrictStereo<OEConfGen::OEOmegaOptions::SetStrictStereo>`
    * :oe:meth:`GetTorDriveOptions<OEConfGen::OEOmegaOptions::GetTorDriveOptions>` and
      :oe:meth:`SetTorDriveOptions<OEConfGen::OEOmegaOptions::SetTorDriveOptions>`
    * :oe:meth:`GetTorsionDrive<OEConfGen::OEOmegaOptions::GetTorsionDrive>` and
      :oe:meth:`SetTorsionDrive<OEConfGen::OEOmegaOptions::SetTorsionDrive>`
    * :oe:meth:`GetWarts<OEConfGen::OEOmegaOptions::GetWarts>` and
      :oe:meth:`SetWarts<OEConfGen::OEOmegaOptions::SetWarts>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEOmegaOptions(const unsigned int sampling = OEOmegaSampling::Classic)
            OEOmegaOptions(const OEOmegaOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEOmegaOptions(type: int) -> OEOmegaOptions
            OEOmegaOptions(arg2: OEOmegaOptions) -> OEOmegaOptions

      Default and copy constructors.

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

      .. oe:api::

         OEOmegaOptions &operator=(const OEOmegaOptions &)

      Assignment operator.

   .. oe:method:: GetConfFixOptions

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

         .. oe:api::

            OEConfFixOptions& GetConfFixOptions()
            const OEConfFixOptions& GetConfFixOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfFixOptions() -> OEConfFixOptions

      See the :oe:meth:`SetConfFixOptions<OEConfGen::OEOmegaOptions::SetConfFixOptions>` method.

   .. oe:method:: GetEnergyWindow

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

         .. oe:api::

            double GetEnergyWindow() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyWindow() -> float

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OEOmegaOptions::SetEnergyWindow>` method.

   .. oe:method:: GetIncludeInput

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

         .. oe:api::

            bool GetIncludeInput() const

      .. oe:language:: python

         .. oe:api:: python

            GetIncludeInput() -> bool

      See the :oe:meth:`SetIncludeInput<OEConfGen::OEOmegaOptions::SetIncludeInput>` method.

   .. oe:method:: GetMaxConfs

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

         .. oe:api::

            unsigned GetMaxConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfs() -> int

      See the :oe:meth:`SetMaxConfs<OEConfGen::OEOmegaOptions::SetMaxConfs>` method.

   .. oe:method:: GetMolBuilderOptions

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

         .. oe:api::

            OEMolBuilderOptions& GetMolBuilderOptions()
            const OEMolBuilderOptions& GetMolBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolBuilderOptions() -> OEMolBuilderOptions

      See the :oe:meth:`SetMolBuilderOptions<OEConfGen::OEOmegaOptions::SetMolBuilderOptions>` method.

   .. oe:method:: GetSliceEnsembleOptions

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

         .. oe:api::

            OESliceEnsembleOptions& GetSliceEnsembleOptions()
            const OESliceEnsembleOptions& GetSliceEnsembleOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSliceEnsembleOptions() -> OESliceEnsembleOptions

      See the :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OEOmegaOptions::SetSliceEnsembleOptions>` method.

   .. oe:method:: GetStrictStereo

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

         .. oe:api::

            bool GetStrictStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictStereo() -> bool

      See the :oe:meth:`SetStrictStereo<OEConfGen::OEOmegaOptions::SetStrictStereo>` method.

   .. oe:method:: GetTorDriveOptions

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

         .. oe:api::

            OETorDriveOptions& GetTorDriveOptions()
            const OETorDriveOptions& GetTorDriveOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorDriveOptions() -> OETorDriveOptions

      See the :oe:meth:`SetTorDriveOptions<OEConfGen::OEOmegaOptions::SetTorDriveOptions>` method.

   .. oe:method:: GetTorsionDrive

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

         .. oe:api::

            bool GetTorsionDrive() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorsionDrive() -> bool

      See the :oe:meth:`SetTorsionDrive<OEConfGen::OEOmegaOptions::SetTorsionDrive>` method.

   .. oe:method:: GetWarts

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

         .. oe:api::

            bool GetWarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarts() -> bool

      See the :oe:meth:`SetWarts<OEConfGen::OEOmegaOptions::SetWarts>` method.

   .. oe:method:: SetConfFixOptions

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

         .. oe:api::

            void SetConfFixOptions(const OEConfFixOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetConfFixOptions(opts: OEConfFixOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEConfFixOptions>` related to partially fixing conformers.

      .. seealso::

         * :ref:`OEConfFixOptions <OEConfGen_OEConfFixOptions>` class

   .. oe:method:: SetEnergyWindow

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

         .. oe:api::

            bool SetEnergyWindow(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetEnergyWindow(value: float) -> bool

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OESliceEnsembleOptions::SetEnergyWindow>` method.
      Default: 10

   .. oe:method:: SetIncludeInput

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

         .. oe:api::

            bool SetIncludeInput(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIncludeInput(value: bool) -> bool

      Sets whether to pass the unmodified input structure into output conformer ensembles.
      If *true*, the input conformers are appended at the beginning of the generated conformer ensemble.
      Default: False

   .. oe:method:: SetMaxConfs

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

         .. oe:api::

            bool SetMaxConfs(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfs(value: int) -> bool

      See the :oe:meth:`SetMaxConfs<OEConfGen::OESliceEnsembleOptions::SetMaxConfs>` method.
      Default: 200

   .. oe:method:: SetMolBuilderOptions

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

         .. oe:api::

            void SetMolBuilderOptions(const OEMolBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetMolBuilderOptions(opts: OEMolBuilderOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEMolBuilderOptions>` related to generating initial conformers.

      .. seealso::

         * :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` class

   .. oe:method:: SetSliceEnsembleOptions

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

         .. oe:api::

            void SetSliceEnsembleOptions(const OESliceEnsembleOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSliceEnsembleOptions(opts: OESliceEnsembleOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OESliceEnsembleOptions>` related to deduplicating generated ensembles.

      .. seealso::

         * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class

   .. oe:method:: SetStrictStereo

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

         .. oe:api::

            bool SetStrictStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictStereo(value: bool) -> bool

      Sets whether conformer generation should fail if **stereo is not specified** on the input molecules.
      Default: True

   .. oe:method:: SetTorDriveOptions

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

         .. oe:api::

            void SetTorDriveOptions(const OETorDriveOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetTorDriveOptions(opts: OETorDriveOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OETorDriveOptions>` related to torsion driving for conformer generation.

      .. seealso::

         * :ref:`OETorDriveOptions <OEConfGen_OETorDriveOptions>` class

   .. oe:method:: SetTorsionDrive

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

         .. oe:api::

            bool SetTorsionDrive(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetTorsionDrive(value: bool) -> bool

      Sets whether to perform torsion driving. Default: True

   .. oe:method:: SetWarts

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

         .. oe:api::

            bool SetWarts(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetWarts(value: bool) -> bool

      Sets whether to generate unique titles for conformers. Default: False


.. _OEConfGen_OEOmegaOptions_Defaults:

..  oe:class:: Suboption Parameter Defaults

     Default values of the parameters from the suboption classes are compiled below.

     =======================================================================================   =============================================================
     parameter                                                                                 Default
     ---------------------------------------------------------------------------------------   -------------------------------------------------------------
     :oe:meth:`CanonOrder<OEConfGen::OEMolBuilderOptions::SetCanonOrder>`                      True

     :oe:meth:`EnumNitrogen<OEConfGen::OEMolBuilderOptions::SetEnumNitrogen>`                  :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified`

     :oe:meth:`EnumRing<OEConfGen::OEMolBuilderOptions::SetEnumRing>`                          True

     :oe:meth:`FromCT<OEConfGen::OEMolBuilderOptions::SetFromCT>`                              True

     :oe:meth:`IgnoreStereo<OEConfGen::OEMolBuilderOptions::SetIgnoreStereo>`                  False

     :oe:meth:`MaxEnumConfs<OEConfGen::OEMolBuilderOptions::SetMaxEnumConfs>`                  1024

     :oe:meth:`SampleHydrogens<OEConfGen::OEMolBuilderOptions::SetSampleHydrogens>`            False

     :oe:meth:`StrictAtomTypes<OEConfGen::OEMolBuilderOptions::SetStrictAtomTypes>`            True

     :oe:meth:`MaxTerminalHeavy<OEConfGen::OESliceEnsembleOptions::SetMaxTerminalHeavy>`       0

     :oe:meth:`RangeIncrement<OEConfGen::OESliceEnsembleOptions::SetRangeIncrement>`           5

     :oe:meth:`RMSThreshold<OEConfGen::OESliceEnsembleOptions::SetRMSThreshold>`               0.5

     :oe:meth:`CommentEnergy<OEConfGen::OETorDriveOptions::SetCommentEnergy>`                  False

     :oe:meth:`ForceField<OEConfGen::OETorDriveOptions::SetForceField>`                        :oe:const:`OEFF::OEMMFFSheffieldFFType::MMFF94Smod_NOESTAT`

     :oe:meth:`MaxRotors<OEConfGen::OETorDriveOptions::SetMaxRotors>`                          9999

     :oe:meth:`MaxSearchTime<OEConfGen::OETorDriveOptions::SetMaxSearchTime>`                  120.0 sec

     :oe:meth:`RotorOffset<OEConfGen::OETorDriveOptions::SetRotorOffset>`                      False

     :oe:meth:`SDEnergy<OEConfGen::OETorDriveOptions::SetSDEnergy>`                            False

     :oe:meth:`UseGPU<OEConfGen::OETorDriveOptions::SetUseGPU>`                                True
     =======================================================================================   =============================================================
