occ
Loading...
Searching...
No Matches
occ::opt Namespace Reference

Classes

struct  Primitive
 One primitive internal coordinate. More...
class  CoordinateSystem
 A set of coordinates q(x) for N atoms, with x in Bohr (3 x N). More...
class  CartesianCoordinates
class  TRICCoordinates
 Translation-rotation internal coordinates (TRIC; L. More...
struct  OptimizerSettings
class  GeometryOptimizer
 Geometry optimizer for minima and first-order saddle points (L. More...
struct  LbfgsSettings
class  LbfgsOptimizer
 L-BFGS geometry optimizer in Cartesian coordinates. More...
struct  NebSettings
class  NudgedElasticBand
 Nudged elastic band (Henkelman and Jonsson, J. More...
struct  ConvergenceCriteria
 Thresholds on per-atom quantities: the norm of each atom's gradient and of its displacement in the proposed step. More...

Functions

std::vector< std::pair< int, int > > covalent_bonds (const IVec &atomic_numbers, const Mat3N &x)
 Covalent bonds: pairs closer than 1.3 times the sum of covalent radii.
Vec aligned_displacements (const Mat3N &x0, const Mat3N &x)
 Per-atom displacements from x0 to x after optimal superposition (Bohr).
Mat3N project_net_force_torque (const Mat3N &x, const Mat3N &gradient)
 Gradient without net force and torque about the centroid.
Mat lindh_model_hessian (const Mat3N &positions, const IVec &atomic_numbers, double threshold=1e-4)
 Lindh's model Hessian (R.
Mat rigid_body_basis (const Mat3N &x)
 Orthonormal basis (3N x 6, or 5 for a linear and 3 for a single atom) of rigid translations and rotations about the centroid of x (any units).
bool check_convergence (const Mat3N &gradient, const Vec &displacements, double energy_change, bool check_energy, const ConvergenceCriteria &criteria, int step)
 Checks and logs the criteria for the gradient (3 x N, Hartree/Bohr), the per-atom displacements of the proposed step (Bohr) and the energy change since the previous point (ignored when check_energy is false).

Function Documentation

◆ aligned_displacements()

Vec occ::opt::aligned_displacements ( const Mat3N & x0,
const Mat3N & x )

Per-atom displacements from x0 to x after optimal superposition (Bohr).

◆ check_convergence()

bool occ::opt::check_convergence ( const Mat3N & gradient,
const Vec & displacements,
double energy_change,
bool check_energy,
const ConvergenceCriteria & criteria,
int step )

Checks and logs the criteria for the gradient (3 x N, Hartree/Bohr), the per-atom displacements of the proposed step (Bohr) and the energy change since the previous point (ignored when check_energy is false).

Returns true when every active criterion is met.

◆ covalent_bonds()

std::vector< std::pair< int, int > > occ::opt::covalent_bonds ( const IVec & atomic_numbers,
const Mat3N & x )

Covalent bonds: pairs closer than 1.3 times the sum of covalent radii.

◆ lindh_model_hessian()

Mat occ::opt::lindh_model_hessian ( const Mat3N & positions,
const IVec & atomic_numbers,
double threshold = 1e-4 )

Lindh's model Hessian (R.

Lindh, A. Bernhardsson, G. Karlstrom and P.-A. Malmqvist, Chem. Phys. Lett. 241, 423 (1995)) in Cartesian coordinates, Hartree/Bohr^2.

Every pair, bend and torsion of atoms contributes k q' q'^T, with q' the coordinate's Cartesian derivative and k = k_r rho_ij, k_f rho_ij rho_jk or k_t rho_ij rho_jk rho_kl, where rho_ij = exp(alpha (r_ref^2 - r_ij^2)) by periodic-table row. Terms whose weight is below threshold are dropped.

positions in Angstrom (3 x N).

◆ project_net_force_torque()

Mat3N occ::opt::project_net_force_torque ( const Mat3N & x,
const Mat3N & gradient )

Gradient without net force and torque about the centroid.

◆ rigid_body_basis()

Mat occ::opt::rigid_body_basis ( const Mat3N & x)

Orthonormal basis (3N x 6, or 5 for a linear and 3 for a single atom) of rigid translations and rotations about the centroid of x (any units).