occ
Loading...
Searching...
No Matches
occ::opt::NudgedElasticBand Class Reference

Nudged elastic band (Henkelman and Jonsson, J. More...

#include <neb.h>

Public Member Functions

 NudgedElasticBand (const core::Molecule &reactant, const core::Molecule &product, const NebSettings &settings={})
std::vector< core::Molecule > images () const
 The images between the endpoints, to evaluate.
std::vector< core::Molecule > path () const
 All images, endpoints included.
void set_endpoint_energies (double reactant, double product)
 Energies of the endpoints (Hartree), which the tangents need.
void update (const std::vector< double > &energies, const std::vector< Mat3N > &gradients)
 Energies (Hartree) and gradients (Hartree/Bohr, 3 x N) at images().
bool step ()
 Check convergence, else move the band. Returns true when converged.
bool is_converged () const
bool climbing () const
int current_step () const
const Vec & energies () const
 Path energies (Hartree), endpoints included.
int highest_image () const
 Index in path() of the highest interior image.
Vec tangent (int i) const
 Unit tangent at path() image i (interior), 3N atom-major.
double max_force () const
 Largest NEB force on any atom at the last update (Hartree/Bohr).

Detailed Description

Nudged elastic band (Henkelman and Jonsson, J.

Chem. Phys. 113, 9978 (2000)) between two structures with the same atoms in the same order, in Cartesian coordinates: the potential force perpendicular to the improved tangent plus the spring force along it (tangents and spring lengths from neighbours superposed on each image, free of rigid rotation), with an optional climbing image (Henkelman, Uberuaga and Jonsson, J. Chem. Phys. 113, 9901 (2000)). The band moves by L-BFGS on the NEB force, its steps capped, without energy checks (the NEB force is not a gradient).

Use: set_endpoint_energies(), then update() with the energies and gradients at images(), then step(), until step() returns true.

Constructor & Destructor Documentation

◆ NudgedElasticBand()

occ::opt::NudgedElasticBand::NudgedElasticBand ( const core::Molecule & reactant,
const core::Molecule & product,
const NebSettings & settings = {} )

Member Function Documentation

◆ climbing()

bool occ::opt::NudgedElasticBand::climbing ( ) const
inline

◆ current_step()

int occ::opt::NudgedElasticBand::current_step ( ) const
inline

◆ energies()

const Vec & occ::opt::NudgedElasticBand::energies ( ) const
inline

Path energies (Hartree), endpoints included.

◆ highest_image()

int occ::opt::NudgedElasticBand::highest_image ( ) const

Index in path() of the highest interior image.

◆ images()

std::vector< core::Molecule > occ::opt::NudgedElasticBand::images ( ) const

The images between the endpoints, to evaluate.

◆ is_converged()

bool occ::opt::NudgedElasticBand::is_converged ( ) const
inline

◆ max_force()

double occ::opt::NudgedElasticBand::max_force ( ) const
inline

Largest NEB force on any atom at the last update (Hartree/Bohr).

◆ path()

std::vector< core::Molecule > occ::opt::NudgedElasticBand::path ( ) const

All images, endpoints included.

◆ set_endpoint_energies()

void occ::opt::NudgedElasticBand::set_endpoint_energies ( double reactant,
double product )

Energies of the endpoints (Hartree), which the tangents need.

◆ step()

bool occ::opt::NudgedElasticBand::step ( )

Check convergence, else move the band. Returns true when converged.

◆ tangent()

Vec occ::opt::NudgedElasticBand::tangent ( int i) const

Unit tangent at path() image i (interior), 3N atom-major.

◆ update()

void occ::opt::NudgedElasticBand::update ( const std::vector< double > & energies,
const std::vector< Mat3N > & gradients )

Energies (Hartree) and gradients (Hartree/Bohr, 3 x N) at images().


The documentation for this class was generated from the following file:
  • /home/runner/work/occ/occ/include/occ/opt/neb.h