
OEFF TK 2.3.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------
* A new generic set of force field potential classes has been added to simplify
  implementing new force fields in OEFF TK:

  * :ref:`OEFFPotential <OEMolPotential_OEFFPotential>`
  * :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
  * :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
  * :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
  * :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`
  * :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`
  * :ref:`OENonBondPotential <OEMolPotential_OENonBondPotential>`
  * :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
  * :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
  * :ref:`OEInterNonBondPotBase <OEMolPotential_OEInterNonBondPotBase>`
  * :ref:`OEInterNonBondPotential <OEMolPotential_OEInterNonBondPotential>`
  * :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
  * :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`

..  _deprecated_OEFF_classes:

.. _oemolsmirnoff_oesmirnoffoutofplane:

.. _oemolsmirnoff_oenonbondbase:

* With the introduction of the new generic force field potential classes in **OEFF TK**,
  several previously existing classes have been deprecated.  The following table
  shows the deprecated classes and their replacements:

  ========================================   =================================================
  Deprecated Class                           New Class
  ----------------------------------------   -------------------------------------------------
  ``OEMolPotential::OEStretchBase``          :ref:`OEStretchPotential <OEMolPotential_OEStretchPotential>`
  ``OEMolMMFF::OEMMFFStretch``
  ``OEMolSmirnoff::OESmirnoffStretch``

  ``OEMolMMFF::OEMMFFBend``                  :ref:`OEBendPotential <OEMolPotential_OEBendPotential>`
  ``OEMolSmirnoff::OESmirnoffBend``

  ``OEMolMMFF::OEMMFFTorsion``               :ref:`OETorsionPotential <OEMolPotential_OETorsionPotential>`
  ``OEMolSmirnoff::OESmirnoffTorsion``

  ``OEMolSmirnoff::OESmirnoffOutOfPlane``    :ref:`OEOutOfPlanePotential <OEMolPotential_OEOutOfPlanePotential>`

  ``OEMolPotential::OENonBondBase``          :ref:`OENonBondPotBase <OEMolPotential_OENonBondPotBase>`

  ``OEMolMMFF::OEMMFFVdw``                   :ref:`OEVdwPotential <OEMolPotential_OEVdwPotential>`
  ``OEMolSmirnoff::OESmirnoffVdw``

  ``OEMolMMFF::OEMMFFCoulomb``               :ref:`OECoulombPotential <OEMolPotential_OECoulombPotential>`
  ``OEMolSmirnoff::OESmirnoffCoulomb``

  ``OEMolMMFF::OEMMFFInterVdw``              :ref:`OEInterVdwPotential <OEMolPotential_OEInterVdwPotential>`
  ``OEMolMMFF::OEMMFFInterVdwNN``
  ``OEMolSmirnoff::OESmirnoffInterVdw``

  ``OEMolMMFF::OEMMFFInterCoulomb``          :ref:`OEInterCoulombPotential <OEMolPotential_OEInterCoulombPotential>`
  ========================================   =================================================

* New OpenFF parameters ``parsley_1.2.1`` have been added as built-in parameters and can be used
  in the construction of an :ref:`OESmirnoff <OEMolSmirnoff_OESmirnoff>` object.

* Two new classes, :ref:`OEParsleyParams <OEMolSmirnoff_OEParsleyParams>` and :ref:`OEParsley <OEMolSmirnoff_OEParsley>`,
  have been added that work with the latest versions of available OpenFF Parsley force fields.

* New FF14SB ([Maier-2015]_) protein force field parameters have been implemented.  These
  parameters are accessible through the following parameter and force field classes.

  * :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>`: an FF14SB for proteins with custom
    :ref:`OESmirnoffParams <OEMolSmirnoff_OESmirnoffParams>` for cofactor and/or ligand
  * :ref:`OEFF14SBParsleyParams <OEFF_OEFF14SBParsleyParams>`: an FF14SB for proteins with
    :ref:`OEParsleyParams <OEMolSmirnoff_OEParsleyParams>` for cofactor and/or ligand
  * :ref:`OEFF14SBSmirnoff <OEFF_OEFF14SBSmirnoff>`: a force field for proteins with :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>`
  * :ref:`OEFF14SBParsley <OEFF_OEFF14SBParsley>`: a force field for proteins with :ref:`OEFF14SBParsleyParams <OEFF_OEFF14SBParsleyParams>`
  * :ref:`OEFF14SBSmirnoffComplex <OEFF_OEFF14SBSmirnoffComplex>`: a force field for protein-ligand complexes with
    :ref:`OEFF14SBSmirnoffParams <OEFF_OEFF14SBSmirnoffParams>`
  * :ref:`OEFF14SBParsleyComplex <OEFF_OEFF14SBParsleyComplex>`: a force field for protein-ligand complex with
    :ref:`OEFF14SBParsleyParams <OEFF_OEFF14SBParsleyParams>`

* A new class, :ref:`OEMMFFAmberComplex <OEFF_OEMMFFAmberComplex>`, has been added that allows protein-ligand
  optimization with protein flexibility.  Accordingly, ``OEFF::OEMMFFAmber`` has been
  deprecated.

* A new preliminary class, :ref:`OEComplexFFParameter <OEFF_OEComplexFFParameter>`, has been added as
  part of the extended set of :ref:`OEParameter <OESystem_OEParameter>` classes. The new parameter class works with
  predefined complex force fields using an :ref:`OEComplexFF <OEFF_OEComplexFF>`
  object.

* The methods ``OEFF::OEComplexFF::PrepMol`` and ``OEFF::OEComplexFF::PrepHost``
  have been removed from the preliminary API :ref:`OEComplexFF <OEFF_OEComplexFF>` as they are no longer required to
  setup an :ref:`OEComplexFF <OEFF_OEComplexFF>`.

* A new class, :ref:`OEComplexEnergies <OEFF_OEComplexEnergies>`, has been added that represents energy components of a
  protein-ligand complex.

* A new overload of :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` has been added that
  provides the energy components in the form of an :ref:`OEComplexEnergies <OEFF_OEComplexEnergies>`.


Documentation changes
--------------------------------------------------------------------------------

* All the **OEFF TK** examples have been reorganized to reflect the
  modified API behavior.
