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

#include <FIRE.h>

Inheritance diagram for eonc::FIRE:

Public Member Functions

 FIRE (std::shared_ptr< ObjectiveFunction > a_objf, const Parameters &a_params)
 ~FIRE ()=default
int step (double a_maxMove) override
int run (size_t a_maxIterations, double a_maxMove) override
void onTranslationPulledBack () 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

Private Attributes

double m_dt
double m_dt_max
double m_max_move
size_t m_N_min
size_t m_N
Eigen::VectorXd m_vel
double m_alpha_start
double m_alpha
double m_f_inc
double m_f_dec
double m_f_a
size_t m_iteration
eonc::log::FileScoped m_log {"fire", "_fire.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 19 of file FIRE.h.

Constructor & Destructor Documentation

◆ FIRE()

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

Definition at line 22 of file FIRE.h.

27 m_vel{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
29 m_f_a{0.99}, m_iteration{0} {}
const optimizer_options_t & optimizer_options() const
Eigen::VectorXd m_vel
Definition FIRE.h:39
double m_dt_max
Definition FIRE.h:37
double m_f_inc
Definition FIRE.h:42
size_t m_N_min
Definition FIRE.h:38
double m_alpha_start
Definition FIRE.h:40
double m_f_a
Definition FIRE.h:44
double m_max_move
Definition FIRE.h:37
size_t m_iteration
Definition FIRE.h:45
size_t m_N
Definition FIRE.h:38
double m_alpha
Definition FIRE.h:41
double m_f_dec
Definition FIRE.h:43
double m_dt
Definition FIRE.h:37
Optimizer(std::shared_ptr< ObjectiveFunction > a_objf, const OptimizerConfig &a_config)
Definition Optimizer.h:77
static OptimizerConfig fromParams(const Parameters &p)
Definition Optimizer.h:60

◆ ~FIRE()

eonc::FIRE::~FIRE ( )
default

Member Function Documentation

◆ onTranslationPulledBack()

void eonc::FIRE::onTranslationPulledBack ( )
overridevirtual

Reimplemented from eonc::Optimizer.

Definition at line 87 of file FIRE.cpp.

87 {
88 // The velocity was kicked toward the step that crossed the limit.
89 m_vel.setZero();
90}

◆ run()

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

Implements eonc::Optimizer.

Definition at line 92 of file FIRE.cpp.

92 {
93 while (!m_objf->isConverged() && m_iteration < a_maxIterations) {
94 step(a_maxMove);
95 }
96 return m_objf->isConverged() ? 1 : 0;
97}
int step(double a_maxMove) override
Definition FIRE.cpp:22
std::shared_ptr< ObjectiveFunction > m_objf
Definition Optimizer.h:74

◆ step()

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

Implements eonc::Optimizer.

Definition at line 22 of file FIRE.cpp.

22 {
23 double P = 0;
24 // Check convergence.
25 if (m_objf->isConverged()) {
26 return 1;
27 }
28
29 // Velocity Verlet
30 Eigen::VectorXd f = -m_objf->getGradient();
31 Eigen::VectorXd x = m_objf->getPositions();
32
33 m_vel += f * m_dt;
34 Eigen::VectorXd dx = m_vel * m_dt;
35
36 dx = eonc::geometry::maxAtomMotionAppliedV(dx, a_maxMove);
37 m_objf->setPositions(x + dx);
38
39 // A climbing objective may already be past max_energy. Rotating the
40 // mode here spends a dimer or Lanczos solve the search will discard,
41 // and the rotation can throw before the pull-back runs. The centre
42 // was evaluated by the check, so a point under the limit still shares
43 // a batching solver's first image with the gradient below.
44 if (m_objf->pastClimbCeiling()) {
46 return 0;
47 }
48
49 f = -m_objf->getGradient();
50 const double fnorm = eonc::exact::norm(f);
51 Eigen::VectorXd f_unit = Eigen::VectorXd::Zero(f.size());
52 if (fnorm > 0.0) {
53 f_unit = f / fnorm;
54 }
55
56 // FIRE
57 P = eonc::exact::dot(f, m_vel);
58 m_vel = (1 - m_alpha) * m_vel + m_alpha * f_unit * eonc::exact::norm(m_vel);
59 QUILL_LOG_DEBUG(m_log,
60 "P: {:.4f}, v: {:.4f}, m_dt: {:.4f}, m_alpha: {:.4f}, N: {}",
61 P, m_vel.norm(), m_dt, m_alpha, m_N);
62 if (P >= 0) {
63 m_N++;
64 if (m_N > m_N_min) {
65 m_dt = std::min(m_dt * m_f_inc, m_dt_max);
67 }
68 } else {
69 m_dt = m_dt * m_f_dec;
70 m_vel.setZero();
72 m_N = 0;
73 }
74
75 // add a sanity check on m_dt
76 if (m_dt < 1e-6) {
77 QUILL_LOG_CRITICAL(m_log, "[FIRE] [critical] m_dt is too small: {:.4f}",
78 m_dt);
79 throw std::runtime_error(
80 std::format("[FIRE] m_dt is too small: {:.4f}", m_dt));
81 }
82
84 return m_objf->isConverged() ? 1 : 0;
85}
eonc::log::FileScoped m_log
Definition FIRE.h:46
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_alpha

double eonc::FIRE::m_alpha
private

Definition at line 41 of file FIRE.h.

◆ m_alpha_start

double eonc::FIRE::m_alpha_start
private

Definition at line 40 of file FIRE.h.

◆ m_dt

double eonc::FIRE::m_dt
private

Definition at line 37 of file FIRE.h.

◆ m_dt_max

double eonc::FIRE::m_dt_max
private

Definition at line 37 of file FIRE.h.

◆ m_f_a

double eonc::FIRE::m_f_a
private

Definition at line 44 of file FIRE.h.

◆ m_f_dec

double eonc::FIRE::m_f_dec
private

Definition at line 43 of file FIRE.h.

◆ m_f_inc

double eonc::FIRE::m_f_inc
private

Definition at line 42 of file FIRE.h.

◆ m_iteration

size_t eonc::FIRE::m_iteration
private

Definition at line 45 of file FIRE.h.

◆ m_log

eonc::log::FileScoped eonc::FIRE::m_log {"fire", "_fire.log"}
private

Definition at line 46 of file FIRE.h.

46{"fire", "_fire.log"};

◆ m_max_move

double eonc::FIRE::m_max_move
private

Definition at line 37 of file FIRE.h.

◆ m_N

size_t eonc::FIRE::m_N
private

Definition at line 38 of file FIRE.h.

◆ m_N_min

size_t eonc::FIRE::m_N_min
private

Definition at line 38 of file FIRE.h.

◆ m_vel

Eigen::VectorXd eonc::FIRE::m_vel
private

Definition at line 39 of file FIRE.h.


The documentation for this class was generated from the following files:
  • /home/runner/work/eOn/eOn/include/eon/FIRE.h
  • /home/runner/work/eOn/eOn/client/FIRE.cpp