votca 2026-dev
Loading...
Searching...
No Matches
votca::xtp::ActiveRegion Class Reference

Checks and grows the active region of a projection-based embedding from the frontier orbitals of the full reference calculation. More...

#include <activeregion.h>

Classes

struct  Options
struct  Report

Static Public Member Functions

static std::vector< std::vector< Index > > BondGraph (const QMMolecule &mol)
 Bonded neighbours of each atom (covalent radii, factor 1.2).
static Eigen::MatrixXd AtomPopulations (const Orbitals &orb, const Eigen::MatrixXd &mos)
static void CheckConnected (const QMMolecule &mol, const std::vector< Index > &active)
 Throws unless the active atoms of every molecule (connected component of the bond graph) form a single connected piece: a region that splits a molecule cuts it in more places than intended. Several molecules, each partly or fully active, are fine.
static Report Evaluate (const Orbitals &full, const std::vector< Index > &active, const Options &options)
 Checks the input region, and with options.grow adds every atom whose population in a frontier orbital exceeds the threshold, in the molecules that have active atoms, with the shortest bond path that connects it to the region (so the region stays connected); then heavy atoms bonded to two or more active atoms (so that no atom is cut out of the region by several bonds), and all hydrogens bonded to active atoms. full must hold the MOs of the full reference calculation.

Detailed Description

Checks and grows the active region of a projection-based embedding from the frontier orbitals of the full reference calculation.

Atoms are indexed by their position in Orbitals::QMAtoms(); the dft_in_dft.activeatoms indices are these positions.

Without a truncated basis the embedded virtual space is the full one, so only the occupied frontier orbitals decide whether an excitation fits into the active region (its holes must lie there). With a truncated basis the virtual frontier orbitals count as well.

Definition at line 47 of file activeregion.h.

Member Function Documentation

◆ AtomPopulations()

Eigen::MatrixXd votca::xtp::ActiveRegion::AtomPopulations ( const Orbitals & orb,
const Eigen::MatrixXd & mos )
static

Mulliken population of each atom (rows) in each orbital (columns) of mos (AO coefficients as columns).

Definition at line 58 of file activeregion.cc.

◆ BondGraph()

std::vector< std::vector< Index > > votca::xtp::ActiveRegion::BondGraph ( const QMMolecule & mol)
static

Bonded neighbours of each atom (covalent radii, factor 1.2).

Definition at line 38 of file activeregion.cc.

◆ CheckConnected()

void votca::xtp::ActiveRegion::CheckConnected ( const QMMolecule & mol,
const std::vector< Index > & active )
static

Throws unless the active atoms of every molecule (connected component of the bond graph) form a single connected piece: a region that splits a molecule cuts it in more places than intended. Several molecules, each partly or fully active, are fine.

Definition at line 106 of file activeregion.cc.

◆ Evaluate()

ActiveRegion::Report votca::xtp::ActiveRegion::Evaluate ( const Orbitals & full,
const std::vector< Index > & active,
const Options & options )
static

Checks the input region, and with options.grow adds every atom whose population in a frontier orbital exceeds the threshold, in the molecules that have active atoms, with the shortest bond path that connects it to the region (so the region stays connected); then heavy atoms bonded to two or more active atoms (so that no atom is cut out of the region by several bonds), and all hydrogens bonded to active atoms. full must hold the MOs of the full reference calculation.

Definition at line 142 of file activeregion.cc.


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