eOn 3.2.0
Long-timescale dynamics: aKMC, NEB, parallel replica
☾
Toggle main menu visibility
Loading...
Searching...
No Matches
XtsciOptimizer.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
14
#include "
eon/Optimizer.h
"
15
#include "
eon/XtsciEindir.h
"
16
17
#include <string>
18
19
struct
rgmin_solver_t;
20
21
namespace
eonc
{
22
26
class
XtsciOptimizer
final :
public
Optimizer
{
27
public
:
29
XtsciOptimizer
(std::shared_ptr<ObjectiveFunction> a_objf,
30
const
Parameters
&a_params, std::string a_method = {})
31
:
Optimizer
(a_objf,
OptType
::
XTSCI
,
32
OptimizerConfig
::fromParams(a_params)),
33
m_method
(a_method.empty() ?
m_optConfig
.opts.xtsci.
method
34
: std::move(a_method)) {}
35
~XtsciOptimizer
()
override
;
36
37
XtsciOptimizer
(
const
XtsciOptimizer
&) =
delete
;
38
XtsciOptimizer
&
operator=
(
const
XtsciOptimizer
&) =
delete
;
39
40
int
step
(
double
a_maxMove)
override
;
41
int
run
(
size_t
a_maxIterations,
double
a_maxMove)
override
;
42
43
const
std::string &
method
()
const
{
return
m_method
; }
44
45
private
:
46
std::string
m_method
;
47
// Opaque rgmin session. L-BFGS pairs / NLCG directions live here.
48
rgmin_solver_t *
m_solver
{
nullptr
};
49
// Borrowed eindir objective. Null unless eindir-core is linked.
50
xtsci_eindir::State *
m_eindir
{
nullptr
};
51
// Last x passed to setPositions. Persists across step() so eval
52
// at the accepted point does not dirty Matter.
53
Eigen::VectorXd
m_cached_x
;
54
// Solver state. write_report updates this in place. Do not refresh
55
// from Matter::getPositions: PBC wrap would break last-x reuse.
56
Eigen::VectorXd
m_x
;
57
58
void
ensureSolver
(
double
a_maxMove);
59
};
60
61
}
// namespace eonc
62
63
using
eonc::XtsciOptimizer
;
Optimizer.h
The optimizer class is used to serve as an abstract class for all optimizers, as well as to call an o...
XtsciEindir.h
eonc::Optimizer
Abstract base of the structure optimizers.
Definition
Optimizer.h:68
eonc::Optimizer::m_optConfig
const OptimizerConfig m_optConfig
Definition
Optimizer.h:73
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::XtsciOptimizer
rgmin backend (opt_method = xtsci, or opt_backend = rgmin).
Definition
XtsciOptimizer.h:26
eonc::XtsciOptimizer::run
int run(size_t a_maxIterations, double a_maxMove) override
Definition
XtsciOptimizer.cpp:457
eonc::XtsciOptimizer::ensureSolver
void ensureSolver(double a_maxMove)
Definition
XtsciOptimizer.cpp:288
eonc::XtsciOptimizer::~XtsciOptimizer
~XtsciOptimizer() override
Definition
XtsciOptimizer.cpp:282
eonc::XtsciOptimizer::m_method
std::string m_method
Definition
XtsciOptimizer.h:46
eonc::XtsciOptimizer::m_cached_x
Eigen::VectorXd m_cached_x
Definition
XtsciOptimizer.h:53
eonc::XtsciOptimizer::method
const std::string & method() const
Definition
XtsciOptimizer.h:43
eonc::XtsciOptimizer::operator=
XtsciOptimizer & operator=(const XtsciOptimizer &)=delete
eonc::XtsciOptimizer::m_solver
rgmin_solver_t * m_solver
Definition
XtsciOptimizer.h:48
eonc::XtsciOptimizer::m_x
Eigen::VectorXd m_x
Definition
XtsciOptimizer.h:56
eonc::XtsciOptimizer::step
int step(double a_maxMove) override
Definition
XtsciOptimizer.cpp:406
eonc::XtsciOptimizer::XtsciOptimizer
XtsciOptimizer(const XtsciOptimizer &)=delete
eonc::XtsciOptimizer::m_eindir
xtsci_eindir::State * m_eindir
Definition
XtsciOptimizer.h:50
eonc::XtsciOptimizer::XtsciOptimizer
XtsciOptimizer(std::shared_ptr< ObjectiveFunction > a_objf, const Parameters &a_params, std::string a_method={})
a_method is an [Xtsci] method token; empty reads [Xtsci] method.
Definition
XtsciOptimizer.h:29
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::XTSCI
@ XTSCI
Definition
BaseStructures.h:112
eonc::OptimizerConfig
Declaration of the optimizer class.
Definition
Optimizer.h:54
include
eon
XtsciOptimizer.h
Generated by
1.17.0
Generated by
Doxygen 1.17.0
Analytics by
Antics
provided by
TurtleTech ehf