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

.. oe:namespace:: OESz

.. meta::
   :keywords: OELigandEnergy


.. _OESz_OELigandEnergy:

.. oe:class:: OELigandEnergy

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OELigandEnergy

   This class provides a container for the total energy and
   energy components resulting from a FF energy calculation on a ligand.

   .. seealso::

      * :ref:`OELigandOptResults <OESz_OELigandOptResults>` class

   The :ref:`OELigandEnergy <OESz_OELigandEnergy>` class defines the following public methods:

    * :oe:meth:`GetBondEne<OESz::OELigandEnergy::GetBondEne>`
    * :oe:meth:`GetBendEne<OESz::OELigandEnergy::GetBendEne>`
    * :oe:meth:`GetTorsionEne<OESz::OELigandEnergy::GetTorsionEne>`
    * :oe:meth:`GetImproperEne<OESz::OELigandEnergy::GetImproperEne>`
    * :oe:meth:`GetVdWEne<OESz::OELigandEnergy::GetVdWEne>`
    * :oe:meth:`GetCoulombEne<OESz::OELigandEnergy::GetCoulombEne>`
    * :oe:meth:`GetIntraEne<OESz::OELigandEnergy::GetIntraEne>`
    * :oe:meth:`GetSolvationEne<OESz::OELigandEnergy::GetSolvationEne>`
    * :oe:meth:`GetTotalEne<OESz::OELigandEnergy::GetTotalEne>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OELigandEnergy()
            OELigandEnergy(const OELigandEnergy&)

      .. oe:language:: python

         .. oe:api:: python

            OELigandEnergy() -> OELigandEnergy
            OELigandEnergy(arg2: OELigandEnergy) -> OELigandEnergy

      Default and copy constructors.


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

      .. oe:api::

         OELigandEnergy& operator=(const OELigandEnergy&)


   .. _OESz_OELigandEnergy_GetBondEne:

      Assignment operator.


   .. oe:method:: GetBondEne

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

         .. oe:api::

            double GetBondEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondEne() -> float

      Returns the bond energy component of the total energy


   .. _OESz_OELigandEnergy_GetBendEne:

   .. oe:method:: GetBendEne

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

         .. oe:api::

            double GetBendEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetBendEne() -> float

      Returns the angle bending energy component of the total energy


   .. _OESz_OELigandEnergy_GetTorsionEne:

   .. oe:method:: GetTorsionEne

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

         .. oe:api::

            double GetTorsionEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetTorsionEne() -> float

      Returns the proper torsional energy component of the total energy



   .. _OESz_OELigandEnergy_GetImproperEne:

   .. oe:method:: GetImproperEne

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

         .. oe:api::

            double GetImproperEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetImproperEne() -> float

      Returns the improper torsional energy component of the total energy



   .. _OESz_OELigandEnergy_GetVdWEne:

   .. oe:method:: GetVdWEne

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

         .. oe:api::

            double GetVdWEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetVdWEne() -> float

      Returns the van der Walls interaction energy component of the total energy



   .. _OESz_OELigandEnergy_GetCoulombEne:

   .. oe:method:: GetCoulombEne

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

         .. oe:api::

            double GetCoulombEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetCoulombEne() -> float

      Returns the coulomb energy component of the total energy



   .. _OESz_OELigandEnergy_GetIntraEne:

   .. oe:method:: GetIntraEne

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

         .. oe:api::

            double GetIntraEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntraEne() -> float

      Returns the intra energy component of the total energy



   .. _OESz_OELigandEnergy_GetSolvationEne:

   .. oe:method:: GetSolvationEne

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

         .. oe:api::

            double GetSolvationEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvationEne() -> float

      Returns the solvation energy component of the total energy



   .. _OESz_OELigandEnergy_GetTotalEne:

   .. oe:method:: GetTotalEne

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

         .. oe:api::

            double GetTotalEne() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEne() -> float

      Returns the total energy

