.. oe:namespace:: OESz


.. meta::
   :keywords: OESzybkiGeneralOptions, SzybkiGeneralOptions


.. _OESz_OESzybkiGeneralOptions:

.. oe:class:: OESzybkiGeneralOptions

   .. oe:api::

      class OESzybkiGeneralOptions : public OESystem::OEOptions

   This class represents general options for szybki.

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESzybkiGeneralOptions()
            OESzybkiGeneralOptions(const OESzybkiGeneralOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiGeneralOptions() -> OESzybkiGeneralOptions
            OESzybkiGeneralOptions(arg2: OESzybkiGeneralOptions) -> OESzybkiGeneralOptions

      Default and copy constructors.

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

      .. oe:api::

         OESzybkiGeneralOptions &operator=(const OESzybkiGeneralOptions &)

      Assignment operator.


   .. oe:method:: GetCalculateGradients

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

         .. oe:api::

            bool GetCalculateGradients() const

      .. oe:language:: python

         .. oe:api:: python

            GetCalculateGradients() -> bool

      Returns the state of the calculate gradients flag. If true, OESzybki will calculate and
      report gradients.

   .. oe:method:: GetForceField

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

         .. oe:api::

            const OEMolPotential::OEForceField* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEForceField

      Returns the pointer to the :ref:`OEForceField <OEMolPotential_OEForceField>` object which was used in the
      method :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceField`. 

   .. oe:method:: GetForceFieldType

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

         .. oe:api::

            unsigned int GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      Returns the force field type to be used for OESzybki calculations, as `unsigned int` 
      from the :oe:constns:`OESz::OEForceFieldType` namespace.

   .. oe:method:: GetIEFFCluster

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

         .. oe:api::

            bool GetIEFFCluster() const

      .. oe:language:: python

         .. oe:api:: python

            GetIEFFCluster() -> bool

      Returns the state of the IEFF cluster flag. If true, OESzybki will optimize a cluster
      of molecules with the MMFF94-IEFF or MMFF94S-IEFF force field.

   .. oe:method:: GetIntramolecularVdWCutoff

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

         .. oe:api::

            double GetIntramolecularVdWCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntramolecularVdWCutoff() -> float

      Returns the value of the intramolecular vdW interactions cutoff. The intramolecular VdW interactions
      are considered to be zero between atoms that are separated by distances larger than the cutoff.

   .. oe:method:: GetLigandRMSDHeavy

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

         .. oe:api::

            bool GetLigandRMSDHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandRMSDHeavy() -> bool

      Returns the state of the Ligand RMSD heavy flag. If true, OESzybki reports RMSD for the
      optimized molecular systems based on heavy atoms only.

   .. oe:method:: GetRemoveAttractiveVdWForces

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

         .. oe:api::

            bool GetRemoveAttractiveVdWForces() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveAttractiveVdWForces() -> bool

      Returns the state of the Remove Attractive VdW Forces terms flag. If true, OESzybki removes the 
      attractive part of the VdW interaction terms from the force field for calculations.

   .. oe:method:: GetRemoveCoulombTerms

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

         .. oe:api::

            bool GetRemoveCoulombTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveCoulombTerms() -> bool

      Returns the state of the Remove Coloumb terms flag. If true, OESzybki removes the Coulomb terms 
      from the force field for calculations.

   .. oe:method:: GetSoluteDielectric

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

         .. oe:api::

            float GetSoluteDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetSoluteDielectric() -> float

      Returns the value of ligand dielectric constant used for the optimization of ligand in
      solution.

   .. oe:method:: GetTemperature

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

         .. oe:api::

            double GetTemperature() const

      .. oe:language:: python

         .. oe:api:: python

            GetTemperature() -> float

      Returns the value of temperature to be used for entropy calculation, in units of kelvins.

   .. oe:method:: GetVerbose

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

         .. oe:api::

            bool GetVerbose() const

      .. oe:language:: python

         .. oe:api:: python

            GetVerbose() -> bool

      Returns the state of the verbose flag. If true, OESzybki is set for reporting optimization 
      progress.

   .. oe:method:: SetCalculateGradients

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

         .. oe:api::

            bool SetCalculateGradients(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCalculateGradients(value: bool) -> bool

      Sets the state of the calculate gradients flag. If ``true`` is passed, OESzybki will calculate and
      report gradients. 

   .. oe:method:: SetForceField

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

         .. oe:api::

            bool SetForceField(const OEMolPotential::OEForceField& value)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: OEForceField) -> bool

      Sets the force field to be used for OESzybki calculations, using an instance of 
      :ref:`OEForceField<OEMolPotential_OEForceField>`. This method provids an alternative
      to setting force field by a predefined type with 
      :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceFieldType`.
      Method returns ``true`` when the setting is successful, ``false`` otherwise.
      
   .. oe:method:: SetForceFieldType

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

         .. oe:api::

            bool SetForceFieldType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetForceFieldType(value: int) -> bool

      Sets the force field to be used for OESzybki calculations, using constants 
      defined in the :oe:constns:`OESz::OEForceFieldType` namespace. This method 
      provids an alternative to setting force field by a force field instance with 
      :oe:meth:`OESz::OESzybkiGeneralOptions::SetForceField`.
      Method returns ``true`` when the setting is successful, ``false`` otherwise.

   .. oe:method:: SetIEFFCluster

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

         .. oe:api::

            bool SetIEFFCluster(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIEFFCluster(value: bool) -> bool

      Sets the state of the IEFF cluster flag. If ``true`` is passed, OESzybki will optimize a cluster
      of molecules with the MMFF94-IEFF or MMFF94S-IEFF force field. 

   .. oe:method:: SetIntramolecularVdWCutoff

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

         .. oe:api::

            bool SetIntramolecularVdWCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetIntramolecularVdWCutoff(value: float) -> bool

      Sets the value of the intramolecular vdW interactions. The intramolecular VdW interactions
      are considered to be zero between atoms that are separated by distances larger than the cutoff.
      By default no cutoff is used.

   .. oe:method:: SetLigandRMSDHeavy

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

         .. oe:api::

            bool SetLigandRMSDHeavy(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandRMSDHeavy(value: bool) -> bool

      Sets the state of the Ligand RMSD heavy flag. If ``true`` is passed, OESzybki reports RMSD for the
      optimized molecular systems based on heavy atoms only.  By default, RMSD is calculated based
      on all atoms.

   .. oe:method:: SetRemoveAttractiveVdWForces

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

         .. oe:api::

            bool SetRemoveAttractiveVdWForces(const bool value)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveAttractiveVdWForces(value: bool) -> bool

      Sets the state of the Remove Attractive VdW Forces terms flag. If true, OESzybki removes the 
      attractive part of the VdW interaction terms from the force field for calculations.

   .. oe:method:: SetRemoveCoulombTerms

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

         .. oe:api::

            bool SetRemoveCoulombTerms(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveCoulombTerms(value: bool) -> bool

      Sets the state of the Remove Coloumb terms flag. If ``true`` is passed, OESzybki removes the Coulomb 
      terms from the force field for calculations.

   .. oe:method:: SetSoluteDielectric

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

         .. oe:api::

            bool SetSoluteDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSoluteDielectric(value: float) -> bool

      Sets the value of ligand dielectric constant used for the optimization of ligand in
      solution.

   .. oe:method:: SetTemperature

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

         .. oe:api::

            bool SetTemperature(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetTemperature(value: float) -> bool

      Returns the value of temperature to be used for entropy calculation, in units of kelvins.
      The default temperature is set to 298.15K.

   .. oe:method:: SetVerbose

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

         .. oe:api::

            bool SetVerbose(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetVerbose(value: bool) -> bool

      Sets the state of the verbose flag. If ``true`` is passed, OESzybki is set for reporting optimization 
      progress.
