Loading...
Searching...
No Matches
MinModeSaddleSearch Class Reference

#include <MinModeSaddleSearch.h>

Inheritance diagram for MinModeSaddleSearch:

Public Types

enum  Status : int {
  STATUS_GOOD , STATUS_INIT , STATUS_BAD_NO_CONVEX , STATUS_BAD_HIGH_ENERGY ,
  STATUS_BAD_MAX_CONCAVE_ITERATIONS , STATUS_BAD_MAX_ITERATIONS , STATUS_BAD_NOT_CONNECTED , STATUS_BAD_PREFACTOR ,
  STATUS_BAD_HIGH_BARRIER , STATUS_BAD_MINIMA , STATUS_FAILED_PREFACTOR , STATUS_POTENTIAL_FAILED ,
  STATUS_NONNEGATIVE_ABORT , STATUS_NONLOCAL_ABORT , STATUS_NEGATIVE_BARRIER , STATUS_BAD_MD_TRAJECTORY_TOO_SHORT ,
  STATUS_BAD_NO_NEGATIVE_MODE_AT_SADDLE , STATUS_BAD_NO_BARRIER , STATUS_ZEROMODE_ABORT , STATUS_OPTIMIZER_ERROR ,
  STATUS_DIMER_LOST_MODE , STATUS_DIMER_RESTORED_BEST
}

Public Member Functions

 MinModeSaddleSearch (std::shared_ptr< Matter > matterPassed, AtomMatrix modePassed, double reactantEnergyPassed, const Parameters &parametersPassed, std::shared_ptr< Potential > potPassed)
 MinModeSaddleSearch (const MinModeSaddleSearch &)=delete
 MinModeSaddleSearch (MinModeSaddleSearch &&) noexcept=default
 ~MinModeSaddleSearch ()=default
MinModeSaddleSearchoperator= (const MinModeSaddleSearch &)=delete
MinModeSaddleSearchoperator= (MinModeSaddleSearch &&) noexcept=default
AtomMatrix getEigenvector ()
double getEigenvalue ()
std::string_view describeStatus (int status) const override
int getStatus () const override
int getIterationCount () const override
int getForceCalls () const override
int run () override
int run (long max_iterations_override)
int runRetainFrames (long max_iterations_override=-1)
 Like run(), but also retain climb ConFrames in memory (same stamps as write_movies climb CON).
const std::vector< readcon::ConFrame > & climbFrames () const
void clearClimbFrames ()
std::vector< readcon::ConFrame > takeClimbFrames ()
Public Member Functions inherited from eonc::SaddleSearchMethod
 SaddleSearchMethod (std::shared_ptr< Potential > potPassed, const Parameters &paramsPassed)
virtual ~SaddleSearchMethod ()

Static Public Member Functions

static constexpr std::string_view statusMessage (int status)
 Human-readable message for a status code.
static constexpr int finalizeClimbStatus (int climbStatus, bool objectiveConverged) noexcept
 Issue #20 policy: never leave climb as STATUS_GOOD when the climb objective is still unconverged (unfeasible systems must not look like success).

Public Attributes

int forcecalls {0}
int iteration {0}
int status {0}

Private Attributes

std::vector< readcon::ConFrame > climb_frames_
bool retain_climb_frames_ {false}
AtomMatrix mode
AtomMatrix initialTangent_
std::shared_ptr< Mattermatter
std::shared_ptr< EigenmodeStrategyminModeMethod
double reactantEnergy
eonc::log::Scoped log

Additional Inherited Members

Protected Attributes inherited from eonc::SaddleSearchMethod
std::shared_ptr< Potentialpot
const Parametersparams

Detailed Description

Definition at line 26 of file MinModeSaddleSearch.h.

Member Enumeration Documentation

◆ Status

Enumerator
STATUS_GOOD 
STATUS_INIT 
STATUS_BAD_NO_CONVEX 
STATUS_BAD_HIGH_ENERGY 
STATUS_BAD_MAX_CONCAVE_ITERATIONS 
STATUS_BAD_MAX_ITERATIONS 
STATUS_BAD_NOT_CONNECTED 
STATUS_BAD_PREFACTOR 
STATUS_BAD_HIGH_BARRIER 
STATUS_BAD_MINIMA 
STATUS_FAILED_PREFACTOR 
STATUS_POTENTIAL_FAILED 
STATUS_NONNEGATIVE_ABORT 
STATUS_NONLOCAL_ABORT 
STATUS_NEGATIVE_BARRIER 
STATUS_BAD_MD_TRAJECTORY_TOO_SHORT 
STATUS_BAD_NO_NEGATIVE_MODE_AT_SADDLE 
STATUS_BAD_NO_BARRIER 
STATUS_ZEROMODE_ABORT 
STATUS_OPTIMIZER_ERROR 
STATUS_DIMER_LOST_MODE 
STATUS_DIMER_RESTORED_BEST 

Definition at line 29 of file MinModeSaddleSearch.h.

29 : int {
30 // DO NOT CHANGE THE ORDER OF THIS LIST
31 STATUS_GOOD, // 0
32 STATUS_INIT, // 1
53 };

Constructor & Destructor Documentation

◆ MinModeSaddleSearch() [1/3]

MinModeSaddleSearch::MinModeSaddleSearch ( std::shared_ptr< Matter > matterPassed,
AtomMatrix modePassed,
double reactantEnergyPassed,
const Parameters & parametersPassed,
std::shared_ptr< Potential > potPassed )

Definition at line 171 of file MinModeSaddleSearch.cpp.

176 : SaddleSearchMethod(potPassed, parametersPassed),
177 matter{matterPassed} {
179 params.optimizer_options.convergence_metric, "[MinModeSaddleSearch]");
180 reactantEnergy = reactantEnergyPassed;
181 mode = modePassed;
182 initialTangent_ = modePassed;
184 iteration = 0;
185
187
188 // Set reference mode for ImprovedDimer (prevents mode switching)
189 if (auto *dimer = eonc::asImprovedDimer(*minModeMethod)) {
190 VectorXd refVec = VectorXd::Map(mode.data(), 3 * matter->numberOfAtoms());
191 refVec = refVec.array() * matter->getFreeV().array();
192 dimer->setReferenceMode(refVec);
193 }
194}
std::shared_ptr< Matter > matter
std::shared_ptr< EigenmodeStrategy > minModeMethod
std::shared_ptr< Potential > pot
SaddleSearchMethod(std::shared_ptr< Potential > potPassed, const Parameters &paramsPassed)
void requireKnownConvergenceMetric(std::string_view metric, std::string_view context)
Throws std::invalid_argument naming context when metric is unrecognized.
ImprovedDimer * asImprovedDimer(EigenmodeStrategy &s)
Access ImprovedDimer-specific features.
std::shared_ptr< EigenmodeStrategy > buildEigenmodeStrategy(std::shared_ptr< Matter > matter, const Parameters &params, std::shared_ptr< Potential > pot)
Build the eigenmode solver from parameters.

◆ MinModeSaddleSearch() [2/3]

◆ MinModeSaddleSearch() [3/3]

◆ ~MinModeSaddleSearch()

Member Function Documentation

◆ clearClimbFrames()

Definition at line 130 of file MinModeSaddleSearch.h.

130{ climb_frames_.clear(); }
std::vector< readcon::ConFrame > climb_frames_

◆ climbFrames()

const std::vector< readcon::ConFrame > & eonc::MinModeSaddleSearch::climbFrames ( ) const
inlinenodiscard

Definition at line 127 of file MinModeSaddleSearch.h.

127 {
128 return climb_frames_;
129 }

◆ describeStatus()

std::string_view eonc::MinModeSaddleSearch::describeStatus ( int status) const
inlineoverridevirtual

Implements eonc::SaddleSearchMethod.

Definition at line 110 of file MinModeSaddleSearch.h.

110 {
111 return statusMessage(status);
112 }
static constexpr std::string_view statusMessage(int status)
Human-readable message for a status code.

◆ finalizeClimbStatus()

constexpr int eonc::MinModeSaddleSearch::finalizeClimbStatus ( int climbStatus,
bool objectiveConverged )
inlinestaticnodiscardconstexprnoexcept

Issue #20 policy: never leave climb as STATUS_GOOD when the climb objective is still unconverged (unfeasible systems must not look like success).

Used by run(); unit-tested so deleting this rule fails CI.

Definition at line 91 of file MinModeSaddleSearch.h.

91 {
92 if (climbStatus == STATUS_GOOD && !objectiveConverged) {
94 }
95 return climbStatus;
96 }

◆ getEigenvalue()

Implements eonc::SaddleSearchMethod.

Definition at line 477 of file MinModeSaddleSearch.cpp.

477 {
479}
double eigenmodeGetEigenvalue(EigenmodeStrategy &s)
Dispatch getEigenvalue() to the active variant.

◆ getEigenvector()

Implements eonc::SaddleSearchMethod.

Definition at line 481 of file MinModeSaddleSearch.cpp.

481 {
483}
AtomMatrix eigenmodeGetEigenvector(EigenmodeStrategy &s)
Dispatch getEigenvector() to the active variant.

◆ getForceCalls()

int eonc::MinModeSaddleSearch::getForceCalls ( ) const
inlineoverridevirtual

Reimplemented from eonc::SaddleSearchMethod.

Definition at line 115 of file MinModeSaddleSearch.h.

◆ getIterationCount()

int eonc::MinModeSaddleSearch::getIterationCount ( ) const
inlineoverridevirtual

Reimplemented from eonc::SaddleSearchMethod.

Definition at line 114 of file MinModeSaddleSearch.h.

114{ return iteration; }

◆ getStatus()

int eonc::MinModeSaddleSearch::getStatus ( ) const
inlineoverridevirtual

Reimplemented from eonc::SaddleSearchMethod.

Definition at line 113 of file MinModeSaddleSearch.h.

113{ return status; }

◆ operator=() [1/2]

MinModeSaddleSearch & eonc::MinModeSaddleSearch::operator= ( const MinModeSaddleSearch & )
delete

◆ operator=() [2/2]

MinModeSaddleSearch & eonc::MinModeSaddleSearch::operator= ( MinModeSaddleSearch && )
defaultnoexcept

◆ run() [1/2]

int MinModeSaddleSearch::run ( void )
overridevirtual

Implements eonc::SaddleSearchMethod.

Definition at line 196 of file MinModeSaddleSearch.cpp.

196 {
197 return run(params.saddle_search_options.max_iterations);
198}

◆ run() [2/2]

int MinModeSaddleSearch::run ( long max_iterations_override)

Definition at line 211 of file MinModeSaddleSearch.cpp.

211 {
212 long effectiveMaxIter = max_iterations_override;
213 QUILL_LOG_DEBUG(
214 log, "Saddle point search started from reactant with energy {} eV.",
216
217 int optStatus;
218 bool firstIteration = true;
219 const char *forceLabel =
220 params.optimizer_options.convergence_metric_label.c_str();
221
222 if (params.saddle_search_options.minmode_method ==
224 QUILL_LOG_DEBUG(
225 log, "================= Using the GP Dimer Library =================");
228 QUILL_LOG_DEBUG(log, "GPR eigenvalue: {}",
231 }
232 if (getEigenvalue() > 0.0 && status == STATUS_GOOD) {
233 QUILL_LOG_DEBUG(log, "[MinModeSaddleSearch] eigenvalue not negative");
235 }
237 params.saddle_search_options.zero_mode_abort_curvature) {
238 QUILL_LOG_DEBUG(log, "Zero mode eigenvalue: {}",
241 }
244 } else {
245
246 if (params.saddle_search_options.minmode_method ==
248 QUILL_LOG_INFO(log,
249 "[Dimer] {:9s} {:9s} {:10s} {:18s} {:9s} "
250 "{:7s} {:6s} {:4s} {:5s}\n",
251 "Step", "Step Size", "Delta E", forceLabel, "Curvature",
252 "Torque", "Angle", "Rots", "Align");
253 } else if (params.saddle_search_options.minmode_method ==
255 QUILL_LOG_INFO(
256 log,
257 "[Lanczos] {:9s} {:9s} {:10s} {:18s} {:9s} {:10s} {:7s} {:5s}\n",
258 "Step", "Step Size", "Delta E", forceLabel, "Curvature", "Rel Change",
259 "Angle", "Iters");
260 } else if (params.saddle_search_options.minmode_method ==
262 QUILL_LOG_INFO(log,
263 "[GPRDimer] {:9s} {:9s} {:10s} {:18s} {:9s} "
264 " {:7s} {:6s} {:4s}\n",
265 "Step", "Step Size", "Delta E", forceLabel, "Curvature",
266 "Torque", "Angle", "Rots");
267 }
268
269 std::string climbLabel = "climb";
270 std::string climbDatFilename = "climb.dat";
271
272 AtomMatrix initialPosition = matter->getPositions();
273
274 auto objf = std::make_shared<MinModeObjectiveFunction>(
276 auto write_climb_frame = [&](uint64_t frameIndex, bool append,
277 double stepSize, double de, double conv,
278 double eigenval, double torque, double angle,
279 long rotations) {
280 eonc::io::ConFrameMetadata metadata;
281 metadata.frame_index = frameIndex;
282 metadata.energy = matter->getPotentialEnergy();
283 metadata.scalars.push_back({"step_size", stepSize});
284 metadata.scalars.push_back({"delta_e", de});
285 metadata.scalars.push_back({"convergence", conv});
286 metadata.scalars.push_back({"eigenvalue", eigenval});
287 metadata.scalars.push_back({"torque", torque});
288 metadata.scalars.push_back({"angle", angle});
289 metadata.scalars.push_back({"rotations", static_cast<double>(rotations)});
291 climb_frames_.push_back(eonc::io::matterToConFrame(*matter, &metadata));
292 }
293 if (params.debug_options.write_movies) {
294 if (!eonc::io::io_ok(
295 matter->matter2con(climbLabel, append, &metadata))) {
296 QUILL_LOG_WARNING(log, "Failed to write climb movie frame {}",
297 climbLabel);
298 }
299 }
300
301 if (params.debug_options.write_deprecated_outs) {
302 std::ofstream climbDat(climbDatFilename,
303 append ? (std::ios::binary | std::ios::app)
304 : std::ios::binary);
305 if (climbDat) {
306 if (!append) {
307 climbDat << "iteration\tstep_size\tdelta_e\tconvergence"
308 "\teigenvalue\ttorque\tangle\trotations\n";
309 }
310 climbDat << std::format("{}\t{:.7e}\t{:.6f}\t{:.5e}\t{:.6f}"
311 "\t{:.6f}\t{:.4f}\t{}\n",
312 frameIndex, stepSize, de, conv, eigenval,
313 torque, angle, rotations);
314 }
315 }
316 };
317 if (params.debug_options.write_movies || retain_climb_frames_) {
318 write_climb_frame(0, false, 0.0, 0.0, objf->getConvergence(),
320 0);
321 }
322 if (params.saddle_search_options.nonnegative_displacement_abort) {
323 objf->getGradient();
325 QUILL_LOG_DEBUG(log, "Nonnegative eigenvalue: {}",
328 }
329 }
330
332 objf, params.optimizer_options.method, params);
333
334 while (!objf->isConverged() || iteration == 0) {
335
336 if (!firstIteration) {
337
338 if (params.saddle_search_options.nonlocal_count_abort != 0) {
339 long nm = numAtomsMoved(
340 initialPosition - matter->getPositions(),
341 params.saddle_search_options.nonlocal_distance_abort);
342 if (nm >= params.saddle_search_options.nonlocal_count_abort) {
344 break;
345 }
346 }
347
349 params.saddle_search_options.zero_mode_abort_curvature) {
350 QUILL_LOG_DEBUG(log, "Zero mode eigenvalue: {}",
353 break;
354 }
355 }
356 firstIteration = false;
357
358 if (iteration >= effectiveMaxIter) {
360 break;
361 }
362
363 AtomMatrix pos = matter->getPositions();
364
365 try {
366 if (params.saddle_search_options.confine_positive.bowl_breakout &&
368 params.optimizer_options.method == OptType::CG) {
369 optStatus = optim->step(-params.optimizer_options.max_move);
370 } else {
371 optStatus = optim->step(params.optimizer_options.max_move);
372 }
373 } catch (const eonc::DimerModeRestoredException &) {
374 QUILL_LOG_DEBUG(
375 log, "Dimer restored to best state. Checking convergence...");
376 status = objf->isConverged() ? STATUS_GOOD : STATUS_DIMER_RESTORED_BEST;
377 break;
378 } catch (const eonc::DimerModeLostException &) {
379 QUILL_LOG_WARNING(log, "Dimer lost mode completely. Aborting.");
381 break;
382 }
383
384 if (optStatus < 0) {
386 break;
387 }
388
389 double de = objf->getEnergy() - reactantEnergy;
390
391 // Melander, Laasonen, Jonsson, JCTC 11(3), 1055-1062, 2015
392 if (params.saddle_search_options.remove_rotation) {
394 }
395 double stepSize = (matter->pbc(matter->getPositions() - pos)).norm();
396
397 iteration++;
398
399 // Logging
404 double conv = objf->getConvergence();
405
406 if (params.saddle_search_options.minmode_method ==
408 QUILL_LOG_DEBUG(
409 log,
410 "[Lanczos] {:9} {:9.6f} {:10.4f} {:18.5e} {:9.4f} {:10.6f} "
411 "{:7.3f} {:5}\n",
412 iteration, stepSize, de, conv, eigenval, torque, angle, rotations);
413 } else {
414 QUILL_LOG_DEBUG(
415 log,
416 "[Dimer] {:9} {:9.7f} {:10.4f} {:18.5e} {:9.4f} {:7.3f} "
417 " {:6.3f} {:4}\n",
418 iteration, stepSize, de, conv, eigenval, torque, angle, rotations);
419 }
420
421 if (params.debug_options.write_movies || retain_climb_frames_) {
422 write_climb_frame(static_cast<uint64_t>(iteration), true, stepSize, de,
423 conv, eigenval, torque, angle, rotations);
424 }
425
426 if (params.main_options.checkpoint) {
427 if (!eonc::io::io_ok(
428 matter->matter2con("displacement_cp.con", false))) {
429 QUILL_LOG_WARNING(log, "Failed to write displacement_cp.con");
430 }
431 eonc::helpers::saveMode("mode_cp.dat", matter,
433 }
434
435 if (de > params.saddle_search_options.max_energy) {
437 break;
438 }
439
440 // Check ImprovedDimer mode convergence
441 if (auto *dimer = eonc::asImprovedDimer(*minModeMethod)) {
442 if (!dimer->rotationDidConverge) {
443 status = (dimer->getEigenvalue() < 0.0) ? STATUS_DIMER_RESTORED_BEST
446 QUILL_LOG_DEBUG(log, "Dimer restored to valid state. C_tau={:.4f}",
447 dimer->getEigenvalue());
448 }
449 break;
450 }
451 }
452 }
453
454 if (iteration == 0) {
456 }
457
458 // Never report STATUS_GOOD when the climb objective is unconverged
459 // (issue #20: unfeasible systems must not look like success).
460 const bool climbConverged = objf->isConverged();
461 const int statusBeforeGuard = status;
462 status = finalizeClimbStatus(status, climbConverged);
463 if (statusBeforeGuard == STATUS_GOOD && status != STATUS_GOOD) {
464 QUILL_LOG_WARNING(log, "[MinModeSaddleSearch] objective not converged; "
465 "refusing STATUS_GOOD");
466 }
467
468 if (getEigenvalue() > 0.0 && status == STATUS_GOOD) {
469 QUILL_LOG_DEBUG(log, "[MinModeSaddleSearch] eigenvalue not negative");
471 }
472 }
473
474 return status;
475}
Eigen::Matrix< double, Eigen::Dynamic, 3, eOnStorageOrder > AtomMatrix
Definition Eigen.h:37
static const char MINMODE_DIMER[]
static const char MINMODE_GPRDIMER[]
static const char MINMODE_LANCZOS[]
static constexpr int finalizeClimbStatus(int climbStatus, bool objectiveConverged) noexcept
Issue #20 policy: never leave climb as STATUS_GOOD when the climb objective is still unconverged (unf...
std::unique_ptr< Optimizer > mkOptim(std::shared_ptr< ObjectiveFunction > a_objf, OptType a_otype, const Parameters &a_params)
Definition Optimizer.cpp:21
long numAtomsMoved(const AtomMatrix v1, double cutoff)
void saveMode(FILE *modeFile, std::shared_ptr< Matter > matter, AtomMatrix mode)
Write a mode; constrained axes are emitted as 0.
void rotationRemove(const AtomMatrix r1, std::shared_ptr< Matter > m2)
readcon::ConFrame matterToConFrame(Matter &m, const ConFrameMetadata *metadata)
Build a single stamped ConFrame from Matter (same builder as matter2con).
constexpr bool io_ok(IoStatus s) noexcept
Definition ConFileIO.h:38
double eigenmodeStatsAngle(EigenmodeStrategy &s)
double eigenmodeStatsTorque(EigenmodeStrategy &s)
void eigenmodeCompute(EigenmodeStrategy &s, std::shared_ptr< Matter > matter, AtomMatrix direction)
Dispatch compute() to the active variant.
long eigenmodeStatsRotations(EigenmodeStrategy &s)
long eigenmodeTotalForceCalls(EigenmodeStrategy &s)
Read stats from any variant (all inherit LowestEigenmode stats fields).
long eigenmodeTotalIterations(EigenmodeStrategy &s)
std::optional< uint64_t > frame_index
Definition ConFileIO.h:72
std::vector< ConMetadataValue > scalars
Definition ConFileIO.h:79
std::optional< double > energy
Definition ConFileIO.h:73

◆ runRetainFrames()

int MinModeSaddleSearch::runRetainFrames ( long max_iterations_override = -1)

Like run(), but also retain climb ConFrames in memory (same stamps as write_movies climb CON).

Does not require write_movies on disk.

Definition at line 200 of file MinModeSaddleSearch.cpp.

200 {
202 climb_frames_.clear();
203 const long maxIter = max_iterations_override < 0
204 ? params.saddle_search_options.max_iterations
205 : max_iterations_override;
206 const int st = run(maxIter);
207 retain_climb_frames_ = false;
208 return st;
209}

◆ statusMessage()

constexpr std::string_view eonc::MinModeSaddleSearch::statusMessage ( int status)
inlinestaticconstexpr

Human-readable message for a status code.

Definition at line 56 of file MinModeSaddleSearch.h.

56 {
57 constexpr std::string_view msgs[] = {
58 "Success", // 0
59 "Initialized", // 1
60 "Initial displacement unable to reach convex region", // 2
61 "Barrier too high", // 3
62 "Too many iterations in concave region", // 4
63 "Too many iterations", // 5
64 "Saddle is not connected to initial state", // 6
65 "Prefactors not within window", // 7
66 "Energy barrier not within window", // 8
67 "Minimizations from saddle did not converge", // 9
68 "Hessian calculation failed", // 10
69 "Potential evaluation failed", // 11
70 "Nonnegative initial mode, aborting", // 12
71 "Nonlocal abort", // 13
72 "Negative barrier detected", // 14
73 "No reaction found during MD trajectory", // 15
74 "Converged to stationary point with zero negative modes", // 16
75 "No forward barrier found along minimized band", // 17
76 "Zero mode abort", // 18
77 "Optimizer error", // 19
78 "Dimer lost mode", // 20
79 "Dimer restored best", // 21
80 };
81 if (status >= 0 &&
82 status < static_cast<int>(sizeof(msgs) / sizeof(msgs[0])))
83 return msgs[status];
84 return "Unknown status";
85 }

◆ takeClimbFrames()

std::vector< readcon::ConFrame > eonc::MinModeSaddleSearch::takeClimbFrames ( )
inlinenodiscard

Definition at line 131 of file MinModeSaddleSearch.h.

131 {
132 return std::move(climb_frames_);
133 }

Member Data Documentation

◆ climb_frames_

std::vector<readcon::ConFrame> eonc::MinModeSaddleSearch::climb_frames_
private

Definition at line 136 of file MinModeSaddleSearch.h.

◆ forcecalls

Definition at line 123 of file MinModeSaddleSearch.h.

123{0};

◆ initialTangent_

◆ iteration

Definition at line 124 of file MinModeSaddleSearch.h.

124{0};

◆ log

◆ matter

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

Definition at line 140 of file MinModeSaddleSearch.h.

◆ minModeMethod

Definition at line 142 of file MinModeSaddleSearch.h.

◆ mode

◆ reactantEnergy

Definition at line 143 of file MinModeSaddleSearch.h.

◆ retain_climb_frames_

Definition at line 137 of file MinModeSaddleSearch.h.

137{false};

◆ status

Definition at line 125 of file MinModeSaddleSearch.h.

125{0};

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