Files
rdkit/Code/ForceField/MMFF/TorsionAngle.cpp
Kevin Boyd af6347963f Condense MMFF Contribs into single contrib per type. (#8175)
* Condense MMFF electrostatics and contrib instances.

Previously, a separate contrib had been added for each common term.
Each of these required a separate allocation, and a separate dynamic dispatch
on call. This change moves to an SOA style, making data access contiguous and
drastically reducing the number of calls.

* Make suggested copyright fixes and svn artifact removals
2025-01-29 06:18:09 +01:00

189 lines
7.0 KiB
C++

//
// Copyright (C) 2013-2025 Paolo Tosco and other RDKit contributors
//
// @@ All Rights Reserved @@
// This file is part of the RDKit.
// The contents are covered by the terms of the BSD license
// which is included in the file license.txt, found at the root
// of the RDKit source tree.
//
#include "TorsionAngle.h"
#include "Params.h"
#include <cmath>
#include <ForceField/ForceField.h>
#include <RDGeneral/Invariant.h>
namespace ForceFields {
namespace MMFF {
namespace Utils {
double calcTorsionCosPhi(const RDGeom::Point3D &iPoint,
const RDGeom::Point3D &jPoint,
const RDGeom::Point3D &kPoint,
const RDGeom::Point3D &lPoint) {
RDGeom::Point3D r1 = iPoint - jPoint;
RDGeom::Point3D r2 = kPoint - jPoint;
RDGeom::Point3D r3 = jPoint - kPoint;
RDGeom::Point3D r4 = lPoint - kPoint;
RDGeom::Point3D t1 = r1.crossProduct(r2);
RDGeom::Point3D t2 = r3.crossProduct(r4);
auto t1_len = t1.length();
auto t2_len = t2.length();
if (isDoubleZero(t1_len) || isDoubleZero(t2_len)) {
return 0.0;
}
double cosPhi = t1.dotProduct(t2) / (t1_len * t2_len);
clipToOne(cosPhi);
return cosPhi;
}
std::tuple<double, double, double> calcTorsionForceConstant(
const MMFFTor *mmffTorParams) {
return std::make_tuple(mmffTorParams->V1, mmffTorParams->V2,
mmffTorParams->V3);
}
double calcTorsionEnergy(const double V1, const double V2, const double V3,
const double cosPhi) {
double cos2Phi = 2.0 * cosPhi * cosPhi - 1.0;
double cos3Phi = cosPhi * (2.0 * cos2Phi - 1.0);
return (0.5 *
(V1 * (1.0 + cosPhi) + V2 * (1.0 - cos2Phi) + V3 * (1.0 + cos3Phi)));
}
void calcTorsionGrad(RDGeom::Point3D *r, RDGeom::Point3D *t, double *d,
double **g, double &sinTerm, double &cosPhi) {
// -------
// dTheta/dx is trickier:
double dCos_dT[6] = {1.0 / d[0] * (t[1].x - cosPhi * t[0].x),
1.0 / d[0] * (t[1].y - cosPhi * t[0].y),
1.0 / d[0] * (t[1].z - cosPhi * t[0].z),
1.0 / d[1] * (t[0].x - cosPhi * t[1].x),
1.0 / d[1] * (t[0].y - cosPhi * t[1].y),
1.0 / d[1] * (t[0].z - cosPhi * t[1].z)};
g[0][0] += sinTerm * (dCos_dT[2] * r[1].y - dCos_dT[1] * r[1].z);
g[0][1] += sinTerm * (dCos_dT[0] * r[1].z - dCos_dT[2] * r[1].x);
g[0][2] += sinTerm * (dCos_dT[1] * r[1].x - dCos_dT[0] * r[1].y);
g[1][0] += sinTerm *
(dCos_dT[1] * (r[1].z - r[0].z) + dCos_dT[2] * (r[0].y - r[1].y) +
dCos_dT[4] * (-r[3].z) + dCos_dT[5] * (r[3].y));
g[1][1] += sinTerm *
(dCos_dT[0] * (r[0].z - r[1].z) + dCos_dT[2] * (r[1].x - r[0].x) +
dCos_dT[3] * (r[3].z) + dCos_dT[5] * (-r[3].x));
g[1][2] += sinTerm *
(dCos_dT[0] * (r[1].y - r[0].y) + dCos_dT[1] * (r[0].x - r[1].x) +
dCos_dT[3] * (-r[3].y) + dCos_dT[4] * (r[3].x));
g[2][0] += sinTerm *
(dCos_dT[1] * (r[0].z) + dCos_dT[2] * (-r[0].y) +
dCos_dT[4] * (r[3].z - r[2].z) + dCos_dT[5] * (r[2].y - r[3].y));
g[2][1] += sinTerm *
(dCos_dT[0] * (-r[0].z) + dCos_dT[2] * (r[0].x) +
dCos_dT[3] * (r[2].z - r[3].z) + dCos_dT[5] * (r[3].x - r[2].x));
g[2][2] += sinTerm *
(dCos_dT[0] * (r[0].y) + dCos_dT[1] * (-r[0].x) +
dCos_dT[3] * (r[3].y - r[2].y) + dCos_dT[4] * (r[2].x - r[3].x));
g[3][0] += sinTerm * (dCos_dT[4] * r[2].z - dCos_dT[5] * r[2].y);
g[3][1] += sinTerm * (dCos_dT[5] * r[2].x - dCos_dT[3] * r[2].z);
g[3][2] += sinTerm * (dCos_dT[3] * r[2].y - dCos_dT[4] * r[2].x);
}
} // namespace Utils
TorsionAngleContrib::TorsionAngleContrib(ForceField *owner) {
PRECONDITION(owner, "bad owner");
dp_forceField = owner;
}
void TorsionAngleContrib::addTerm(
unsigned int idx1, unsigned int idx2, unsigned int idx3, unsigned int idx4,
const ForceFields::MMFF::MMFFTor *mmffTorParams) {
PRECONDITION((idx1 != idx2) && (idx1 != idx3) && (idx1 != idx4) &&
(idx2 != idx3) && (idx2 != idx4) && (idx3 != idx4),
"degenerate points");
URANGE_CHECK(idx1, dp_forceField->positions().size());
URANGE_CHECK(idx2, dp_forceField->positions().size());
URANGE_CHECK(idx3, dp_forceField->positions().size());
URANGE_CHECK(idx4, dp_forceField->positions().size());
d_at1Idx.push_back(idx1);
d_at2Idx.push_back(idx2);
d_at3Idx.push_back(idx3);
d_at4Idx.push_back(idx4);
d_V1.push_back(mmffTorParams->V1);
d_V2.push_back(mmffTorParams->V2);
d_V3.push_back(mmffTorParams->V3);
}
double TorsionAngleContrib::getEnergy(double *pos) const {
PRECONDITION(dp_forceField, "no owner");
PRECONDITION(pos, "bad vector");
const int numTorsions = d_at1Idx.size();
double totalEnergy = 0.0;
for (int i = 0; i < numTorsions; ++i) {
const int16_t at1Idx = d_at1Idx[i];
const int16_t at2Idx = d_at2Idx[i];
const int16_t at3Idx = d_at3Idx[i];
const int16_t at4Idx = d_at4Idx[i];
RDGeom::Point3D iPoint(pos[3 * at1Idx], pos[3 * at1Idx + 1],
pos[3 * at1Idx + 2]);
RDGeom::Point3D jPoint(pos[3 * at2Idx], pos[3 * at2Idx + 1],
pos[3 * at2Idx + 2]);
RDGeom::Point3D kPoint(pos[3 * at3Idx], pos[3 * at3Idx + 1],
pos[3 * at3Idx + 2]);
RDGeom::Point3D lPoint(pos[3 * at4Idx], pos[3 * at4Idx + 1],
pos[3 * at4Idx + 2]);
totalEnergy += Utils::calcTorsionEnergy(
d_V1[i], d_V2[i], d_V3[i],
Utils::calcTorsionCosPhi(iPoint, jPoint, kPoint, lPoint));
}
return totalEnergy;
}
void TorsionAngleContrib::getGrad(double *pos, double *grad) const {
PRECONDITION(dp_forceField, "no owner");
PRECONDITION(pos, "bad vector");
PRECONDITION(grad, "bad vector");
double d[2];
double cosPhi;
const int numTorsions = d_at1Idx.size();
for (int i = 0; i < numTorsions; ++i) {
const int16_t at1Idx = d_at1Idx[i];
const int16_t at2Idx = d_at2Idx[i];
const int16_t at3Idx = d_at3Idx[i];
const int16_t at4Idx = d_at4Idx[i];
double *g[4] = {&(grad[3 * at1Idx]), &(grad[3 * at2Idx]),
&(grad[3 * at3Idx]), &(grad[3 * at4Idx])};
RDGeom::Point3D r[4];
RDGeom::Point3D t[2];
RDKit::ForceFieldsHelper::computeDihedral(
pos, at1Idx, at2Idx, at3Idx, at4Idx, nullptr, &cosPhi, r, t, d);
double sinPhiSq = 1.0 - cosPhi * cosPhi;
double sinPhi = ((sinPhiSq > 0.0) ? sqrt(sinPhiSq) : 0.0);
double sin2Phi = 2.0 * sinPhi * cosPhi;
double sin3Phi = 3.0 * sinPhi - 4.0 * sinPhi * sinPhiSq;
// dE/dPhi is independent of cartesians:
double dE_dPhi = 0.5 * (-(d_V1[i]) * sinPhi + 2.0 * d_V2[i] * sin2Phi -
3.0 * d_V3[i] * sin3Phi);
// FIX: use a tolerance here
// this is hacky, but it's per the
// recommendation from Niketic and Rasmussen:
double sinTerm =
-dE_dPhi * (isDoubleZero(sinPhi) ? (1.0 / cosPhi) : (1.0 / sinPhi));
Utils::calcTorsionGrad(r, t, d, g, sinTerm, cosPhi);
}
}
} // namespace MMFF
} // namespace ForceFields