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

.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEBendPotential, OEMolFunc2


.. _OEMolPotential_OEBendPotential:

.. oe:class:: OEBendPotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEBendPotential : public virtual OEMolPotential::OEFFPotential

   The :ref:`OEBendPotential <OEMolPotential_OEBendPotential>` defines an interface
   all angle bending 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:`OEBendPotential <OEMolPotential_OEBendPotential>` implements the following methods:
    * :oe:meth:`Set<OEMolPotential::OEBendPotential::Set>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEBendPotential(const OEFFParams&)
            OEBendPotential(const OEBendPotential&)

      .. oe:language:: python

         .. oe:api:: python

            OEBendPotential(fp: OEFFParams) -> OEBendPotential
            OEBendPotential(arg2: OEBendPotential) -> OEBendPotential

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

      .. oe:api::

         OEBendPotential& operator=(const OEBendPotential&)

     Assignment operator.

   .. oe:method:: Set

      .. oe:api::

         bool Set(const OESystem::OEBinaryPredicate<OEChem::OEBondBase, OEChem::OEBondBase>&,
                  unsigned int flag = OEFuncType::Bend) override

      This method allows interaction-level control of the angle-bend term. The predicate passed is used 
      to test the molecule’s bond angles. Only those bond angles which are reported as ``true`` are included 
      in the list of interactions to be calculated.  The :oe:meth:`Set<OEMolPotential::OEBendPotential::Set>` method must 
      be called before the :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>` for it to be effective.
