Package rdkit :: Package Chem :: Module rdForceFieldHelpers
[hide private]
[frames] | no frames]

Module rdForceFieldHelpers

Module containing functions to handle MMFF force field

Functions [hide private]
 
MMFFGetMoleculeForceField(...)
MMFFGetMoleculeForceField( (Mol)mol, (object)pyMMFFMolProperties [, (float)nonBondedThresh=100.0 [, (int)confId=-1 [, (bool)ignoreInterfragInteractions=True]]]) -> object : returns a MMFF force field for a molecule
 
MMFFGetMoleculeProperties(...)
MMFFGetMoleculeProperties( (Mol)mol [, (str)mmffVariant='MMFF94' [, (int)mmffVerbosity=0]]) -> object : returns a PyMMFFMolProperties object for a molecule, which is required by MMFFGetMoleculeForceField() and can be used to get/set MMFF properties
 
MMFFHasAllMoleculeParams(...)
MMFFHasAllMoleculeParams( (Mol)mol) -> bool : checks if MMFF parameters are available for all of a molecule's atoms
 
MMFFOptimizeMolecule(...)
MMFFOptimizeMolecule( (Mol)mol [, (str)mmffVariant='MMFF94' [, (int)maxIters=200 [, (float)nonBondedThresh=100.0 [, (int)confId=-1 [, (bool)ignoreInterfragInteractions=True]]]]]) -> int : uses MMFF to optimize a molecule's structure
 
MMFFSanitizeMolecule(...)
MMFFSanitizeMolecule( (Mol)mol) -> int : sanitizes a molecule according to MMFF requirements.
 
UFFGetMoleculeForceField(...)
UFFGetMoleculeForceField( (Mol)mol [, (float)vdwThresh=10.0 [, (int)confId=-1 [, (bool)ignoreInterfragInteractions=True]]]) -> object : returns a UFF force field for a molecule
 
UFFHasAllMoleculeParams(...)
UFFHasAllMoleculeParams( (Mol)mol) -> bool : checks if UFF parameters are available for all of a molecule's atoms
 
UFFOptimizeMolecule(...)
UFFOptimizeMolecule( (Mol)self [, (int)maxIters=200 [, (float)vdwThresh=10.0 [, (int)confId=-1 [, (bool)ignoreInterfragInteractions=True]]]]) -> int : uses UFF to optimize a molecule's structure
Variables [hide private]
  __package__ = None
hash(x)
Function Details [hide private]

MMFFGetMoleculeForceField(...)

 

MMFFGetMoleculeForceField( (Mol)mol, (object)pyMMFFMolProperties [, (float)nonBondedThresh=100.0 [, (int)confId=-1 [, (bool)ignoreInterfragInteractions=True]]]) -> object :
    returns a MMFF force field for a molecule
    
     
     ARGUMENTS:
    
        - mol : the molecule of interest
        - pyMMFFMolProperties : PyMMFFMolProperties object as returned
                      by MMFFGetMoleculeProperties()
        - nonBondedThresh : used to exclude long-range non-bonded
                      interactions (defaults to 100.0)
        - confId : indicates which conformer to optimize
        - ignoreInterfragInteractions : if true, nonbonded terms between
                      fragments will not be added to the forcefield
    
    

    C++ signature :
        ForceFields::PyForceField* MMFFGetMoleculeForceField(RDKit::ROMol {lvalue},ForceFields::PyMMFFMolProperties* [,double=100.0 [,int=-1 [,bool=True]]])

MMFFGetMoleculeProperties(...)

 

MMFFGetMoleculeProperties( (Mol)mol [, (str)mmffVariant='MMFF94' [, (int)mmffVerbosity=0]]) -> object :
    returns a PyMMFFMolProperties object for a
      molecule, which is required by MMFFGetMoleculeForceField()
      and can be used to get/set MMFF properties
    
      
      ARGUMENTS:
    
        - mol : the molecule of interest
        - mmffVariant : "MMFF94" or "MMFF94s"
                      (defaults to "MMFF94")
        - mmffVerbosity : 0: none; 1: low; 2: high (defaults to 0).
    
    

    C++ signature :
        ForceFields::PyMMFFMolProperties* MMFFGetMoleculeProperties(RDKit::ROMol {lvalue} [,std::string='MMFF94' [,unsigned int=0]])

MMFFHasAllMoleculeParams(...)

 

MMFFHasAllMoleculeParams( (Mol)mol) -> bool :
    checks if MMFF parameters are available for all of a molecule's atoms
    
     
     ARGUMENTS:
    
        - mol : the molecule of interest
    
    

    C++ signature :
        bool MMFFHasAllMoleculeParams(RDKit::ROMol {lvalue})

MMFFOptimizeMolecule(...)

 

MMFFOptimizeMolecule( (Mol)mol [, (str)mmffVariant='MMFF94' [, (int)maxIters=200 [, (float)nonBondedThresh=100.0 [, (int)confId=-1 [, (bool)ignoreInterfragInteractions=True]]]]]) -> int :
    uses MMFF to optimize a molecule's structure
    
     
     ARGUMENTS:
    
        - mol : the molecule of interest
        - mmffVariant : "MMFF94" or "MMFF94s"
        - maxIters : the maximum number of iterations (defaults to 200)
        - nonBondedThresh : used to exclude long-range non-bonded
                     interactions (defaults to 100.0)
        - confId : indicates which conformer to optimize
        - ignoreInterfragInteractions : if true, nonbonded terms between
                     fragments will not be added to the forcefield
    
     RETURNS: 0 if the optimization converged, -1 if the forcefield could
              not be set up, 1 if more iterations are required.
    
    

    C++ signature :
        int MMFFOptimizeMolecule(RDKit::ROMol {lvalue} [,std::string='MMFF94' [,int=200 [,double=100.0 [,int=-1 [,bool=True]]]]])

MMFFSanitizeMolecule(...)

 

MMFFSanitizeMolecule( (Mol)mol) -> int :
    sanitizes a molecule according to MMFF requirements.
    
        - mol : the molecule of interest.
    
    

    C++ signature :
        unsigned int MMFFSanitizeMolecule(RDKit::ROMol {lvalue})

UFFGetMoleculeForceField(...)

 

UFFGetMoleculeForceField( (Mol)mol [, (float)vdwThresh=10.0 [, (int)confId=-1 [, (bool)ignoreInterfragInteractions=True]]]) -> object :
    returns a UFF force field for a molecule
    
     
     ARGUMENTS:
    
        - mol : the molecule of interest
        - vdwThresh : used to exclude long-range van der Waals interactions
                      (defaults to 10.0)
        - confId : indicates which conformer to optimize
        - ignoreInterfragInteractions : if true, nonbonded terms between
                      fragments will not be added to the forcefield.
    
    

    C++ signature :
        ForceFields::PyForceField* UFFGetMoleculeForceField(RDKit::ROMol {lvalue} [,double=10.0 [,int=-1 [,bool=True]]])

UFFHasAllMoleculeParams(...)

 

UFFHasAllMoleculeParams( (Mol)mol) -> bool :
    checks if UFF parameters are available for all of a molecule's atoms
    
     
     ARGUMENTS:
    
        - mol : the molecule of interest.
    
    

    C++ signature :
        bool UFFHasAllMoleculeParams(RDKit::ROMol)

UFFOptimizeMolecule(...)

 

UFFOptimizeMolecule( (Mol)self [, (int)maxIters=200 [, (float)vdwThresh=10.0 [, (int)confId=-1 [, (bool)ignoreInterfragInteractions=True]]]]) -> int :
    uses UFF to optimize a molecule's structure
    
     
     ARGUMENTS:
    
        - mol : the molecule of interest
        - maxIters : the maximum number of iterations (defaults to 200)
        - vdwThresh : used to exclude long-range van der Waals interactions
                      (defaults to 10.0)
        - confId : indicates which conformer to optimize
        - ignoreInterfragInteractions : if true, nonbonded terms between
                      fragments will not be added to the forcefield.
    
     RETURNS: 0 if the optimization converged, 1 if more iterations are required.
    
    

    C++ signature :
        int UFFOptimizeMolecule(RDKit::ROMol {lvalue} [,int=200 [,double=10.0 [,int=-1 [,bool=True]]]])