.. oe:namespace:: OEMolAM1

.. meta::
   :keywords: OEAM1Results, AM1Results


.. _OEMolAM1_OEAM1Results:

.. oe:class:: OEAM1Results

   .. oe:api::


      class OEAM1Results

   This class represents :ref:`OEAM1 <OEMolAM1_OEAM1>` calculation results.

   The :ref:`OEAM1Results <OEMolAM1_OEAM1Results>` class defines the following public methods:
    * :oe:meth:`GetAtomicBondOrder<OEMolAM1::OEAM1Results::GetAtomicBondOrder>`
    * :oe:meth:`GetBondOrder<OEMolAM1::OEAM1Results::GetBondOrder>`
    * :oe:meth:`GetBondOrders<OEMolAM1::OEAM1Results::GetBondOrders>`
    * :oe:meth:`GetCharges<OEMolAM1::OEAM1Results::GetCharges>` 
    * :oe:meth:`GetEnergy<OEMolAM1::OEAM1Results::GetEnergy>`
    * :oe:meth:`GetNumSCFCycles<OEMolAM1::OEAM1Results::GetNumSCFCycles>`
    * :oe:meth:`IsConverged<OEMolAM1::OEAM1Results::IsConverged>` 

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEAM1Results()
            OEAM1Results(const OEAM1Results&)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1Results() -> OEAM1Results
            OEAM1Results(arg2: OEAM1Results) -> OEAM1Results

      Default and copy constructors.

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

      .. oe:api::

         OEAM1Results &operator=(const OEAM1Results &)

      Assignment operator.


   .. oe:method:: GetAtomicBondOrder

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

         .. oe:api::

            double GetAtomicBondOrder(const unsigned int index) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicBondOrder(argAtom: int) -> float

      Returns the atomic bond order of the atom with specified index.

   .. oe:method:: GetBondOrder

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

         .. oe:api::

            double GetBondOrder(const unsigned int index1,
                                const unsigned int index2) const

      .. oe:language:: python

         .. oe:api:: python

            GetBondOrder(argAtom1: int, argAtom2: int) -> float

      Returns the bond order between the two atoms with specified indices.

      .. seealso::

         * :ref:`chapter_bondordertheory` chapter

   .. oe:method:: GetBondOrders

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

         .. oe:api::

            std::vector<double> GetBondOrders() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondOrders() -> OEDoubleVector

      Returns the bond orders on all bondss. Bond orders are stored in the vector
      according to the bond indices.

      .. seealso::

         * :ref:`chapter_bondordertheory` chapter

   .. oe:method:: GetCharges

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

         .. oe:api::

            std::vector<double> GetCharges() const

      .. oe:language:: python

         .. oe:api:: python

            GetCharges() -> OEDoubleVector

      Returns the AM1 charges on all atoms. Charges are stored in the vector
      according to the atom indices.

   .. oe:method:: GetEnergy

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

         .. oe:api::

            double GetEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergy() -> float

      Returns the AM1 calculated energy of the molecule.

   .. oe:method:: GetNumSCFCycles

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

         .. oe:api::

            unsigned int GetNumSCFCycles() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumSCFCycles() -> int

      Returns the number of self-consistent field cycles used during calculation.

   .. oe:method:: IsConverged

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

         .. oe:api::

            bool IsConverged() const

      .. oe:language:: python

         .. oe:api:: python

            IsConverged() -> bool

      Returns if the :ref:`OEAM1 <OEMolAM1_OEAM1>` self-consistent field calculation
      converged.
