eonc::SaddleSearchMethod Class Reference

#include <SaddleSearchMethod.h>

Inheritance diagram for eonc::SaddleSearchMethod:

Public Member Functions
	SaddleSearchMethod (std::shared_ptr< Potential > potPassed, const Parameters &paramsPassed)
virtual	~SaddleSearchMethod ()
virtual int	run ()=0
virtual double	getEigenvalue ()=0
virtual AtomMatrix	getEigenvector ()=0
virtual std::string_view	describeStatus (int status) const =0
virtual int	getStatus () const
virtual int	getIterationCount () const
virtual int	getForceCalls () const

Protected Attributes
std::shared_ptr< Potential >	pot
const Parameters &	params

Detailed Description

Definition at line 21 of file SaddleSearchMethod.h.

Constructor & Destructor Documentation

SaddleSearchMethod()

eonc::SaddleSearchMethod::SaddleSearchMethod ( std::shared_ptr< Potential > potPassed, const Parameters & paramsPassed )

inline

Definition at line 27 of file SaddleSearchMethod.h.

      : pot{potPassed}, params{paramsPassed} {};

~SaddleSearchMethod()

virtual eonc::SaddleSearchMethod::~SaddleSearchMethod ( )

inlinevirtual

Definition at line 30 of file SaddleSearchMethod.h.

{};

Member Function Documentation

describeStatus()

virtual std::string_view eonc::SaddleSearchMethod::describeStatus ( int status ) const

pure virtual

Implemented in eonc::ARTnSaddleSearch, eonc::BasinHoppingSaddleSearch, eonc::BiasedGradientSquaredDescent, eonc::DynamicsSaddleSearch, and eonc::MinModeSaddleSearch.

getEigenvalue()

virtual double eonc::SaddleSearchMethod::getEigenvalue ( )

pure virtual

Implemented in eonc::ARTnSaddleSearch, eonc::BasinHoppingSaddleSearch, eonc::BiasedGradientSquaredDescent, eonc::DynamicsSaddleSearch, and eonc::MinModeSaddleSearch.

getEigenvector()

virtual AtomMatrix eonc::SaddleSearchMethod::getEigenvector ( )

pure virtual

Implemented in eonc::ARTnSaddleSearch, eonc::BasinHoppingSaddleSearch, eonc::BiasedGradientSquaredDescent, eonc::DynamicsSaddleSearch, and eonc::MinModeSaddleSearch.

getForceCalls()

virtual int eonc::SaddleSearchMethod::getForceCalls ( ) const

inlinevirtual

Reimplemented in eonc::ARTnSaddleSearch, and eonc::MinModeSaddleSearch.

Definition at line 37 of file SaddleSearchMethod.h.

{ return 0; }

getIterationCount()

virtual int eonc::SaddleSearchMethod::getIterationCount ( ) const

inlinevirtual

Reimplemented in eonc::ARTnSaddleSearch, and eonc::MinModeSaddleSearch.

Definition at line 36 of file SaddleSearchMethod.h.

{ return 0; }

getStatus()

virtual int eonc::SaddleSearchMethod::getStatus ( ) const

inlinevirtual

Reimplemented in eonc::ARTnSaddleSearch, eonc::BasinHoppingSaddleSearch, eonc::BiasedGradientSquaredDescent, eonc::DynamicsSaddleSearch, and eonc::MinModeSaddleSearch.

Definition at line 35 of file SaddleSearchMethod.h.

{ return 0; }

run()

virtual int eonc::SaddleSearchMethod::run ( )

pure virtual

Implemented in eonc::ARTnSaddleSearch, eonc::BasinHoppingSaddleSearch, eonc::BiasedGradientSquaredDescent, eonc::DynamicsSaddleSearch, and eonc::MinModeSaddleSearch.

Member Data Documentation

params

const Parameters& eonc::SaddleSearchMethod::params

protected

Definition at line 24 of file SaddleSearchMethod.h.

pot

std::shared_ptr<Potential> eonc::SaddleSearchMethod::pot

protected

Definition at line 23 of file SaddleSearchMethod.h.

---

The documentation for this class was generated from the following file:

• /home/runner/work/eOn/eOn/include/eon/SaddleSearchMethod.h