ForceFields::TorsionConstraintContrib Class Reference

A dihedral angle range constraint modelled after a TorsionContrib. More...

#include <TorsionConstraint.h>

Inheritance diagram for ForceFields::TorsionConstraintContrib:

Public Member Functions
	TorsionConstraintContrib ()
	TorsionConstraintContrib (ForceField *owner, unsigned int idx1, unsigned int idx2, unsigned int idx3, unsigned int idx4, double minDihedralDeg, double maxDihedralDeg, double forceConst)
	Constructor.
	TorsionConstraintContrib (ForceField *owner, unsigned int idx1, unsigned int idx2, unsigned int idx3, unsigned int idx4, bool relative, double minDihedralDeg, double maxDihedralDeg, double forceConst)
	~TorsionConstraintContrib () override=default
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
TorsionConstraintContrib *	copy () 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
ForceField *	dp_forceField {nullptr}
	our owning ForceField

Detailed Description

A dihedral angle range constraint modelled after a TorsionContrib.

Definition at line 20 of file TorsionConstraint.h.

Constructor & Destructor Documentation

TorsionConstraintContrib() [1/3]

ForceFields::TorsionConstraintContrib::TorsionConstraintContrib ( )

inline

Definition at line 23 of file TorsionConstraint.h.

Referenced by copy().

TorsionConstraintContrib() [2/3]

ForceFields::TorsionConstraintContrib::TorsionConstraintContrib	(	ForceField *	owner,
		unsigned int	idx1,
		unsigned int	idx2,
		unsigned int	idx3,
		unsigned int	idx4,
		double	minDihedralDeg,
		double	maxDihedralDeg,
		double	forceConst )

Constructor.

Parameters

owner	pointer to the owning ForceField
idx1	index of atom1 in the ForceField's positions
idx2	index of atom2 in the ForceField's positions
idx3	index of atom3 in the ForceField's positions
idx4	index of atom4 in the ForceField's positions
minDihedralDeg	minimum dihedral angle
maxDihedralDeg	maximum dihedral angle
forceConst	force Constant

References ForceFields::ForceFieldContrib::ForceField.

TorsionConstraintContrib() [3/3]

ForceFields::TorsionConstraintContrib::TorsionConstraintContrib	(	ForceField *	owner,
		unsigned int	idx1,
		unsigned int	idx2,
		unsigned int	idx3,
		unsigned int	idx4,
		bool	relative,
		double	minDihedralDeg,
		double	maxDihedralDeg,
		double	forceConst )

References ForceFields::ForceFieldContrib::ForceField.

~TorsionConstraintContrib()

ForceFields::TorsionConstraintContrib::~TorsionConstraintContrib ( )

overridedefault

Member Function Documentation

copy()

TorsionConstraintContrib * ForceFields::TorsionConstraintContrib::copy ( ) const

inlineoverridevirtual

return a copy

Implements ForceFields::ForceFieldContrib.

Definition at line 50 of file TorsionConstraint.h.

References TorsionConstraintContrib().

getEnergy()

double ForceFields::TorsionConstraintContrib::getEnergy ( double * pos ) const

overridevirtual

returns our contribution to the energy of a position

Implements ForceFields::ForceFieldContrib.

getGrad()

void ForceFields::TorsionConstraintContrib::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:

• TorsionConstraint.h