eOn 3.2.0
Long-timescale dynamics: aKMC, NEB, parallel replica
☾
Toggle main menu visibility
Loading...
Searching...
No Matches
SaddleSearchMethod.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 "
Parameters.h
"
15
#include "
Potential.h
"
16
17
#include <string_view>
18
19
namespace
eonc
{
20
21
class
SaddleSearchMethod
{
22
protected
:
23
std::shared_ptr<Potential>
pot
;
24
const
Parameters
&
params
;
25
26
public
:
27
SaddleSearchMethod
(std::shared_ptr<Potential> potPassed,
28
const
Parameters
¶msPassed)
29
:
pot
{potPassed},
params
{paramsPassed} {};
30
virtual
~SaddleSearchMethod
() {};
31
virtual
int
run
() = 0;
32
virtual
double
getEigenvalue
() = 0;
33
virtual
AtomMatrix
getEigenvector
() = 0;
34
virtual
std::string_view
describeStatus
(
int
status)
const
= 0;
35
virtual
int
getStatus
()
const
{
return
0; }
36
virtual
int
getIterationCount
()
const
{
return
0; }
37
virtual
int
getForceCalls
()
const
{
return
0; }
38
};
39
40
}
// namespace eonc
AtomMatrix
Eigen::Matrix< double, Eigen::Dynamic, 3, eOnStorageOrder > AtomMatrix
Definition
Eigen.h:37
Parameters.h
Potential.h
eonc::Parameters
Definition
Parameters.h:35
eonc::SaddleSearchMethod::run
virtual int run()=0
eonc::SaddleSearchMethod::getForceCalls
virtual int getForceCalls() const
Definition
SaddleSearchMethod.h:37
eonc::SaddleSearchMethod::pot
std::shared_ptr< Potential > pot
Definition
SaddleSearchMethod.h:23
eonc::SaddleSearchMethod::getEigenvector
virtual AtomMatrix getEigenvector()=0
eonc::SaddleSearchMethod::getEigenvalue
virtual double getEigenvalue()=0
eonc::SaddleSearchMethod::~SaddleSearchMethod
virtual ~SaddleSearchMethod()
Definition
SaddleSearchMethod.h:30
eonc::SaddleSearchMethod::getIterationCount
virtual int getIterationCount() const
Definition
SaddleSearchMethod.h:36
eonc::SaddleSearchMethod::getStatus
virtual int getStatus() const
Definition
SaddleSearchMethod.h:35
eonc::SaddleSearchMethod::params
const Parameters & params
Definition
SaddleSearchMethod.h:24
eonc::SaddleSearchMethod::describeStatus
virtual std::string_view describeStatus(int status) const =0
eonc::SaddleSearchMethod::SaddleSearchMethod
SaddleSearchMethod(std::shared_ptr< Potential > potPassed, const Parameters ¶msPassed)
Definition
SaddleSearchMethod.h:27
eonc
RAII resource manager for the ARTn C library with global synchronization.
Definition
ARTnSaddleSearch.cpp:23
include
eon
SaddleSearchMethod.h
Generated by
1.17.0
Generated by
Doxygen 1.17.0
Analytics by
Antics
provided by
TurtleTech ehf