Loading...
Searching...
No Matches
eonc::Quickmin Class Referencefinal

#include <Quickmin.h>

Inheritance diagram for eonc::Quickmin:

Public Member Functions

 Quickmin (std::shared_ptr< ObjectiveFunction > a_objf, const Parameters &a_params)
 ~Quickmin ()=default
int step (double a_maxMove) override
int run (size_t a_maxIterations, double a_maxMove) override
Public Member Functions inherited from eonc::Optimizer
 Optimizer (std::shared_ptr< ObjectiveFunction > a_objf, const OptimizerConfig &a_config)
 Optimizer (std::shared_ptr< ObjectiveFunction > a_objf, OptType a_optype, const OptimizerConfig &a_config)
 Optimizer (std::shared_ptr< ObjectiveFunction > a_objf, const Parameters &a_params)
 Optimizer (std::shared_ptr< ObjectiveFunction > a_objf, OptType a_optype, const Parameters &a_params)
virtual ~Optimizer ()=default
virtual void onTranslationPulledBack ()

Private Attributes

double m_dt
double m_dt_max
double m_max_move
Eigen::VectorXd m_vel
size_t m_iteration
size_t m_max_iter
eonc::log::FileScoped m_log {"quickmin", "_quickmin.log"}

Additional Inherited Members

Protected Attributes inherited from eonc::Optimizer
const OptimizerConfig m_optConfig
std::shared_ptr< ObjectiveFunction > m_objf

Detailed Description

Definition at line 22 of file Quickmin.h.

Constructor & Destructor Documentation

◆ Quickmin()

eonc::Quickmin::Quickmin ( std::shared_ptr< ObjectiveFunction > a_objf,
const Parameters & a_params )
inline

Definition at line 25 of file Quickmin.h.

31 m_vel{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
32 m_iteration{0},
const optimizer_options_t & optimizer_options() const
Optimizer(std::shared_ptr< ObjectiveFunction > a_objf, const OptimizerConfig &a_config)
Definition Optimizer.h:77
double m_dt
Definition Quickmin.h:40
Eigen::VectorXd m_vel
Definition Quickmin.h:41
size_t m_max_iter
Definition Quickmin.h:42
size_t m_iteration
Definition Quickmin.h:42
double m_dt_max
Definition Quickmin.h:40
double m_max_move
Definition Quickmin.h:40
static OptimizerConfig fromParams(const Parameters &p)
Definition Optimizer.h:60

◆ ~Quickmin()

eonc::Quickmin::~Quickmin ( )
default

Member Function Documentation

◆ run()

int eonc::Quickmin::run ( size_t a_maxIterations,
double a_maxMove )
overridevirtual

Implements eonc::Optimizer.

Definition at line 48 of file Quickmin.cpp.

48 {
49 while (!m_objf->isConverged() && m_iteration < a_maxSteps) {
50 step(a_maxMove);
51 }
52 return m_objf->isConverged() ? 1 : 0;
53}
std::shared_ptr< ObjectiveFunction > m_objf
Definition Optimizer.h:74
int step(double a_maxMove) override
Definition Quickmin.cpp:20

◆ step()

int eonc::Quickmin::step ( double a_maxMove)
overridevirtual

Implements eonc::Optimizer.

Definition at line 20 of file Quickmin.cpp.

20 {
21 Eigen::VectorXd force = -m_objf->getGradient();
22 const double fn = eonc::exact::norm(force);
23 if (!(fn > 0.0) || !std::isfinite(fn)) {
25 return 1;
26 }
27 if (m_optConfig.opts.quickmin.steepest_descent) {
28 m_vel.setZero();
29 } else {
30 if (eonc::exact::dot(m_vel, force) < 0) {
31 m_vel.setZero();
32 } else {
33 const Eigen::VectorXd f_unit = force / fn;
34 m_vel = eonc::exact::dot(m_vel, f_unit) * f_unit;
35 }
36 }
37
38 m_vel += force * m_dt;
39 Eigen::VectorXd dr = eonc::geometry::maxAtomMotionAppliedV(
40 m_vel * m_dt,
41 a_maxMove); // used to be m_optConfig.opts.max_time_step
42 QUILL_LOG_INFO(m_log, "{} M_Vel.norm() is {}", m_iteration, m_vel.norm());
43 m_objf->setPositions(m_objf->getPositions() + dr);
45 return m_objf->isConverged() ? 1 : 0;
46}
const OptimizerConfig m_optConfig
Definition Optimizer.h:73
eonc::log::FileScoped m_log
Definition Quickmin.h:43
double norm(const Eigen::MatrixBase< A > &x)
sqrt of the correctly rounded squared norm; IEEE sqrt is itself correctly rounded,...
double dot(const double *x, const double *y, std::size_t n)
Round-to-nearest-even value of the exact sum of x[i] * y[i].
VectorXd maxAtomMotionAppliedV(const VectorXd v1, double maxMotion)

Member Data Documentation

◆ m_dt

double eonc::Quickmin::m_dt
private

Definition at line 40 of file Quickmin.h.

◆ m_dt_max

double eonc::Quickmin::m_dt_max
private

Definition at line 40 of file Quickmin.h.

◆ m_iteration

size_t eonc::Quickmin::m_iteration
private

Definition at line 42 of file Quickmin.h.

◆ m_log

eonc::log::FileScoped eonc::Quickmin::m_log {"quickmin", "_quickmin.log"}
private

Definition at line 43 of file Quickmin.h.

43{"quickmin", "_quickmin.log"};

◆ m_max_iter

size_t eonc::Quickmin::m_max_iter
private

Definition at line 42 of file Quickmin.h.

◆ m_max_move

double eonc::Quickmin::m_max_move
private

Definition at line 40 of file Quickmin.h.

◆ m_vel

Eigen::VectorXd eonc::Quickmin::m_vel
private

Definition at line 41 of file Quickmin.h.


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