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

.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAnalyticOptions, AnalyticOptions


.. _OEShape_OEAnalyticOptions:

.. oe:class:: OEAnalyticOptions

   .. oe:api::

      class OEAnalyticOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for calculations
   with the *Analytic* method.
   
   The :ref:`OEAnalyticOptions <OEShape_OEAnalyticOptions>` class defines the following public methods:
    * :oe:meth:`GetExpType<OEShape::OEAnalyticOptions::GetExpType>`
    * :oe:meth:`GetProxyGridCutoff<OEShape::OEAnalyticOptions::GetProxyGridCutoff>` 
    * :oe:meth:`GetUseProxyGrid<OEShape::OEAnalyticOptions::GetUseProxyGrid>`
    * :oe:meth:`SetExpType<OEShape::OEAnalyticOptions::SetExpType>`
    * :oe:meth:`SetProxyGridCutoff<OEShape::OEAnalyticOptions::SetProxyGridCutoff>` 
    * :oe:meth:`SetUseProxyGrid<OEShape::OEAnalyticOptions::SetUseProxyGrid>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEAnalyticOptions()
            OEAnalyticOptions(const OEAnalyticOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEAnalyticOptions() -> OEAnalyticOptions
            OEAnalyticOptions(arg2: OEAnalyticOptions) -> OEAnalyticOptions

      Default and copy constructors.

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

      .. oe:api::

         OEAnalyticOptions &operator=(const OEAnalyticOptions &)

      Assignment operator.


   .. oe:method:: GetExpType

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

         .. oe:api::

            unsigned int GetExpType() const

      .. oe:language:: python

         .. oe:api:: python

            GetExpType() -> int

      Gets the current value of the exponential type used by the function.

   .. oe:method:: GetProxyGridCutoff

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

         .. oe:api::

            double GetProxyGridCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetProxyGridCutoff() -> float

      Gets the proxy grid cutoff currently set.

   .. oe:method:: GetUseProxyGrid

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

         .. oe:api::

            bool GetUseProxyGrid() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseProxyGrid() -> bool

      Returns the state of the use proxy grid flag. If true, proxy grid would be 
      used to decide if an atom pair should be included in calculations.

   .. oe:method:: SetExpType

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

         .. oe:api::

            bool SetExpType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetExpType(value: int) -> bool

      Set the exponential type to be used for calculation. The default is
      :oe:const:`OEShape::OEExponentialType::Standard`. Alternatives are
      defined in the :oe:constns:`OEShape::OEExponentialType` namespace.

   .. oe:method:: SetProxyGridCutoff

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

         .. oe:api::

            bool SetProxyGridCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetProxyGridCutoff(value: float) -> bool

      Set the radius to use when using proxy grid is turned on. 
      By default this is set to 3.0 |A|.

   .. oe:method:: SetUseProxyGrid

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

         .. oe:api::

            bool SetUseProxyGrid(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseProxyGrid(value: bool) -> bool

      Sets the state of the use proxy grid flag. If true, proxy grid would be 
      used to decide if an atom pair should be included in calculations.

   

