.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiSolventOptions, SzybkiSolventOptions


.. _OESz_OESzybkiSolventOptions:

.. oe:class:: OESzybkiSolventOptions

   .. oe:api::

      class OESzybkiSolventOptions : public OESystem::OEOptions

   This class represents options related to solvent modeling in szybki.


   .. oe:method:: Constructors

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

         .. oe:api::

            OESzybkiSolventOptions()
            OESzybkiSolventOptions(const OESzybkiSolventOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiSolventOptions() -> OESzybkiSolventOptions
            OESzybkiSolventOptions(argOpts: OESzybkiSolventOptions) -> OESzybkiSolventOptions

      Default and copy constructors.

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

      .. oe:api::

         OESzybkiSolventOptions &operator=(const OESzybkiSolventOptions &)

   .. _OESz_OESzybkiSolventOptions_GetAtomicRadiiType:

      Assignment operator.


   .. oe:method:: GetAtomicRadiiType

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

         .. oe:api::

            unsigned int GetAtomicRadiiType() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicRadiiType() -> int

      Returns the type of atomic radii used for PB calculations, as
      an `unsigned int` from the :oe:constns:`OESz::OEAtomicRadii` namespace.

   .. _OESz_OESzybkiSolventOptions_GetCavitySolventParameter:

   .. oe:method:: GetCavitySolventParameter

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

         .. oe:api::

            double GetCavitySolventParameter() const

      .. oe:language:: python

         .. oe:api:: python

            GetCavitySolventParameter() -> float

      Returns the microscopic surface tension coefficient (in kcal/(mol A**2))
      used in hydrophobic ligand solvation model.

   .. _OESz_OESzybkiSolventOptions_GetSaltConcentration:

   .. oe:method:: GetSaltConcentration

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

         .. oe:api::

            double GetSaltConcentration() const

      .. oe:language:: python

         .. oe:api:: python

            GetSaltConcentration() -> float

      Returns the value of salt concentration in moles/liter (M).

   .. _OESz_OESzybkiSolventOptions_GetSolventDielectric:

   .. oe:method:: GetSolventDielectric

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

         .. oe:api::

            double GetSolventDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventDielectric() -> float

      Returns the value of solvent dielectric constant for the protein-ligand
      system.

   .. _OESz_OESzybkiSolventOptions_GetSolventModel:

   .. oe:method:: GetSolventModel

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

         .. oe:api::

            unsigned int GetSolventModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventModel() -> int

      Returns the type of solvent model used for the calculations
      of solution ligands, as an `unsigned int` from the
      :oe:constns:`OESz::OESolventModel` namespace.

   .. _OESz_OESzybkiSolventOptions_SetAtomicRadiiType:

   .. oe:method:: SetAtomicRadiiType

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

         .. oe:api::

            bool SetAtomicRadiiType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomicRadiiType(value: int) -> bool

      Sets the type of atomic radii to be used for PB calculations, as
      an `unsigned int` from the :oe:constns:`OESz::OEAtomicRadii` namespace.

   .. _OESz_OESzybkiSolventOptions_SetCavitySolventParameter:

   .. oe:method:: SetCavitySolventParameter

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

         .. oe:api::

            bool SetCavitySolventParameter(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetCavitySolventParameter(value: float) -> bool

      Sets the microscopic surface tension coefficient (in kcal/(mol A**2))
      used in hydrophobic ligand solvation model. The default value is set
      to be 0.025 kcal/(mol A**2).  Smaller values usually in the range 0-10
      kcal/(mol A**2) usually reflects a combined hydrophobic
      solvation effect of cavitation and solute-solvent vdW interactions.

   .. _OESz_OESzybkiSolventOptions_SetSaltConcentration:

   .. oe:method:: SetSaltConcentration

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

         .. oe:api::

            bool SetSaltConcentration(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSaltConcentration(value: float) -> bool

      Sets the value of salt concentration in moles/liter (M). By default
      a zero salt concentration is assumed. Values higher than 0.08 should
      not be used and are not supported.

   .. _OESz_OESzybkiSolventOptions_SetSolventDielectric:

   .. oe:method:: SetSolventDielectric

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

         .. oe:api::

            bool SetSolventDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventDielectric(value: float) -> bool

      Sets the value of solvent dielectric constant for the protein-ligand
      systems in PB calculations.  The default value of solvent dielectric
      constant is set to 80.0.

   .. _OESz_OESzybkiSolventOptions_SetSolventModel:

   .. oe:method:: SetSolventModel

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

         .. oe:api::

            bool SetSolventModel(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventModel(value: int) -> bool

      Sets the type of solvent model used for the calculations of
      solution ligands, as an `unsigned int`
      from the :oe:constns:`OESz::OESolventModel` namespace.
      Method returns ``false`` when the invalid selection is chosen, ``true``
      otherwise.

   .. _OESz_OESzybkiSolventOptions_SetChargeEngine:

   .. oe:method:: SetChargeEngine

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

         .. oe:api::

            void SetChargeEngine(const OEProton::OEChargeEngineBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeEngine(argChargeEngine: OEChargeEngineBase) -> None

      Sets the charging engine to obtain partial charges used for solvation
      calculation by passing in an
      :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>` instance.

   .. _OESz_OESzybkiSolventOptions_SetUseCurrentCharges:

   .. oe:method:: SetUseCurrentCharges

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

         .. oe:api::

            void SetUseCurrentCharges()

      .. oe:language:: python

         .. oe:api:: python

            SetUseCurrentCharges() -> None

      Sets the charging engine to work with the existing charges. This
      command is equivalent to using the
      :oe:meth:`OESz::OESzybkiSolventOptions::SetChargeEngine` method with an
      :ref:`OEChargeEngineNoOp <OEProton_OEChargeEngineNoOp>` instance as input.
