.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiOptions, SzybkiOptions


.. _OESz_OESzybkiOptions:

.. oe:class:: OESzybkiOptions

   .. oe:api::


      class OESzybkiOptions : public OESystem::OEOptions

   Configuration options for :ref:`OESzybki <OESz_OESzybki>` optimizations,
   including force field selection, run type, optimizer algorithm, solvation
   model, and entropy method.

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESzybkiOptions()
            OESzybkiOptions(const OESzybkiOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiOptions() -> OESzybkiOptions
            OESzybkiOptions(arg2: OESzybkiOptions) -> OESzybkiOptions

      Default and copy constructors.

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

      .. oe:api::

         OESzybkiOptions &operator=(const OESzybkiOptions &)

      Assignment operator.


   .. oe:method:: GetGeneralOptions

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

         .. oe:api::

            OESzybkiGeneralOptions& GetGeneralOptions()
            const OESzybkiGeneralOptions& GetGeneralOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetGeneralOptions() -> 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.

   .. oe:method:: GetOptOptions

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

         .. oe:api::

            OESzybkiOptOptions& GetOptOptions()
            const OESzybkiOptOptions& GetOptOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptOptions() -> OESzybkiOptOptions

      Returns a reference to the :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance as currently set. These are options related to
      optimization in OESzybki.

   .. oe:method:: GetProteinOptions

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

         .. oe:api::

            OESzybkiProteinOptions& GetProteinOptions()
            const OESzybkiProteinOptions& GetProteinOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinOptions() -> OESzybkiProteinOptions

      Returns a reference to the :ref:`OESzybkiProteinOptions <OESz_OESzybkiProteinOptions>`
      instance as currently set. These are options related to
      proteins in OESzybki.

   .. oe:method:: GetRunType

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

         .. oe:api::

            unsigned int GetRunType() const

      .. oe:language:: python

         .. oe:api:: python

            GetRunType() -> int

      Returns Szybki run type declared in the :ref:`OESzybkiOptions <OESz_OESzybkiOptions>` object.

   .. 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. These are options related to
      solvents in OESzybki.

   .. oe:method:: SetGeneralOptions

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

         .. oe:api::

            void SetGeneralOptions(const OESzybkiGeneralOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetGeneralOptions(opts: OESzybkiGeneralOptions) -> None

      Sets the general szybki options by passing in an :ref:`OESzybkiGeneralOptions <OESz_OESzybkiGeneralOptions>`
      instance. These options are used in defining general environment for all szybki calculations.

   .. oe:method:: SetOptOptions

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

         .. oe:api::

            void SetOptOptions(const OESzybkiOptOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetOptOptions(opts: OESzybkiOptOptions) -> None

      Sets the optimization options by passing in :ref:`OESzybkiOptOptions <OESz_OESzybkiOptOptions>`
      instance. These are options related to optimization in OESzybki.

   .. oe:method:: SetProteinOptions

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

         .. oe:api::

            void SetProteinOptions(const OESzybkiProteinOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinOptions(opts: OESzybkiProteinOptions) -> None

      Sets the protein options by passing in :ref:`OESzybkiProteinOptions <OESz_OESzybkiProteinOptions>`
      instance. These are options related to
      proteins in OESzybki.

   .. oe:method:: SetRunType

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

         .. oe:api::

            bool SetRunType(unsigned int run_type)

      .. oe:language:: python

         .. oe:api:: python

            SetRunType(value: int) -> bool

      Sets requested run ``type``. Returns ``true`` if run was successfully set. Possible input 
      choices are given in the namespace :oe:constns:`OESz::OERunType`.
      Warning: Setting ``run_type`` with :oe:constns:`OESz::OERunType::SolidBodyOpt` implies 
      optimization of a ligand inside rigid protein receptor. An attempt of solid-body
      optimization inside flexible protein receptor 
      (see method :oe:meth:`OESz::OESzybkiProteinOptions::SetProteinFlexibilityType`) will result in a message:
      ``Fatal: Solid-body optimization allowed only for ligand in fixed protein``. 

   .. 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 :ref:`OESzybkiSolventOptions <OESz_OESzybkiSolventOptions>`
      instance. These are options related to
      solvents in OESzybki.

