eOn client
Long-timescale dynamics: aKMC, NEB, parallel replica
☾
Toggle main menu visibility
Loading...
Searching...
No Matches
SaddleSearchJob.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 "
EonLogger.h
"
14
15
#include "
HelperFunctions.h
"
16
#include "
Job.h
"
17
#include "
Matter.h
"
18
#include "
MinModeSaddleSearch.h
"
19
#include "
Parameters.h
"
20
#include "
SaddleSearchMethod.h
"
21
22
namespace
eonc
{
23
40
44
45
class
SaddleSearchJob
:
public
Job
{
46
public
:
48
51
SaddleSearchJob
(std::unique_ptr<Parameters> parameters)
52
:
Job
(std::move(parameters)),
53
fCallsSaddle
{0} {}
54
55
~SaddleSearchJob
(
void
) =
default
;
57
std::vector<std::string>
run
(
void
);
58
59
private
:
61
int
doSaddleSearch
();
63
void
printEndState
(
int
status);
65
void
saveData
(
int
status);
66
68
std::vector<std::string>
returnFiles
;
69
71
std::unique_ptr<SaddleSearchMethod>
saddleSearch
;
73
std::shared_ptr<Matter>
initial
;
75
std::shared_ptr<Matter>
saddle
;
77
std::shared_ptr<Matter>
displacement
;
78
80
int
fCallsSaddle
;
81
82
eonc::log::Scoped
log
;
83
};
84
85
}
// namespace eonc
86
87
using
eonc::SaddleSearchJob
;
EonLogger.h
HelperFunctions.h
Job.h
The job class is used to serve as an abstract class for all jobs, as well as to call a job at runtime...
Matter.h
MinModeSaddleSearch.h
Parameters.h
SaddleSearchMethod.h
eonc::Job::Job
Job(std::unique_ptr< Parameters > parameters)
Definition
Job.h:58
eonc::SaddleSearchJob
Declaration of the Saddle Search job.
Definition
SaddleSearchJob.h:45
eonc::SaddleSearchJob::saveData
void saveData(int status)
Writes the results from the run to file.
Definition
SaddleSearchJob.cpp:138
eonc::SaddleSearchJob::saddleSearch
std::unique_ptr< SaddleSearchMethod > saddleSearch
Initializes a ref SaddleSearchMethod (base class for polymorphism).
Definition
SaddleSearchJob.h:71
eonc::SaddleSearchJob::returnFiles
std::vector< std::string > returnFiles
Container for the results of the run.
Definition
SaddleSearchJob.h:68
eonc::SaddleSearchJob::run
std::vector< std::string > run(void)
Kicks off the Saddle Search.
Definition
SaddleSearchJob.cpp:27
eonc::SaddleSearchJob::saddle
std::shared_ptr< Matter > saddle
Configuration used during the saddle point search.
Definition
SaddleSearchJob.h:75
eonc::SaddleSearchJob::log
eonc::log::Scoped log
Definition
SaddleSearchJob.h:82
eonc::SaddleSearchJob::fCallsSaddle
int fCallsSaddle
Force calls to find the saddle.
Definition
SaddleSearchJob.h:80
eonc::SaddleSearchJob::SaddleSearchJob
SaddleSearchJob(std::unique_ptr< Parameters > parameters)
Saddle Search job constructor.
Definition
SaddleSearchJob.h:51
eonc::SaddleSearchJob::~SaddleSearchJob
~SaddleSearchJob(void)=default
Saddle Search Job Deconstructor.
eonc::SaddleSearchJob::displacement
std::shared_ptr< Matter > displacement
Configuration used during the saddle point search.
Definition
SaddleSearchJob.h:77
eonc::SaddleSearchJob::printEndState
void printEndState(int status)
Logs the run status and makes sure the run was successful.
Definition
SaddleSearchJob.cpp:177
eonc::SaddleSearchJob::doSaddleSearch
int doSaddleSearch()
Runs the correct saddle search; also checks if the run was successful.
Definition
SaddleSearchJob.cpp:109
eonc::SaddleSearchJob::initial
std::shared_ptr< Matter > initial
Initial configuration.
Definition
SaddleSearchJob.h:73
eonc
RAII resource manager for the ARTn C library with global synchronization.
Definition
ARTnSaddleSearch.cpp:19
eonc::log::Scoped
RAII helper for class-scoped logging.
Definition
EonLogger.h:171
include
eon
SaddleSearchJob.h
Generated by
1.17.0
Generated by
Doxygen 1.17.0
Analytics by
Antics
provided by
TurtleTech ehf