eOn 3.2.0
Long-timescale dynamics: aKMC, NEB, parallel replica
☾
Toggle main menu visibility
Loading...
Searching...
No Matches
ConjugateGradients.h
Go to the documentation of this file.
1
/*
2
** This file is part of eOn.
3
**
4
** SPDX-License-Identifier: BSD-3-Clause
5
**
6
** Copyright (c) 2010--present, eOn Development Team
7
** All rights reserved.
8
**
9
** Repo:
10
** https://github.com/TheochemUI/eOn
11
*/
12
#pragma once
13
#include "
Eigen.h
"
14
#include "
EonLogger.h
"
15
#include "
HelperFunctions.h
"
16
#include "
Matter.h
"
17
#include "
Optimizer.h
"
18
#include "
Parameters.h
"
19
20
#include <vector>
21
22
namespace
eonc
{
23
35
39
40
class
ConjugateGradients
final :
public
Optimizer
{
41
public
:
43
47
ConjugateGradients
(std::shared_ptr<ObjectiveFunction> a_objf,
48
const
Parameters
&a_params)
49
:
Optimizer
(a_objf,
OptType
::
CG
,
OptimizerConfig
::fromParams(a_params)),
50
m_direction
{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
51
m_directionOld
{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
52
m_directionNorm
{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
53
m_force
{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
54
m_forceOld
{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
55
m_secantPos
{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
56
m_secantDir
{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())} {}
57
58
~ConjugateGradients
() =
default
;
59
61
65
int
step
(
double
a_maxMove)
override
;
66
void
onTranslationPulledBack
()
override
;
68
72
int
run
(
size_t
a_maxIterations,
double
a_maxMove)
override
;
74
Eigen::VectorXd
getStep
();
75
76
private
:
78
Eigen::VectorXd
m_direction
;
80
Eigen::VectorXd
m_directionOld
;
82
Eigen::VectorXd
m_directionNorm
;
84
Eigen::VectorXd
m_force
;
86
Eigen::VectorXd
m_forceOld
;
90
Eigen::VectorXd
m_secantPos
;
91
Eigen::VectorXd
m_secantDir
;
92
double
m_secantProj
{0.0};
93
bool
m_haveSecant
{
false
};
94
Eigen::VectorXd
m_secantForce
;
95
// Per-atom secant curvature (eV/A^2). Soft atoms can take a longer
96
// step than the stiffest mode along the search direction.
97
std::vector<double>
m_atomCurv
;
98
// Trust region for the secant step. A step that raised the force is
99
// not reused at full length.
100
double
m_lastMotion
{0.0};
101
double
m_lastForceNorm
{0.0};
102
eonc::log::FileScoped
m_log
{
"cg"
,
"_cg.log"
};
103
105
size_t
m_cg_i
{0};
106
108
111
int
single_step
(
double
a_maxMove);
113
117
int
line_search
(
double
a_maxMove);
118
};
119
120
}
// namespace eonc
Eigen.h
EonLogger.h
HelperFunctions.h
Matter.h
Optimizer.h
The optimizer class is used to serve as an abstract class for all optimizers, as well as to call an o...
Parameters.h
eonc::ConjugateGradients::m_secantPos
Eigen::VectorXd m_secantPos
Definition
ConjugateGradients.h:90
eonc::ConjugateGradients::m_lastForceNorm
double m_lastForceNorm
Definition
ConjugateGradients.h:101
eonc::ConjugateGradients::single_step
int single_step(double a_maxMove)
Steps the conjugate gradient.
Definition
ConjugateGradients.cpp:127
eonc::ConjugateGradients::m_force
Eigen::VectorXd m_force
Current force vector.
Definition
ConjugateGradients.h:84
eonc::ConjugateGradients::getStep
Eigen::VectorXd getStep()
Gets the direction of the next step.
Definition
ConjugateGradients.cpp:20
eonc::ConjugateGradients::m_directionNorm
Eigen::VectorXd m_directionNorm
Normalised version of the current direction vector.
Definition
ConjugateGradients.h:82
eonc::ConjugateGradients::m_directionOld
Eigen::VectorXd m_directionOld
Algorithms previous step direction.
Definition
ConjugateGradients.h:80
eonc::ConjugateGradients::~ConjugateGradients
~ConjugateGradients()=default
Conjugant Gradient deconstructor.
eonc::ConjugateGradients::run
int run(size_t a_maxIterations, double a_maxMove) override
Runs the conjugate gradient.
Definition
ConjugateGradients.cpp:369
eonc::ConjugateGradients::m_cg_i
size_t m_cg_i
Counts the number of discrete steps until algorithm convergence.
Definition
ConjugateGradients.h:105
eonc::ConjugateGradients::ConjugateGradients
ConjugateGradients(std::shared_ptr< ObjectiveFunction > a_objf, const Parameters &a_params)
Conjugate Gradients optimizer constructor.
Definition
ConjugateGradients.h:47
eonc::ConjugateGradients::m_secantDir
Eigen::VectorXd m_secantDir
Definition
ConjugateGradients.h:91
eonc::ConjugateGradients::m_atomCurv
std::vector< double > m_atomCurv
Definition
ConjugateGradients.h:97
eonc::ConjugateGradients::m_secantProj
double m_secantProj
Definition
ConjugateGradients.h:92
eonc::ConjugateGradients::m_haveSecant
bool m_haveSecant
Definition
ConjugateGradients.h:93
eonc::ConjugateGradients::onTranslationPulledBack
void onTranslationPulledBack() override
Definition
ConjugateGradients.cpp:49
eonc::ConjugateGradients::m_direction
Eigen::VectorXd m_direction
Current step direction of the conjugate gradient.
Definition
ConjugateGradients.h:78
eonc::ConjugateGradients::step
int step(double a_maxMove) override
Calls the next step in the algorithm.
Definition
ConjugateGradients.cpp:56
eonc::ConjugateGradients::m_lastMotion
double m_lastMotion
Definition
ConjugateGradients.h:100
eonc::ConjugateGradients::m_secantForce
Eigen::VectorXd m_secantForce
Definition
ConjugateGradients.h:94
eonc::ConjugateGradients::m_forceOld
Eigen::VectorXd m_forceOld
Previous force vector.
Definition
ConjugateGradients.h:86
eonc::ConjugateGradients::m_log
eonc::log::FileScoped m_log
Definition
ConjugateGradients.h:102
eonc::ConjugateGradients::line_search
int line_search(double a_maxMove)
Steps the conjugate gradient.
Definition
ConjugateGradients.cpp:68
eonc::Optimizer::Optimizer
Optimizer(std::shared_ptr< ObjectiveFunction > a_objf, const OptimizerConfig &a_config)
Definition
Optimizer.h:77
eonc::Parameters
Definition
Parameters.h:35
eonc
RAII resource manager for the ARTn C library with global synchronization.
Definition
ARTnSaddleSearch.cpp:23
eonc::OptType
OptType
Definition
BaseStructures.h:103
eonc::OptType::CG
@ CG
Definition
BaseStructures.h:108
eonc::OptimizerConfig
Declaration of the optimizer class.
Definition
Optimizer.h:54
eonc::log::FileScoped
RAII helper for file-based logging in a class.
Definition
EonLogger.h:274
include
eon
ConjugateGradients.h
Generated by
1.17.0
Generated by
Doxygen 1.17.0
Analytics by
Antics
provided by
TurtleTech ehf