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

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonPBOptions, EonPBOptions


.. _OEEon_OEEonPBOptions:

.. oe:class:: OEEonPBOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonPBOptions : public OESystem::OEOptions

   This class sets up options required for generating PB calculations with  :ref:`OEEonPBFunc<OEEon_OEEonPBFunc>`.



The :ref:`OEEonPBOptions <OEEon_OEEonPBOptions>` class defines the following public methods:
    * :oe:meth:`GetDielectric<OEEon::OEEonPBOptions::GetDielectric>` and
      :oe:meth:`SetDielectric<OEEon::OEEonPBOptions::SetDielectric>`
    * :oe:meth:`GetSaltConcentration<OEEon::OEEonPBOptions::GetSaltConcentration>` and
      :oe:meth:`SetSaltConcentration<OEEon::OEEonPBOptions::SetSaltConcentration>` 
    * :oe:meth:`GetInnerMask<OEEon::OEEonPBOptions::GetInnerMask>` and
      :oe:meth:`SetInnerMask<OEEon::OEEonPBOptions::SetInnerMask>`
    * :oe:meth:`GetJoinRef<OEEon::OEEonPBOptions::GetJoinRef>` and
      :oe:meth:`SetJoinRef<OEEon::OEEonPBOptions::SetJoinRef>` 
    * :oe:meth:`GetOuterMask<OEEon::OEEonPBOptions::GetOuterMask>` and
      :oe:meth:`SetOuterMask<OEEon::OEEonPBOptions::SetOuterMask>` 
    * :oe:meth:`GetGridSpacing<OEEon::OEEonPBOptions::GetGridSpacing>` and
      :oe:meth:`SetGridSpacing<OEEon::OEEonPBOptions::SetGridSpacing>` 
    * :oe:meth:`GetGridBuffer<OEEon::OEEonPBOptions::GetGridBuffer>` and
      :oe:meth:`SetGridBuffer<OEEon::OEEonPBOptions::SetGridBuffer>` 
    * :oe:meth:`CreateCopy<OEEon::OEEonPBOptions::CreateCopy>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEEonPBOptions()
            OEEonPBOptions(const OEEonPBOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEEonPBOptions() -> OEEonPBOptions
            OEEonPBOptions(arg2: OEEonPBOptions) -> OEEonPBOptions

      Default and copy constructors.

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

      .. oe:api::

         OEEonPBOptions &operator=(const OEEonPBOptions &)

      Assignment operator.

   .. oe:method:: GetDielectric

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

         .. oe:api::

            double GetDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectric() -> float

      Returns dielectric constant used in PB computation. See :oe:meth:`SetDielectric<OEEon::OEEonPBOptions::SetDielectric>` method.

   .. oe:method:: SetDielectric

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

         .. oe:api::

            bool SetDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectric(value: float) -> bool

      Sets the dielectric constant in PB computation.
      **Default: 80.0.**

   .. oe:method:: GetSaltConcentration

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

         .. oe:api::

            double GetSaltConcentration() const

      .. oe:language:: python

         .. oe:api:: python

            GetSaltConcentration() -> float

      Returns salt concentration value in PB computation. See :oe:meth:`SetSaltConcentration<OEEon::OEEonPBOptions::SetSaltConcentration>` method.

   .. 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 salt concentration value in PB computation.
      **Default: 0.04.**


   .. oe:method:: GetInnerMask

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

         .. oe:api::

            double GetInnerMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerMask() -> float

      Returns inner mask in PB computation. See :oe:meth:`SetInnerMask<OEEon::OEEonPBOptions::SetInnerMask>` method.


   .. oe:method:: SetInnerMask

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

         .. oe:api::

            bool SetInnerMask(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerMask(value: float) -> bool

      Sets the inner mask in PB computation.
      **Default: 0.05.**


   .. _OEEon_OEEonPBOptions_GetJoinRef:
   .. oe:method:: GetJoinRef

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

         .. oe:api::

            bool GetJoinRef() const

      .. oe:language:: python

         .. oe:api:: python

            GetJoinRef() -> bool

      See :oe:meth:`SetJoinRef<OEEon::OEEonPBOptions::SetJoinRef>` method.

   .. _OEEon_OEEonPBOptions_SetJoinRef:
   .. oe:method:: SetJoinRef

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

         .. oe:api::

            bool SetJoinRef(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetJoinRef(value: bool) -> bool

      Sets flag if molecule should be joint with the reference to form a complex.
      **Default: False**

   .. oe:method:: GetOuterMask

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

         .. oe:api::

            double GetOuterMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetOuterMask() -> float

      Returns the outer mask value in PB computation. See :oe:meth:`SetOuterMask<OEEon::OEEonPBOptions::SetOuterMask>` method.


   .. oe:method:: SetOuterMask

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

         .. oe:api::

            bool SetOuterMask(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetOuterMask(value: float) -> bool

      Sets the outer mask in PB computation.
      **Default: 0.0005.**


   .. oe:method:: GetGridSpacing

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

         .. oe:api::

            double GetGridSpacing() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridSpacing() -> float

      Returns grid spacing used internally in PB computation. See :oe:meth:`SetGridSpacing<OEEon::OEEonPBOptions::SetGridSpacing>` method.

   .. oe:method:: SetGridSpacing

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

         .. oe:api::

            bool SetGridSpacing(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGridSpacing(value: float) -> bool

      Sets the grid spacing for PB computation.
      **Default: 0.75.**

   .. oe:method:: GetGridBuffer

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

         .. oe:api::

            double GetGridBuffer() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridBuffer() -> float

      Grid buffer value used in PB computation. See :oe:meth:`SetGridBuffer<OEEon::OEEonPBOptions::SetGridBuffer>` method.


   .. oe:method:: SetGridBuffer

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

         .. oe:api::

            bool SetGridBuffer(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetGridBuffer(value: float) -> bool

      Sets the grid buffer value used in PB computation.
      **Default: 6.0.**

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEEonPBOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEEonPBOptions

      Creates and returns a deep copy of this object.

