.. oe:namespace:: OESz


.. oe:constnamespace:: OEPotentialTerms

   This namespace contains constants describing potential terms which might be calculated
   in different Szybki runs. Entries: :oe:const:`OESz::OEPotentialTerms::VdW`, 
   :oe:const:`OESz::OEPotentialTerms::Coulomb`, :oe:const:`OESz::OEPotentialTerms::Bond`,
   :oe:const:`OESz::OEPotentialTerms::Bend`, :oe:const:`OESz::OEPotentialTerms::StretchBend`,
   :oe:const:`OESz::OEPotentialTerms::Torsion` and 
   :oe:const:`OESz::OEPotentialTerms::ImproperTorsion` 
   correspond to the total MMFF94 or Smirnoff potential terms.
   In the case of partial optimization of the protein, entries with a prefix ``Ligand`` refer to
   the force field terms of the ligand (for example :oe:const:`OESz::OEPotentialTerms::LigandVdW`),
   while entries with a prefix ``Protein`` (for example :oe:const:`OESz::OEPotentialTerms::ProteinVdW`)
   are for the MMFF94 or Smirnoff terms of the flexible part of the protein.
   Force field terms describing VdW and Coulomb interactions between the ligand and the flexible part of 
   the protein are defined with the constants :oe:const:`OESz::OEPotentialTerms::ProteinLigandVdW` 
   and :oe:const:`OESz::OEPotentialTerms::ProteinLigandCoulomb` respectively.
   Term :oe:const:`OESz::OEPotentialTerms::ProteinLigandInteraction` describes complete ligand-protein 
   interaction according to the protein electrostatic model chosen. 
   Values defined by :oe:const:`OESz::OEPotentialTerms::SheffieldSolvation`, 
   :oe:const:`OESz::OEPotentialTerms::PBSolvation` and :oe:const:`OESz::OEPotentialTerms::CavitySolvation`
   refer to solvation energies used to optimize a ligand in solution, while the term
   :oe:const:`OESz::OEPotentialTerms::HarmonicConstraint` determines the he value of the imposed harmonic 
   constraint. Entries: :oe:const:`OESz::OEPotentialTerms::VdWProteinLigand`, 
   :oe:const:`OESz::OEPotentialTerms::CoulombProteinLigand`, 
   :oe:const:`OESz::OEPotentialTerms::ProteinDesolvation`, 
   :oe:const:`OESz::OEPotentialTerms::LigandDesolvation`, :oe:const:`OESz::OEPotentialTerms::SolventScreening`,
   :oe:const:`OESz::OEPotentialTerms::GridCoulomb` and :oe:const:`OESz::OEPotentialTerms::ExactCoulomb` are
   used to break down the total protein-ligand interaction energy into components.
   Value of the :oe:const:`OESz::OEPotentialTerms::ProteinPseudoLigandInteraction` represents 
   the interaction of the flexible part of of the optimized protein-ligand system (ligand + flexible part 
   of the protein) with the rest of the protein and as such is not an observable quantity.
   When Amber force field is applied for protein-ligand interaction, values of 
   :oe:const:`OESz::OEPotentialTerms::ProteinLigandAmberVdW` and 
   :oe:const:`OESz::OEPotentialTerms::ProteinLigandAmberCoulomb` are used for the corresponding vdW and
   Coulomb protein-ligand energies. Term :oe:const:`OESz::OEPotentialTerms::TorsionHarmonicConstraint` 
   is the value of the constraint torsion harmonic potential. Two terms: 
   :oe:const:`OESz::OEPotentialTerms::IEFFInteraction` and :oe:const:`OESz::OEPotentialTerms::InterLigandIEFF`
   are IEFF energies, total and interligand respectively. The latter has nonzero value when more than one 
   ligand are present in the active site of the protein.

   .. oe:constant:: VdW
   
      Value of vdW energy

   .. oe:constant:: Coulomb
   
      Value of Coulomb energy

   .. oe:constant:: Bond
   
      Value of bond stretch energy

   .. oe:constant:: Bend
   
      Value of angle bend energy

   .. oe:constant:: StretchBend
   
      Value of stretch-bend energy. This potential term appears only when MMFF force field is used 

   .. oe:constant:: Torsion
   
      Value of torsion energy

   .. oe:constant:: ImproperTorsion
   
      Value of improper torsion energy

   .. oe:constant:: LigandVdW
   
      Value of ligand vdW energy

   .. oe:constant:: LigandCoulomb
   
      Value of ligand Coulomb energy

   .. oe:constant:: LigandBond
   
      Value of ligand bond energy

   .. oe:constant:: LigandBend
   
      Value of ligand angle bend energy

   .. oe:constant:: LigandStretchBend
   
      Value of ligand stretch-bend energy. This potential term appears only when MMFF force field is used

   .. oe:constant:: LigandTorsion
   
      Value of ligand torsion energy

   .. oe:constant:: LigandImproperTorsion
   
      Value of ligand improper torsion energy

   .. oe:constant:: ProteinVdW
   
      Value of protein vdW energy

   .. oe:constant:: ProteinCoulomb
   
      Value of protein Coulomb energy

   .. oe:constant:: ProteinBond
   
      Value of protein bond energy

   .. oe:constant:: ProteinBend
   
      Value of protein angle bend energy

   .. oe:constant:: ProteinStretchBend
   
      Value of protein stretch-bend energy. This potential term appears only when MMFF force field is used

   .. oe:constant:: ProteinTorsion
   
      Value of protein torsion energy

   .. oe:constant:: ProteinImproperTorsion
   
      Value of protein improper torsion energy

   .. oe:constant:: ProteinLigandVdW
   
      Value of protein-ligand vdW energy

   .. oe:constant:: ProteinLigandCoulomb
   
      Value of protein-ligand Coulomb energy

   .. oe:constant:: ProteinLigandInteraction
   
      Value of total protein-ligand interaction

   .. oe:constant:: SheffieldSolvation
   
      Value of Sheffield solvation energy

   .. oe:constant:: HarmonicConstraint
   
      Value of atom harmonic constraint energy

   .. oe:constant:: PBSolvation
   
      Value of PB solvation energy

   .. oe:constant:: CavitySolvation
   
      Value of cavity solvation energy

   .. oe:constant:: VdWProteinLigand
   
      Value of protein-ligand vdW interaction energy

   .. oe:constant:: CoulombProteinLigand
   
      Value of protein-ligand Coulomb interaction energy

   .. oe:constant:: ProteinDesolvation
   
      Value of protein desolvation energy

   .. oe:constant:: LigandDesolvation
   
      Value of ligand desolvation energy

   .. oe:constant:: SolventScreening
   
      Value of PB solvent screening energy

   .. oe:constant:: GridCoulomb
   
      Value of protein-ligand Coulomb energy on grid

   .. oe:constant:: ExactCoulomb
   
      Value of exact protein-ligand Coulomb energy

   .. oe:constant:: ProteinPseudoLigandInteraction
   
      Value of ligand and flexible protein (pseudoligand) interaction with the rest of the protein energy

   .. oe:constant:: ProteinLigandAmberVdW

      Value of Amber protein-ligand vdW energy

   .. oe:constant:: ProteinLigandAmberCoulomb

      Value of Amber protein-ligand Coulomb energy

   .. oe:constant:: TorsionHarmonicConstraint
   
      Value of torsion harmonic constraint energy

   .. oe:constant:: IEFFInteraction

      Value of total IEFF intermolecular energy

   .. oe:constant:: InterLigandIEFF

      Value of interligand IEFF energy 

   .. oe:constant:: Max
   
      Number of potential terms
