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

.. oe:namespace:: OEMolPotential

.. meta::
   :keywords: OEOutOfPlanePotential, OEMolFunc2


.. _OEMolPotential_OEOutOfPlanePotential:

.. oe:class:: OEOutOfPlanePotential

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEOutOfPlanePotential : public virtual OEMolPotential::OEFFPotential

   The :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>` defines an interface for
   all out-of-plane 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>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEOutOfPlanePotential(const OEFFParams&)
            OEOutOfPlanePotential(const OEOutOfPlanePotential&)

      .. oe:language:: python

         .. oe:api:: python

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

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

      .. oe:api::

         OEOutOfPlanePotential& operator=(const OEOutOfPlanePotential&)

     Assignment operator.
