eOn 3.2.0
Long-timescale dynamics: aKMC, NEB, parallel replica
☾
Toggle main menu visibility
Loading...
Searching...
No Matches
Optimizer.cpp
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
#include "
eon/Optimizer.h
"
13
#include "
eon/BaseStructures.h
"
14
#include "
eon/ConjugateGradients.h
"
15
#include "
eon/FIRE.h
"
16
#include "
eon/LBFGS.h
"
17
#include "
eon/Quickmin.h
"
18
#include "
eon/SteepestDescent.h
"
19
#ifdef WITH_RGMIN
20
#include "
eon/XtsciOptimizer.h
"
21
#endif
22
23
namespace
eonc::helpers::create
{
24
25
std::optional<std::string>
rgminMethodFor
(
const
ObjectiveFunction
&a_objf,
26
OptType
a_otype,
27
const
Parameters
&a_params) {
28
if
(!a_objf.
gradientMatchesEnergy
()) {
29
return
std::nullopt;
30
}
31
return
rgminBackendMethod
(a_otype, a_params);
32
}
33
34
std::optional<std::string>
rgminBackendMethod
(
OptType
a_otype,
35
const
Parameters
&a_params) {
36
if
(a_params.
optimizer_options
().
backend
!=
"rgmin"
) {
37
return
std::nullopt;
38
}
39
switch
(a_otype) {
40
case
OptType::LBFGS
:
41
return
"lbfgs"
;
42
case
OptType::FIRE
:
43
return
"fire"
;
44
case
OptType::CG
:
45
return
"polak_ribiere"
;
46
case
OptType::SD
:
47
return
"steepest"
;
48
case
OptType::QM
:
49
return
"quickmin"
;
50
default
:
51
return
std::nullopt;
52
}
53
}
54
55
std::unique_ptr<Optimizer>
mkOptim
(std::shared_ptr<ObjectiveFunction> a_objf,
56
OptType
a_otype,
57
const
Parameters
&a_params) {
58
if
(
auto
method =
rgminMethodFor
(*a_objf, a_otype, a_params)) {
59
#ifdef WITH_RGMIN
60
return
std::make_unique<XtsciOptimizer>(a_objf, a_params,
61
std::move(*method));
62
#else
63
throw
std::runtime_error(
64
"[Optimizer] opt_backend=rgmin needs a build that links rgmin "
65
"(-Dwith_rgmin=enabled)"
);
66
#endif
67
}
68
switch
(a_otype) {
69
case
OptType::FIRE
: {
70
return
std::make_unique<FIRE>(a_objf, a_params);
71
}
72
case
OptType::QM
: {
73
return
std::make_unique<Quickmin>(a_objf, a_params);
74
}
75
case
OptType::CG
: {
76
return
std::make_unique<ConjugateGradients>(a_objf, a_params);
77
}
78
case
OptType::LBFGS
: {
79
return
std::make_unique<LBFGS>(a_objf, a_params);
80
}
81
case
OptType::SD
: {
82
return
std::make_unique<SteepestDescent>(a_objf, a_params);
83
}
84
#ifdef WITH_RGMIN
85
case
OptType::XTSCI
: {
86
return
std::make_unique<XtsciOptimizer>(a_objf, a_params);
87
}
88
#else
89
case
OptType::XTSCI
: {
90
throw
std::runtime_error(
91
"[Optimizer] opt_method=xtsci needs a build that links rgmin "
92
"(-Dwith_rgmin=enabled)"
);
93
}
94
#endif
95
case
OptType::None
: {
96
throw
std::runtime_error(
"[Optimizer] Cannot create None"
);
97
}
98
case
OptType::Unknown
: {
99
throw
std::runtime_error(
"[Optimizer] Cannot create Unknown"
);
100
}
101
default
: {
102
throw
std::runtime_error(
"Unsupported optimization type"
);
103
}
104
}
105
}
106
}
// namespace eonc::helpers::create
BaseStructures.h
ConjugateGradients.h
Direct optimization for energy minimization.
FIRE.h
LBFGS.h
Optimizer.h
The optimizer class is used to serve as an abstract class for all optimizers, as well as to call an o...
Quickmin.h
SteepestDescent.h
XtsciOptimizer.h
eonc::ObjectiveFunction
Definition
ObjectiveFunction.h:20
eonc::ObjectiveFunction::gradientMatchesEnergy
virtual bool gradientMatchesEnergy() const
Definition
ObjectiveFunction.h:40
eonc::Parameters
Definition
Parameters.h:35
eonc::Parameters::optimizer_options
const optimizer_options_t & optimizer_options() const
Definition
ParametersAccess.cpp:131
eonc::helpers::create
Definition
Optimizer.cpp:23
eonc::helpers::create::rgminBackendMethod
std::optional< std::string > rgminBackendMethod(OptType a_otype, const Parameters &a_params)
rgminMethodFor without the objective test: what a minimization of a potential energy runs under opt_b...
Definition
Optimizer.cpp:34
eonc::helpers::create::mkOptim
std::unique_ptr< Optimizer > mkOptim(std::shared_ptr< ObjectiveFunction > a_objf, OptType a_otype, const Parameters &a_params)
Definition
Optimizer.cpp:55
eonc::helpers::create::rgminMethodFor
std::optional< std::string > rgminMethodFor(const ObjectiveFunction &a_objf, OptType a_otype, const Parameters &a_params)
The rgmin method token mkOptim runs for a_otype when [Optimizer] opt_backend = rgmin.
Definition
Optimizer.cpp:25
eonc::OptType
OptType
Definition
BaseStructures.h:103
eonc::OptType::LBFGS
@ LBFGS
Definition
BaseStructures.h:109
eonc::OptType::SD
@ SD
Definition
BaseStructures.h:111
eonc::OptType::CG
@ CG
Definition
BaseStructures.h:108
eonc::OptType::None
@ None
Definition
BaseStructures.h:106
eonc::OptType::XTSCI
@ XTSCI
Definition
BaseStructures.h:112
eonc::OptType::Unknown
@ Unknown
Definition
BaseStructures.h:105
eonc::OptType::FIRE
@ FIRE
Definition
BaseStructures.h:110
eonc::OptType::QM
@ QM
Definition
BaseStructures.h:107
eonc::optimizer_options_t::backend
std::string backend
"eon" or "rgmin".
Definition
ParametersOptions.h:329
client
Optimizer.cpp
Generated by
1.17.0
Generated by
Doxygen 1.17.0
Analytics by
Antics
provided by
TurtleTech ehf