eonc::BiasedGradientSquaredDescent Class Reference

#include <BiasedGradientSquaredDescent.h>

Inheritance diagram for eonc::BiasedGradientSquaredDescent:

Public Member Functions
	BiasedGradientSquaredDescent (std::shared_ptr< Matter > matterPassed, double reactantEnergyPassed, const Parameters &parametersPassed)
	~BiasedGradientSquaredDescent ()=default
int	run ()
double	getEigenvalue ()
AtomMatrix	getEigenvector ()
std::string_view	describeStatus (int status) const override
int	getStatus () const override
Public Member Functions inherited from eonc::SaddleSearchMethod
	SaddleSearchMethod (std::shared_ptr< Potential > potPassed, const Parameters &paramsPassed)
virtual	~SaddleSearchMethod ()
virtual int	getIterationCount () const
virtual int	getForceCalls () const

Public Attributes
double	eigenvalue {0.0}
AtomMatrix	eigenvector
std::shared_ptr< Matter >	saddle
int	status {0}

Private Attributes
double	reactantEnergy
eonc::log::Scoped	log

Additional Inherited Members
Protected Attributes inherited from eonc::SaddleSearchMethod
std::shared_ptr< Potential >	pot
const Parameters &	params

Detailed Description

Definition at line 24 of file BiasedGradientSquaredDescent.h.

Constructor & Destructor Documentation

BiasedGradientSquaredDescent()

eonc::BiasedGradientSquaredDescent::BiasedGradientSquaredDescent ( std::shared_ptr< Matter > matterPassed, double reactantEnergyPassed, const Parameters & parametersPassed )

inline

Definition at line 26 of file BiasedGradientSquaredDescent.h.

      : SaddleSearchMethod(matterPassed->getPotential(), parametersPassed),
        saddle{std::move(matterPassed)}, reactantEnergy{reactantEnergyPassed} {
    eigenvector.resize(saddle->numberOfAtoms(), 3);
    eigenvector.setZero();
  }

~BiasedGradientSquaredDescent()

eonc::BiasedGradientSquaredDescent::~BiasedGradientSquaredDescent ( )

default

Member Function Documentation

describeStatus()

std::string_view eonc::BiasedGradientSquaredDescent::describeStatus ( int status ) const

inlineoverridevirtual

Implements eonc::SaddleSearchMethod.

Definition at line 39 of file BiasedGradientSquaredDescent.h.

                                                           {
    return MinModeSaddleSearch::statusMessage(status);
  }

getEigenvalue()

double eonc::BiasedGradientSquaredDescent::getEigenvalue ( )

virtual

Implements eonc::SaddleSearchMethod.

Definition at line 164 of file BiasedGradientSquaredDescent.cpp.

{ return eigenvalue; }

getEigenvector()

AtomMatrix eonc::BiasedGradientSquaredDescent::getEigenvector ( )

virtual

Implements eonc::SaddleSearchMethod.

Definition at line 166 of file BiasedGradientSquaredDescent.cpp.

                                                        {
  return eigenvector;
}

getStatus()

int eonc::BiasedGradientSquaredDescent::getStatus ( ) const

inlineoverridevirtual

Reimplemented from eonc::SaddleSearchMethod.

Definition at line 42 of file BiasedGradientSquaredDescent.h.

{ return status; }

run()

int eonc::BiasedGradientSquaredDescent::run ( void )

virtual

Implements eonc::SaddleSearchMethod.

Definition at line 103 of file BiasedGradientSquaredDescent.cpp.

                                      {
  auto objf = std::make_shared<BGSDObjectiveFunction>(
      *saddle, reactantEnergy, params.bgsd_options().alpha, params);
  auto optim = eonc::helpers::create::mkOptim(
      objf, params.optimizer_options().method, params);
  int iteration = 0;
  const int max_iter = params.optimizer_options().max_iterations;
  QUILL_LOG_DEBUG(
      log,
      "starting optimization of H with params alpha and beta: {:.2f} {:.2f}",
      params.bgsd_options().alpha, params.bgsd_options().beta);
  while (iteration < max_iter && (!objf->isConvergedH() || iteration == 0)) {
    if (!std::isfinite(objf->getEnergy())) {
      break;
    }
    optim->step(params.optimizer_options().max_move);
    QUILL_LOG_DEBUG(log,
                    "iteration {} Henergy, gradientHnorm, and Venergy: "
                    "{:.8f} {:.8f} {:.8f}",
                    iteration, objf->getEnergy(), objf->getGradientnorm(),
                    saddle->getPotentialEnergy());
    iteration++;
  }
  auto objf2 = std::make_shared<BGSDObjectiveFunction>(*saddle, reactantEnergy,
                                                       0.0, params);
  auto optim2 = eonc::helpers::create::mkOptim(
      objf2, params.optimizer_options().method, params);
  int iter2 = 0;
  while (iter2 < max_iter && (!objf2->isConvergedV() || iter2 == 0)) {
    if (objf2->isConvergedIP() || !std::isfinite(objf2->getEnergy())) {
      break;
    }
    optim2->step(params.optimizer_options().max_move);
    QUILL_LOG_DEBUG(log,
                    "gradient squared iteration {} Henergy, gradientHnorm, "
                    "and Venergy: {:.8f} {:.8f} {:.8f}",
                    iteration, objf2->getEnergy(), objf2->getGradientnorm(),
                    saddle->getPotentialEnergy());
    ++iteration;
    ++iter2;
  }
 
  auto minModeMethod = eonc::buildEigenmodeStrategy(saddle, params, pot);
 
  eigenvector.setRandom();
  for (int i = 0; i < saddle->numberOfAtoms(); i++) {
    for (int j = 0; j < 3; j++) {
      if (saddle->getFixed(i)) {
        eigenvector(i, j) = 0.0;
      };
    }
  }
  eonc::safemath::safe_normalize_inplace(eigenvector);
  eonc::eigenmodeCompute(*minModeMethod, saddle, eigenvector);
  eigenvector = eonc::eigenmodeGetEigenvector(*minModeMethod);
  eigenvalue = eonc::eigenmodeGetEigenvalue(*minModeMethod);
  QUILL_LOG_DEBUG(log, "lowest eigenvalue {:.8f}", eigenvalue);
  status = objf2->isConvergedV() ? 0 : 1;
  return status;
}

Member Data Documentation

eigenvalue

double eonc::BiasedGradientSquaredDescent::eigenvalue {0.0}

Definition at line 44 of file BiasedGradientSquaredDescent.h.

{0.0};

eigenvector

AtomMatrix eonc::BiasedGradientSquaredDescent::eigenvector

Definition at line 45 of file BiasedGradientSquaredDescent.h.

log

eonc::log::Scoped eonc::BiasedGradientSquaredDescent::log

private

Definition at line 53 of file BiasedGradientSquaredDescent.h.

reactantEnergy

double eonc::BiasedGradientSquaredDescent::reactantEnergy

private

Definition at line 52 of file BiasedGradientSquaredDescent.h.

saddle

std::shared_ptr<Matter> eonc::BiasedGradientSquaredDescent::saddle

Definition at line 47 of file BiasedGradientSquaredDescent.h.

status

int eonc::BiasedGradientSquaredDescent::status {0}

Definition at line 49 of file BiasedGradientSquaredDescent.h.

{0};

---

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

• /home/runner/work/eOn/eOn/include/eon/BiasedGradientSquaredDescent.h
• /home/runner/work/eOn/eOn/client/BiasedGradientSquaredDescent.cpp