1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
//
// Copyright (C) 2024 Greg Landrum 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 <RDGeneral/export.h>
#ifndef RD_FOURTHDIMCONTRIBS_H
#define RD_FOURTHDIMCONTRIBS_H
#include <vector>
#include <RDGeneral/Invariant.h>
#include <ForceField/Contrib.h>
#include <ForceField/ForceField.h>
namespace DistGeom {
struct FourthDimContribsParams {
unsigned int idx{0};
double weight{0.0};
FourthDimContribsParams(unsigned int idx, double w) : idx(idx), weight(w) {};
};
//! A term used in penalizing the 4th dimension in order to move from 4D->3D
//!
class RDKIT_DISTGEOMETRY_EXPORT FourthDimContribs
: public ForceFields::ForceFieldContrib {
public:
FourthDimContribs() = default;
//! Constructor
/*!
\param owner pointer to the owning ForceField
\param idx the index of the atom to be considered
\param weight (optional) the weight to be used for this contrib
*/
FourthDimContribs(ForceFields::ForceField *owner) {
PRECONDITION(owner, "bad force field");
PRECONDITION(owner->dimension() == 4, "force field has wrong dimension");
dp_forceField = owner;
}
void addContrib(unsigned int idx, double weight) {
d_contribs.emplace_back(idx, weight);
}
//! return the contribution of this contrib to the energy of a given state
double getEnergy(double *pos) const override {
PRECONDITION(pos, "bad vector");
constexpr unsigned int ffdim = 4;
double res = 0.0;
for (const auto &contrib : d_contribs) {
unsigned int pid = contrib.idx * ffdim + 3;
res += contrib.weight * pos[pid] * pos[pid];
}
return res;
}
//! calculate the contribution of this contrib to the gradient at a given
/// state
void getGrad(double *pos, double *grad) const override {
PRECONDITION(pos, "bad vector");
constexpr unsigned int ffdim = 4;
for (const auto &contrib : d_contribs) {
unsigned int pid = contrib.idx * ffdim + 3;
grad[pid] += contrib.weight * pos[pid];
}
}
FourthDimContribs *copy() const override {
return new FourthDimContribs(*this);
}
bool empty() const { return d_contribs.empty(); }
unsigned int size() const { return d_contribs.size(); }
private:
std::vector<FourthDimContribsParams> d_contribs;
};
} // namespace DistGeom
#endif
|
