Loading...
Searching...
No Matches
eonc::MinModeObjectiveFunction Class Reference
Inheritance diagram for eonc::MinModeObjectiveFunction:

Public Member Functions

 MinModeObjectiveFunction (std::shared_ptr< Matter > matterPassed, std::shared_ptr< EigenmodeStrategy > minModeMethodPassed, AtomMatrix modePassed, double reactantEnergyPassed, const Parameters &paramsPassed)
 ~MinModeObjectiveFunction () override=default
std::optional< double > knownCurvature () const override
bool gradientMatchesEnergy () const override
void evaluateCentre ()
bool pastClimbCeiling () override
VectorXd getGradient (bool fdstep=false)
double getEnergy ()
void setPositions (const VectorXd &x)
VectorXd getPositions ()
int degreesOfFreedom ()
bool isConverged ()
double getConvergence ()
VectorXd difference (const VectorXd &a, const VectorXd &b)
void reseedMode (const AtomMatrix &seed)
Public Member Functions inherited from eonc::ObjectiveFunction
 ObjectiveFunction (const Parameters &paramsPassed)
virtual ~ObjectiveFunction ()
virtual bool supportsFiniteDifferenceCurvature () const
virtual bool reuseDisplacementCurvature () const
virtual void minimumImage (Eigen::Ref< Eigen::Vector3d >) const
virtual VectorXd getMasses () const
virtual bool getPeriodic () const

Private Attributes

std::shared_ptr< Matter > matter
AtomMatrix eigenvector
std::shared_ptr< EigenmodeStrategy > minModeMethod
int iteration {0}
double reactantEnergy {0.0}

Additional Inherited Members

Protected Attributes inherited from eonc::ObjectiveFunction
const Parameters & params

Detailed Description

Definition at line 87 of file MinModeSaddleSearch.cpp.

Constructor & Destructor Documentation

◆ MinModeObjectiveFunction()

eonc::MinModeObjectiveFunction::MinModeObjectiveFunction ( std::shared_ptr< Matter > matterPassed,
std::shared_ptr< EigenmodeStrategy > minModeMethodPassed,
AtomMatrix modePassed,
double reactantEnergyPassed,
const Parameters & paramsPassed )
inline

Definition at line 96 of file MinModeSaddleSearch.cpp.

101 : ObjectiveFunction(paramsPassed),
102 matter{std::move(matterPassed)},
103 eigenvector{std::move(modePassed)},
104 minModeMethod{minModeMethodPassed},
105 reactantEnergy{reactantEnergyPassed} {}
std::shared_ptr< EigenmodeStrategy > minModeMethod
std::shared_ptr< Matter > matter
ObjectiveFunction(const Parameters &paramsPassed)

◆ ~MinModeObjectiveFunction()

eonc::MinModeObjectiveFunction::~MinModeObjectiveFunction ( )
overridedefault

Member Function Documentation

◆ degreesOfFreedom()

int eonc::MinModeObjectiveFunction::degreesOfFreedom ( )
inlinevirtual

Implements eonc::ObjectiveFunction.

Definition at line 281 of file MinModeSaddleSearch.cpp.

281{ return 3 * matter->numberOfAtoms(); }

◆ difference()

VectorXd eonc::MinModeObjectiveFunction::difference ( const VectorXd & a,
const VectorXd & b )
inlinevirtual

Implements eonc::ObjectiveFunction.

Definition at line 304 of file MinModeSaddleSearch.cpp.

304 {
305 return matter->pbcV(a - b);
306 }

◆ evaluateCentre()

void eonc::MinModeObjectiveFunction::evaluateCentre ( )
inline

Definition at line 148 of file MinModeSaddleSearch.cpp.

148 {
149 if (matter->needsForceUpdate()) {
150 minModeMethod->evaluateWithProbe(matter, eigenvector);
151 }
152 }

◆ getConvergence()

double eonc::MinModeObjectiveFunction::getConvergence ( )
inlinevirtual

Implements eonc::ObjectiveFunction.

Definition at line 286 of file MinModeSaddleSearch.cpp.

286 {
288 if (params.optimizer_options().convergence_metric == "norm") {
289 return matter->getForcesFreeV().norm();
290 } else if (params.optimizer_options().convergence_metric == "max_atom") {
291 return matter->maxForce();
292 } else if (params.optimizer_options().convergence_metric ==
293 "max_component") {
294 return matter->getForces().cwiseAbs().maxCoeff();
295 } else {
296 EONC_LOG_CRITICAL("[MinModeSaddleSearch] unknown convergence metric: {}",
297 params.optimizer_options().convergence_metric);
298 throw std::invalid_argument(
299 std::format("[MinModeSaddleSearch] unknown convergence_metric: {}",
300 params.optimizer_options().convergence_metric));
301 }
302 }
#define EONC_LOG_CRITICAL(...)
Definition EonLogger.h:334
const Parameters & params

◆ getEnergy()

double eonc::MinModeObjectiveFunction::getEnergy ( )
inlinevirtual

Implements eonc::ObjectiveFunction.

Definition at line 278 of file MinModeSaddleSearch.cpp.

278{ return matter->getPotentialEnergy(); }

◆ getGradient()

VectorXd eonc::MinModeObjectiveFunction::getGradient ( bool fdstep = false)
inlinevirtual

Implements eonc::ObjectiveFunction.

Definition at line 163 of file MinModeSaddleSearch.cpp.

163 {
164 if (!fdstep || iteration == 0) {
166 }
167 AtomMatrix force = matter->getForces();
168
169 if (!fdstep || iteration == 0) {
171 // Check if ImprovedDimer lost the mode
172 auto *dimer = eonc::asImprovedDimer(*minModeMethod);
173 if (dimer && !dimer->rotationDidConverge) {
174 if (dimer->getEigenvalue() < 0.0) {
177 "[MinMode] Dimer restored to best state with C_tau={:.4f}",
178 dimer->getEigenvalue());
179 throw eonc::DimerModeRestoredException();
180 } else {
181 throw eonc::DimerModeLostException();
182 }
183 }
184 iteration++;
185 }
186
188 double eigenvalue = eonc::eigenmodeGetEigenvalue(*minModeMethod);
189 // OCI-NEB returns a positive-curvature image to the band before
190 // translating it away from the current path.
191 if (eigenvalue > 0.0 &&
192 params.neb_options().climbing_image.ocineb.use_mmf) {
193 throw eonc::DimerModeLostException();
194 }
195
196 AtomMatrix proj = matDot(force, eigenvector) *
197 eonc::safemath::safe_normalized(eigenvector);
198
199 if (eigenvalue > 0.0) {
200 if (params.saddle_search_options().perp_force_ratio > 0.0) {
201 double d = params.saddle_search_options().perp_force_ratio;
202 force = d * force - (1.0 + d) * proj;
203 } else if (params.saddle_search_options().confine_positive.enabled) {
204 if (params.saddle_search_options().confine_positive.bowl_breakout) {
205 AtomMatrix forceTemp = matter->getForces();
206 const long nAtoms = matter->numberOfAtoms();
207 int nBowlActive = static_cast<int>(std::min<long>(
208 params.saddle_search_options().confine_positive.bowl_active,
209 nAtoms));
210 if (nBowlActive <= 0) {
211 force.setZero();
212 } else {
213 std::vector<int> indices_max(nBowlActive);
214
215 // Find the nBowlActive atoms with largest forces
216 for (int j = 0; j < nBowlActive; j++) {
217 double f_max = forceTemp.row(0).norm();
218 int i_max = 0;
219 for (long i = 0; i < matter->numberOfAtoms(); i++) {
220 if (f_max < forceTemp.row(i).norm()) {
221 f_max = forceTemp.row(i).norm();
222 i_max = static_cast<int>(i);
223 }
224 }
225 forceTemp.row(i_max).setZero();
226 indices_max[j] = i_max;
227 }
228 forceTemp.setZero();
229 for (int j = 0; j < nBowlActive; j++) {
230 forceTemp.row(indices_max[j]) = -proj.row(indices_max[j]);
231 }
232 force = forceTemp;
233 }
234 } else {
235 int sufficientForce = 0;
236 double minForce =
237 params.saddle_search_options().confine_positive.min_force;
238 const long maxBoostTries = std::max(
239 3 * matter->numberOfAtoms(),
240 params.saddle_search_options().confine_positive.min_active);
241 long boostTries = 0;
242 while (
243 sufficientForce <
244 params.saddle_search_options().confine_positive.min_active &&
245 boostTries < maxBoostTries) {
246 sufficientForce = 0;
247 force = matter->getForces();
248 for (long i = 0; i < matter->numberOfAtoms(); i++) {
249 for (int k = 0; k < 3; k++) {
250 if (std::abs(force(i, k)) < minForce) {
251 force(i, k) = 0;
252 } else {
253 sufficientForce++;
254 force(i, k) =
255 -params.saddle_search_options().confine_positive.boost *
256 proj(i, k);
257 }
258 }
259 }
260 minForce *=
261 params.saddle_search_options().confine_positive.scale_ratio;
262 boostTries++;
263 }
264 }
265 } else {
266 force = -proj;
267 }
268 } else {
269 force += -2.0 * proj;
270 }
271
272 VectorXd forceV = VectorXd::Map(force.data(), 3 * matter->numberOfAtoms());
273 return -forceV;
274 }
double matDot(const AtomMatrix &a, const AtomMatrix &b)
SIMD-optimized dot product for contiguous Eigen matrices.
Definition Eigen.h:50
Eigen::Matrix< double, Eigen::Dynamic, 3, eOnStorageOrder > AtomMatrix
Definition Eigen.h:37
#define EONC_LOG_DEBUG(...)
Definition EonLogger.h:310
void eigenmodeCompute(LowestEigenmode &s, std::shared_ptr< Matter > matter, AtomMatrix direction)
ImprovedDimer * asImprovedDimer(LowestEigenmode &s)
double eigenmodeGetEigenvalue(LowestEigenmode &s)
AtomMatrix eigenmodeGetEigenvector(LowestEigenmode &s)

◆ getPositions()

VectorXd eonc::MinModeObjectiveFunction::getPositions ( )
inlinevirtual

Implements eonc::ObjectiveFunction.

Definition at line 280 of file MinModeSaddleSearch.cpp.

280{ return matter->getPositionsV(); }

◆ gradientMatchesEnergy()

bool eonc::MinModeObjectiveFunction::gradientMatchesEnergy ( ) const
inlineoverridevirtual

Reimplemented from eonc::ObjectiveFunction.

Definition at line 141 of file MinModeSaddleSearch.cpp.

141{ return false; }

◆ isConverged()

bool eonc::MinModeObjectiveFunction::isConverged ( )
inlinevirtual

Implements eonc::ObjectiveFunction.

Definition at line 282 of file MinModeSaddleSearch.cpp.

282 {
283 return getConvergence() < params.saddle_search_options().converged_force;
284 }

◆ knownCurvature()

std::optional< double > eonc::MinModeObjectiveFunction::knownCurvature ( ) const
inlineoverridevirtual

Reimplemented from eonc::ObjectiveFunction.

Definition at line 123 of file MinModeSaddleSearch.cpp.

123 {
124 if (iteration == 0 || !minModeMethod) {
125 return std::nullopt;
126 }
127 if (params.saddle_search_options().minmode_method !=
129 params.dimer_options().improved) {
130 return std::nullopt;
131 }
133 if (!std::isfinite(c) || c >= 0.0) {
134 return std::nullopt;
135 }
136 return -c;
137 }
static const char MINMODE_DIMER[]

◆ pastClimbCeiling()

bool eonc::MinModeObjectiveFunction::pastClimbCeiling ( )
inlineoverridevirtual

Reimplemented from eonc::ObjectiveFunction.

Definition at line 157 of file MinModeSaddleSearch.cpp.

157 {
159 return getEnergy() - reactantEnergy >
160 params.saddle_search_options().max_energy;
161 }

◆ reseedMode()

void eonc::MinModeObjectiveFunction::reseedMode ( const AtomMatrix & seed)
inline

Definition at line 311 of file MinModeSaddleSearch.cpp.

311 {
312 eigenvector = seed;
313 if (auto *dimer = eonc::asImprovedDimer(*minModeMethod)) {
314 dimer->init_cg = true;
315 dimer->init_lbfgs = true;
316 dimer->s.clear();
317 dimer->y.clear();
318 dimer->rho.clear();
319 dimer->gradients.clear();
320 dimer->positions.clear();
321 }
322 }

◆ setPositions()

void eonc::MinModeObjectiveFunction::setPositions ( const VectorXd & x)
inlinevirtual

Implements eonc::ObjectiveFunction.

Definition at line 279 of file MinModeSaddleSearch.cpp.

279{ matter->setPositionsV(x); }

Member Data Documentation

◆ eigenvector

AtomMatrix eonc::MinModeObjectiveFunction::eigenvector
private

Definition at line 90 of file MinModeSaddleSearch.cpp.

◆ iteration

int eonc::MinModeObjectiveFunction::iteration {0}
private

Definition at line 92 of file MinModeSaddleSearch.cpp.

92{0};

◆ matter

std::shared_ptr<Matter> eonc::MinModeObjectiveFunction::matter
private

Definition at line 89 of file MinModeSaddleSearch.cpp.

◆ minModeMethod

std::shared_ptr<EigenmodeStrategy> eonc::MinModeObjectiveFunction::minModeMethod
private

Definition at line 91 of file MinModeSaddleSearch.cpp.

◆ reactantEnergy

double eonc::MinModeObjectiveFunction::reactantEnergy {0.0}
private

Definition at line 93 of file MinModeSaddleSearch.cpp.

93{0.0};

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