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

The angle-bend term for MMFF. More...

#include <AngleBend.h>

Inheritance diagram for ForceFields::MMFF::AngleBendContrib:
ForceFields::ForceFieldContrib

Public Member Functions

 AngleBendContrib ()
 
 AngleBendContrib (ForceField *owner, unsigned int idx1, unsigned int idx2, unsigned int idx3, const MMFFAngle *mmffAngleParams, const MMFFProp *mmffPropParamsCentralAtom)
 Constructor.
 
double getEnergy (double *pos) const override
 returns our contribution to the energy of a position
 
void getGrad (double *pos, double *grad) const override
 calculates our contribution to the gradients of a position
 
AngleBendContribcopy () const override
 return a copy
 
- 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 {nullptr}
 our owning ForceField
 

Detailed Description

The angle-bend term for MMFF.

Definition at line 26 of file MMFF/AngleBend.h.

Constructor & Destructor Documentation

◆ AngleBendContrib() [1/2]

ForceFields::MMFF::AngleBendContrib::AngleBendContrib ( )
inline

Definition at line 28 of file MMFF/AngleBend.h.

◆ AngleBendContrib() [2/2]

ForceFields::MMFF::AngleBendContrib::AngleBendContrib ( ForceField * owner,
unsigned int idx1,
unsigned int idx2,
unsigned int idx3,
const MMFFAngle * mmffAngleParams,
const MMFFProp * mmffPropParamsCentralAtom )

Constructor.

The angle is between atom1 - atom2 - atom3

Parameters
ownerpointer to the owning ForceField
idx1index of atom1 in the ForceField's positions
idx2index of atom2 in the ForceField's positions
idx3index of atom3 in the ForceField's positions
angleTypeMMFF type of the angle (as an unsigned int)

Member Function Documentation

◆ copy()

AngleBendContrib * ForceFields::MMFF::AngleBendContrib::copy ( ) const
inlineoverridevirtual

return a copy

Implements ForceFields::ForceFieldContrib.

Definition at line 45 of file MMFF/AngleBend.h.

◆ getEnergy()

double ForceFields::MMFF::AngleBendContrib::getEnergy ( double * pos) const
overridevirtual

returns our contribution to the energy of a position

Implements ForceFields::ForceFieldContrib.

◆ getGrad()

void ForceFields::MMFF::AngleBendContrib::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: