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

.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OENonBondPotBase, OEMolFunc2


.. _OEMolPotential_OENonBondPotBase:

.. oe:class:: OENonBondPotBase

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OENonBondPotBase : public virtual OEMolPotential::OEFFPotential

   The :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>` is an abstract base class.  This class defines a common
   base class for all intra-molecular non-bonded force field interaction potentials.

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>`
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`

   The following methods are publicly inherited from :ref:`OEFunc2 <OEOpt_OEFunc2>`:
    * :oe:meth:`operator()<OEOpt::OEFunc2::operator()>`

   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`Clear<OEMolPotential::OEMolFunc::Clear>`
    * :oe:meth:`ClearPredicates<OEMolPotential::OEMolFunc::ClearPredicates>`
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`:
    * :oe:meth:`Set<OEMolPotential::OEFFPotential::Set>`
    
   The :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>` implements the following methods:
    * :oe:meth:`GetNonBondOptions<OEMolPotential::OENonBondPotBase::GetNonBondOptions>`
    * :oe:meth:`Set<OEMolPotential::OENonBondPotBase::Set>`

   The following classes derive from this class:
    * :ref:`OENonBondPotential <OEMolPotential_OENonBondPotential>`
    * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
    * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`

   .. oe:method:: Constructors

      .. oe:api::

         OENonBondPotBase(const OEMolPotential::OEFFParams& fp,
                          const OENonBondIntcsOptions& options = OENonBondIntcsOptions())
         OENonBondPotBase(const OENonBondPotBase&)

      Constructor and copy constructor.
 
   .. oe:method:: Assignment operator

      .. oe:api::

         OENonBondPotBase& operator=(const OENonBondPotBase&)

     Assignment operator.

   .. _OEMolPotential_OENonBondPotBase_GetNonBondOptions:

   .. oe:method:: GetNonBondOptions

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

         .. oe:api::

            OENonBondIntcsOptions& GetNonBondOptions()
            const OENonBondIntcsOptions& GetNonBondOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonBondOptions() -> OENonBondIntcsOptions

      Returns :oe:cls:`options<OEMolPotential::OENonBondIntcsOptions>` related to non-bonded interactions.


   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEAtomBase, OEChem::OEAtomBase>& pred,
                  unsigned int flag = OEFuncType::All)

      This method can be used for interaction-level control of the non-bonded terms. Interactions between two 
      atoms are only included if the test of the binary predicate with both atoms returns ``true``. 
      The :oe:meth:`Set<OEMolPotential::OENonBondPotBase::Set>` method must be called before the 
      :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.
