RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
ForceFields::UFF::PositionConstraintContrib Class Reference

A position constraint of the type 0.5k * deltaX^2. More...

#include <PositionConstraint.h>

Inheritance diagram for ForceFields::UFF::PositionConstraintContrib:
ForceFields::ForceFieldContrib

Public Member Functions

 PositionConstraintContrib ()
 
 PositionConstraintContrib (ForceField *owner, unsigned int idx, double maxDispl, double forceConst)
 Constructor. More...
 
 ~PositionConstraintContrib () override=default
 
double getEnergy (double *pos) const override
 returns our contribution to the energy of a position More...
 
void getGrad (double *pos, double *grad) const override
 calculates our contribution to the gradients of a position More...
 
PositionConstraintContribcopy () const override
 return a copy More...
 
- Public Member Functions inherited from ForceFields::ForceFieldContrib
 ForceFieldContrib ()
 
 ForceFieldContrib (ForceFields::ForceField *owner)
 
virtual ~ForceFieldContrib ()
 
virtual double getEnergy (double *pos) const =0
 returns our contribution to the energy of a position More...
 
virtual void getGrad (double *pos, double *grad) const =0
 calculates our contribution to the gradients of a position More...
 
virtual ForceFieldContribcopy () const =0
 return a copy More...
 

Additional Inherited Members

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

Detailed Description

A position constraint of the type 0.5k * deltaX^2.

Definition at line 23 of file UFF/PositionConstraint.h.

Constructor & Destructor Documentation

◆ PositionConstraintContrib() [1/2]

ForceFields::UFF::PositionConstraintContrib::PositionConstraintContrib ( )
inline

Definition at line 26 of file UFF/PositionConstraint.h.

◆ PositionConstraintContrib() [2/2]

ForceFields::UFF::PositionConstraintContrib::PositionConstraintContrib ( ForceField owner,
unsigned int  idx,
double  maxDispl,
double  forceConst 
)

Constructor.

Parameters
ownerpointer to the owning ForceField
idxindex of the atom in the ForceField's positions
minDisplminimum displacement
maxDisplmaximum displacement
forceConstforce constant

◆ ~PositionConstraintContrib()

ForceFields::UFF::PositionConstraintContrib::~PositionConstraintContrib ( )
overridedefault

Member Function Documentation

◆ copy()

PositionConstraintContrib * ForceFields::UFF::PositionConstraintContrib::copy ( ) const
inlineoverridevirtual

return a copy

Implements ForceFields::ForceFieldContrib.

Definition at line 43 of file UFF/PositionConstraint.h.

◆ getEnergy()

double ForceFields::UFF::PositionConstraintContrib::getEnergy ( double *  pos) const
overridevirtual

returns our contribution to the energy of a position

Implements ForceFields::ForceFieldContrib.

◆ getGrad()

void ForceFields::UFF::PositionConstraintContrib::getGrad ( double *  pos,
double *  grad 
) const
overridevirtual

calculates our contribution to the gradients of a position

Implements ForceFields::ForceFieldContrib.


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