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

.. oe:namespace:: OEMolAM1

.. meta::
   :keywords: OEAM1Options, AM1Options


.. _OEMolAM1_OEAM1Options:

.. oe:class:: OEAM1Options

   .. oe:api::

      class OEAM1Options : public OESystem::OEOptions

   This class provides an interface to setup options required for 
   :ref:`OEAM1 <OEMolAM1_OEAM1>` calculations.
   
   The :ref:`OEAM1Options <OEMolAM1_OEAM1Options>` class defines the following public methods:
    * :oe:meth:`GetMaxScfIter<OEMolAM1::OEAM1Options::GetMaxScfIter>`
    * :oe:meth:`GetNumericGradDelta<OEMolAM1::OEAM1Options::GetNumericGradDelta>` 
    * :oe:meth:`GetSCFTolerance<OEMolAM1::OEAM1Options::GetSCFTolerance>`
    * :oe:meth:`GetSemiMethod<OEMolAM1::OEAM1Options::GetSemiMethod>`
    * :oe:meth:`SetMaxScfIter<OEMolAM1::OEAM1Options::SetMaxScfIter>`
    * :oe:meth:`SetNumericGradDelta<OEMolAM1::OEAM1Options::SetNumericGradDelta>` 
    * :oe:meth:`SetSCFTolerance<OEMolAM1::OEAM1Options::SetSCFTolerance>`
    * :oe:meth:`SetSemiMethod<OEMolAM1::OEAM1Options::SetSemiMethod>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEAM1Options()
            OEAM1Options(const OEAM1Options&)

      .. oe:language:: python

         .. oe:api:: python

            OEAM1Options() -> OEAM1Options
            OEAM1Options(arg2: OEAM1Options) -> OEAM1Options

      Default and copy constructors.

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

      .. oe:api::

         OEAM1Options &operator=(const OEAM1Options &)

      Assignment operator.


   .. oe:method:: GetMaxScfIter

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

         .. oe:api::

            unsigned int GetMaxScfIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxScfIter() -> int

      Gets the maximum number of self-consistent field iterations to be used.

   .. oe:method:: GetNumericGradDelta

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

         .. oe:api::

            double GetNumericGradDelta() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumericGradDelta() -> float

      Gets the current value of the numerical gradients delta to be
      used for gradients calculation.

   .. oe:method:: GetSCFTolerance

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

         .. oe:api::

            double GetSCFTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetSCFTolerance() -> float

      Gets the current value of the self-consistent field calculation tolerance.

   .. oe:method:: GetSemiMethod

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

         .. oe:api::

            unsigned int GetSemiMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetSemiMethod() -> int

      Gets the current value of the semi-empirical method to be used.

   .. oe:method:: SetMaxScfIter

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

         .. oe:api::

            bool SetMaxScfIter(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxScfIter(value: int) -> bool

      Sets the maximum number of self-consistent field iterations to be used.

   .. oe:method:: SetNumericGradDelta

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

         .. oe:api::

            bool SetNumericGradDelta(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNumericGradDelta(value: float) -> bool

      Sets the value of the numerical gradients delta to be
      used for gradients calculation.

   .. oe:method:: SetSCFTolerance

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

         .. oe:api::

            bool SetSCFTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSCFTolerance(value: float) -> bool

      Sets the value of the self-consistent field calculation tolerance.

   .. oe:method:: SetSemiMethod

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

         .. oe:api::

            bool SetSemiMethod(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetSemiMethod(value: int) -> bool

      Sets the semi-empirical method to be used for the calculations. 
      The default is :oe:const:`OEMolAM1::OEMethodType::AM1`. Alternatives are
      defined in the :oe:constns:`OEMolAM1::OEMethodType` namespace.

