OEFF TK 2.0.0
================================================================================

Licensing
--------------------------------------------------------------------------------

* **OEFF TK** is available to anyone with an **OESzybki TK** license.
  Visit https://www.eyesopen.com/contact if you need an **OESzybki TK** license.

OEFF functionality
--------------------------------------------------------------------------------

This is the first official release of **OEFF TK**.  The underlying
functionality was previously released in C++ as part of the
**OESzybki TK** advanced interface. This toolkit is currently available in
C++ and Python.  An overview of its capabilities is provided below.

**OEFF TK** provides access to powerful low-level functionality for
advanced users to develop molecular modeling applications.
With **OEFF TK**, users also have the ability to create variations
of molecular interaction classes for energy evaluation and optimization,
adding to the built-in interactions, if desired.  **OESzybki TK**
complements **OEFF TK** as the high-level API for molecular modeling
functionalities. 

Objective functions and molecular interactions
--------------------------------------------------------------------------------

All molecular interactions are objective functions with additional API
points for molecular definitions. A set of pure virtual classes
that can be used to define new interactions are provided for both generic
objective functions and molecule specific interaction functions.  The
following virtual base classes are available:

- :ref:`OEFunc0 <OEOpt_OEFunc0>`
- :ref:`OEFunc1 <OEOpt_OEFunc1>`
- :ref:`OEFunc2 <OEOpt_OEFunc2>`
- :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`
- :ref:`OEMolFunc0 <OEMolPotential_OEMolFunc0>`
- :ref:`OEMolFunc1 <OEMolPotential_OEMolFunc1>`
- :ref:`OEMolFunc2 <OEMolPotential_OEMolFunc2>`

Force fields
--------------------------------------------------------------------------------

Force fields and components of force fields are defined as molecule objective
functions and are derived from the above-specified base classes.  The
following force fields and components are available:

- :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
- ``OEMolMMFF::OEMMFFBend``
- ``OEMolMMFF::OEMMFFStretch``
- :ref:`OEMMFFStretchBend <OEMolMMFF_OEMMFFStretchBend>`
- ``OEMolMMFF::OEMMFFOutOfPlane``
- ``OEMolMMFF::OEMMFFTorsion``
- ``OEMolMMFF::OEMMFFVdw``
- ``OEMolMMFF::OEMMFFInterVdw``
- ``OEMolMMFF::OEMMFFInterVdwNN``
- ``OEMolMMFF::OEMMFFCoulomb``
- ``OEMolMMFF::OEMMFFInterCoulomb``
- ``OEFF::OEMMFFAmber``
- :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
- :ref:`OESheffield <OESheff_OESheffield>`

Optimizers
--------------------------------------------------------------------------------

A powerful set of optimizers that can be used to optimize objective
functions is now available:

- :ref:`OEBFGSOpt <OEOpt_OEBFGSOpt>`
- :ref:`OEConjGradOpt <OEOpt_OEConjGradOpt>`
- :ref:`OEDFPOpt <OEOpt_OEDFPOpt>`
- :ref:`OEFletcherReevesOpt <OEOpt_OEFletcherReevesOpt>`
- :ref:`OENewtonOpt <OEOpt_OENewtonOpt>`
- :ref:`OERibierePolakOpt <OEOpt_OERibierePolakOpt>`
- :ref:`OESteepestDescentOpt <OEOpt_OESteepestDescentOpt>`

Adaptors
--------------------------------------------------------------------------------

Adaptors that can be used to optimize molecule objective functions in
transformed coordinate space are now available:

- :ref:`OEInterAdaptor <OEMolPotential_OEInterAdaptor>`
- :ref:`OEQuatAdaptor <OEMolPotential_OEQuatAdaptor>`
- :ref:`OESubsetAdaptor <OEMolPotential_OESubsetAdaptor>`
- :ref:`OETorAdaptor <OEMolPotential_OETorAdaptor>`
- :ref:`OETorQuatAdaptor <OEMolPotential_OETorQuatAdaptor>`


New features
--------------------------------------------------------------------------------

* Two new intermolecular force fields, ``OEFF::OEMMFFAmber`` and
  :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`, have been added to the force field suites for
  molecular interactions.  Both force fields use :ref:`OEMMFF <OEMolMMFF_OEMMFF>`
  for intermolecular interactions and more accurate components for
  intermolecular interactions.

* A new class, ``OEFF::OEMMFFAmberOptions``, has been added that sets
  all options of the ``OEFF::OEMMFFAmber`` object during its
  construction.

* A new class, :ref:`OEMMFFIEFFOptions <OEFF_OEMMFFIEFFOptions>`, has been added that sets
  all options of the :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>` object during its
  construction.

* A new class, :ref:`OESheffieldOptions <OESheff_OESheffieldOptions>`, has been added that
  sets all options of the :ref:`OESheffield <OESheff_OESheffield>` object during its
  construction.  All :ref:`OESheffield <OESheff_OESheffield>` methods with similar
  names as their :ref:`OESheffieldOptions <OESheff_OESheffieldOptions>` counterparts are now
  deprecated.

  The following table shows the older, deprecated functions and their
  new option replacements:

  =========================================================   ======================================================================== 
  Deprecated                                                  New option-based
  ---------------------------------------------------------   ------------------------------------------------------------------------ 
  ``OESheff::OESheffield::Set_A``                             :oe:meth:`OESheff::OESheffieldOptions::SetA`

  ``OESheff::OESheffield::Set_B``                             :oe:meth:`OESheff::OESheffieldOptions::SetB`

  ``OESheff::OESheffield::SetSoluteDielectricConstant``       :oe:meth:`OESheff::OESheffieldOptions::SetSoluteDielectricConstant`

  ``OESheff::OESheffield::SetSolventDielectricConstant``      :oe:meth:`OESheff::OESheffieldOptions::SetSolventDielectricConstant`

  ``OESheff::OESheffield::GetParameters``                     :oe:meth:`OESheff::OESheffieldOptions::GetA`  
                                                              :oe:meth:`OESheff::OESheffieldOptions::GetB`  
                                                              :oe:meth:`OESheff::OESheffieldOptions::GetSoluteDielectricConstant`  
                                                              :oe:meth:`OESheff::OESheffieldOptions::GetSolventDielectricConstant`

  =========================================================   ======================================================================== 
