occ
Loading...
Searching...
No Matches
occ::opt::Primitive Struct Reference

One primitive internal coordinate. More...

#include <coordinates.h>

Public Types

enum class  Kind {
  Distance , Angle , LinearBend , Dihedral ,
  Cartesian , Translation , Rotation
}

Public Member Functions

double value (const Mat3N &x) const
void add_derivative (const Mat3N &x, Eigen::Ref< Vec > row) const
 Adds d value / d x into row (length 3N, atom-major xyz).

Public Attributes

Kind kind
std::vector< int > atoms
 the atoms involved (the fragment for Translation and Rotation)
int component {0}
 Cartesian, Translation, Rotation: 0, 1, 2.
Vec3 direction {Vec3::Zero()}
 LinearBend: e; linear Rotation: axis e.
Mat3N reference
 Rotation: centred reference positions.
double scale {1.0}
 Rotation: radius of gyration of the reference.
bool linear_fragment {false}
 Rotation of a linear fragment.

Detailed Description

One primitive internal coordinate.

Positions are in Bohr throughout; distances, translations and Cartesians are in Bohr, angles in radians, and rotations in radians scaled by the fragment's radius of gyration.

Member Enumeration Documentation

◆ Kind

enum class occ::opt::Primitive::Kind
strong
Enumerator
Distance 

|x_a - x_b|

Angle 

a-b-c, below ~175 degrees

LinearBend 

a-b-c near linear: e . (u_ba + u_bc) for a fixed e

Dihedral 

a-b-c-d in (-pi, pi]

Cartesian 

x_a[component]

Translation 

centroid of the fragment [component]

Rotation 

rotation vector of the fragment from its reference

Member Function Documentation

◆ add_derivative()

void occ::opt::Primitive::add_derivative ( const Mat3N & x,
Eigen::Ref< Vec > row ) const

Adds d value / d x into row (length 3N, atom-major xyz).

◆ value()

double occ::opt::Primitive::value ( const Mat3N & x) const

Member Data Documentation

◆ atoms

std::vector<int> occ::opt::Primitive::atoms

the atoms involved (the fragment for Translation and Rotation)

◆ component

int occ::opt::Primitive::component {0}

Cartesian, Translation, Rotation: 0, 1, 2.

◆ direction

Vec3 occ::opt::Primitive::direction {Vec3::Zero()}

LinearBend: e; linear Rotation: axis e.

◆ kind

Kind occ::opt::Primitive::kind

◆ linear_fragment

bool occ::opt::Primitive::linear_fragment {false}

Rotation of a linear fragment.

◆ reference

Mat3N occ::opt::Primitive::reference

Rotation: centred reference positions.

◆ scale

double occ::opt::Primitive::scale {1.0}

Rotation: radius of gyration of the reference.


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