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

.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEInterNonBondPotBase, OEFFPotential, OEInterMolFunc2


.. _OEMolPotential_OEInterNonBondPotBase:

.. oe:class:: OEInterNonBondPotBase

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEInterNonBondPotBase : public OEFFPotential, public OEMolPotential::OEInterMolFunc2

   The :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>` is an abstract base class.  This class defines a common
   base class for all inter-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 following methods are publicly inherited from :ref:`OEInterMolFunc1 <OEMolPotential_OEInterMolFunc1>`:
    * :oe:meth:`AdaptHostCoords<OEMolPotential::OEInterMolFunc1::AdaptHostCoords>`
    * :oe:meth:`GetVar<OEMolPotential::OEInterMolFunc1::GetVar>`
    * :oe:meth:`SetHostFlex<OEMolPotential::OEInterMolFunc1::SetHostFlex>`
    * :oe:meth:`SetupHost<OEMolPotential::OEInterMolFunc1::SetupHost>`

   The :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>` implements the following methods:
    * :oe:meth:`Set<OEMolPotential::OEInterNonBondPotBase::Set>`
    * :oe:meth:`SetNonBondCutoff<OEMolPotential::OEInterNonBondPotBase::SetNonBondCutoff>`

   The following classes derive from this class:
    * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
    * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
    * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`

   .. oe:method:: Constructors

      .. oe:api::

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

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

      .. oe:api::

         OEInterNonBondPotBase& operator=(const OEInterNonBondPotBase&)

     Assignment operator.


   .. 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.


   .. oe:method:: SetNonBondCutoff

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

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(arg2: float) -> bool

      Sets non-bonded interactions cutoff.
      Setting a value of ``0.0`` or less assumes that all interactions should be
      included without any cutoff.
