.. include:: ../../toolkit-substitutions

.. oe:namespace:: OESheff



.. meta::
   :keywords: OESheffieldOptions, SheffieldOptions


.. _OESheff_OESheffieldOptions:

.. oe:class:: OESheffieldOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OESheffieldOptions : public OESystem::OEOptions

   This class orovides interface to setup options required for :ref:`OESheffield <OESheff_OESheffield>`
   calculations.
   
   The :ref:`OESheffieldOptions <OESheff_OESheffieldOptions>` class defines the following public methods:
    * :oe:meth:`GetA<OESheff::OESheffieldOptions::GetA>`
    * :oe:meth:`GetB<OESheff::OESheffieldOptions::GetB>` 
    * :oe:meth:`GetC<OESheff::OESheffieldOptions::GetC>`
    * :oe:meth:`GetSoluteDielectricConstant<OESheff::OESheffieldOptions::GetSoluteDielectricConstant>`
    * :oe:meth:`GetSolventDielectricConstant<OESheff::OESheffieldOptions::GetSolventDielectricConstant>`
    * :oe:meth:`SetA<OESheff::OESheffieldOptions::SetA>`
    * :oe:meth:`SetB<OESheff::OESheffieldOptions::SetB>`
    * :oe:meth:`SetC<OESheff::OESheffieldOptions::SetC>` 
    * :oe:meth:`SetSoluteDielectricConstant<OESheff::OESheffieldOptions::SetSoluteDielectricConstant>`
    * :oe:meth:`SetSolventDielectricConstant<OESheff::OESheffieldOptions::SetSolventDielectricConstant>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESheffieldOptions(const unsigned type = OESheffieldParamType::SmallMol);
            OESheffieldOptions(const OESheffieldOptions&)

      .. oe:language:: python

         .. oe:api:: python

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

      Default and copy constructors.

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

      .. oe:api::

         OESheffieldOptions &operator=(const OESheffieldOptions &)

      Assignment operator.


   .. oe:method:: GetA

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

         .. oe:api::

            double GetA() const

      .. oe:language:: python

         .. oe:api:: python

            GetA() -> float

      Gets the first Sheffield parameter value.

   .. oe:method:: GetB

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

         .. oe:api::

            double GetB() const

      .. oe:language:: python

         .. oe:api:: python

            GetB() -> float

      Gets the second Sheffield parameter value.

   .. oe:method:: GetC

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

         .. oe:api::

            double GetC() const

      .. oe:language:: python

         .. oe:api:: python

            GetC() -> float

      Gets the third Sheffield parameter value.

   .. oe:method:: GetSoluteDielectricConstant

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

         .. oe:api::

            double GetSoluteDielectricConstant() const

      .. oe:language:: python

         .. oe:api:: python

            GetSoluteDielectricConstant() -> float

      Gets the dielectric constant of the solute.

   .. oe:method:: GetSolventDielectricConstant

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

         .. oe:api::

            double GetSolventDielectricConstant() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolventDielectricConstant() -> float

      Gets the dielectric constant of the solvent.

   .. oe:method:: SetA

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

         .. oe:api::

            bool SetA(const double a)

      .. oe:language:: python

         .. oe:api:: python

            SetA(value: float) -> bool

      Optionally changes the first Sheffield parameter to the passed value ``a``.

   .. oe:method:: SetB

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

         .. oe:api::

            bool SetB(const double b)

      .. oe:language:: python

         .. oe:api:: python

            SetB(value: float) -> bool

      Optionally changes the second Sheffield parameter to the passed value ``b``.

   .. oe:method:: SetC

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

         .. oe:api::

            bool SetC(const double c)

      .. oe:language:: python

         .. oe:api:: python

            SetC(value: float) -> bool

      Optionally changes the third Sheffield parameter to the passed value ``c``.

   .. oe:method:: SetSoluteDielectricConstant

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

         .. oe:api::

            bool SetSoluteDielectricConstant(const double epsilon)

      .. oe:language:: python

         .. oe:api:: python

            SetSoluteDielectricConstant(value: float) -> bool

      Sets the dielectric constant for the solute.

   .. oe:method:: SetSolventDielectricConstant

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

         .. oe:api::

            bool SetSolventDielectricConstant(const double eps)

      .. oe:language:: python

         .. oe:api:: python

            SetSolventDielectricConstant(value: float) -> bool

      Sets the dielectric constant for the solvent.

