RDKit
Open-source cheminformatics and machine learning.
ForceFields::MMFF::DistanceConstraintContrib Class Reference

A distance range constraint modelled after a BondStretchContrib. More...

#include <DistanceConstraint.h>

Inheritance diagram for ForceFields::MMFF::DistanceConstraintContrib:
ForceFields::ForceFieldContrib

Public Member Functions

 DistanceConstraintContrib ()
 
 DistanceConstraintContrib (ForceField *owner, unsigned int idx1, unsigned int idx2, double minLen, double maxLen, double forceConst)
 Constructor. More...
 
 DistanceConstraintContrib (ForceField *owner, unsigned int idx1, unsigned int idx2, bool relative, double minLen, double maxLen, double forceConst)
 
 ~DistanceConstraintContrib ()
 
double getEnergy (double *pos) const
 returns our contribution to the energy of a position More...
 
void getGrad (double *pos, double *grad) const
 calculates our contribution to the gradients of a position More...
 
virtual DistanceConstraintContribcopy () const
 return a copy More...
 
- Public Member Functions inherited from ForceFields::ForceFieldContrib
 ForceFieldContrib ()
 
 ForceFieldContrib (ForceFields::ForceField *owner)
 
virtual ~ForceFieldContrib ()
 

Additional Inherited Members

- Protected Attributes inherited from ForceFields::ForceFieldContrib
ForceFielddp_forceField
 our owning ForceField More...
 

Detailed Description

A distance range constraint modelled after a BondStretchContrib.

Definition at line 21 of file MMFF/DistanceConstraint.h.

Constructor & Destructor Documentation

ForceFields::MMFF::DistanceConstraintContrib::DistanceConstraintContrib ( )
inline

Definition at line 23 of file MMFF/DistanceConstraint.h.

Referenced by copy().

ForceFields::MMFF::DistanceConstraintContrib::DistanceConstraintContrib ( ForceField owner,
unsigned int  idx1,
unsigned int  idx2,
double  minLen,
double  maxLen,
double  forceConst 
)

Constructor.

Parameters
ownerpointer to the owning ForceField
idx1index of end1 in the ForceField's positions
idx2index of end2 in the ForceField's positions
minLenminimum distance
maxLenmaximum distance
forceConstforce Constant
ForceFields::MMFF::DistanceConstraintContrib::DistanceConstraintContrib ( ForceField owner,
unsigned int  idx1,
unsigned int  idx2,
bool  relative,
double  minLen,
double  maxLen,
double  forceConst 
)
ForceFields::MMFF::DistanceConstraintContrib::~DistanceConstraintContrib ( )
inline

Definition at line 41 of file MMFF/DistanceConstraint.h.

References getEnergy(), and getGrad().

Member Function Documentation

virtual DistanceConstraintContrib* ForceFields::MMFF::DistanceConstraintContrib::copy ( ) const
inlinevirtual

return a copy

Implements ForceFields::ForceFieldContrib.

Definition at line 48 of file MMFF/DistanceConstraint.h.

References DistanceConstraintContrib().

double ForceFields::MMFF::DistanceConstraintContrib::getEnergy ( double *  pos) const
virtual

returns our contribution to the energy of a position

Implements ForceFields::ForceFieldContrib.

Referenced by ~DistanceConstraintContrib().

void ForceFields::MMFF::DistanceConstraintContrib::getGrad ( double *  pos,
double *  grad 
) const
virtual

calculates our contribution to the gradients of a position

Implements ForceFields::ForceFieldContrib.

Referenced by ~DistanceConstraintContrib().


The documentation for this class was generated from the following file: