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

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEGridChargeFunc, GridChargeFunc


.. _OEEon_OEGridChargeFunc:

.. oe:class:: OEGridChargeFunc

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEGridChargeFunc : public OEChargeFunc

  This class calculates charge density overlap using a Gaussian charge grid for the reference molecule and interpolating fit molecule atom charge overlaps.


The :ref:`OEGridChargeFunc <OEEon_OEGridChargeFunc>` class defines the following public methods:

   * Constructor
   * :oe:meth:`SetupRef<OEEon::OEGridChargeFunc::SetupRef>`
   * :oe:meth:`CreateCopy<OEEon::OEGridChargeFunc::CreateCopy>`

Public methods from :ref:`OEChargeFunc <OEEon_OEChargeFunc>` are also available.

   .. oe:method:: Constructor

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

         .. oe:api::

            OEGridChargeFunc()
            OEGridChargeFunc(const OEGridChargeFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEGridChargeFunc() -> OEGridChargeFunc
            OEGridChargeFunc(argFunc: OEGridChargeFunc) -> OEGridChargeFunc

      Default and copy constructors.

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

      .. oe:api::

         OEGridChargeFunc & operator=(const OEGridChargeFunc & argFunc)

      Assignment operator.


   .. oe:method:: SetupRef

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

         .. oe:api::

            bool SetupRef(const OEChem::OEMolBase& refMol)

      .. oe:language:: python

         .. oe:api:: python

            SetupRef(argRefMol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Overrides :oe:meth:`OEEon::OEChargeFunc::SetupRef` to set up the
      Gaussian charge grid for the reference molecule.
      The molecule must have 3D coordinates and partial charges assigned.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEGridChargeFunc* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEGridChargeFunc

      Creates and returns a deep copy of this object.

