vibe-sketcherDocumentation

vibesketcher.document.counterpoise

Ghost centres and Boys–Bernardi counterpoise jobs for finite clusters (#243).

Boys and Bernardi, Mol. Phys. 19, 553 (1970), doi:10.1080/00268977000101561: the interaction of A and B is taken as a difference of energies all computed in the same basis, the basis of the complex AB at its geometry, so that the superposition of the partner’s functions lowers the fragment energies as much as it lowers the complex’s,

ΔE_int^CP = E_AB^AB(AB) − E_A^AB(AB) − E_B^AB(AB),

where the superscript is the basis and the argument the geometry. The uncorrected interaction at the same geometry uses each fragment’s own basis,

ΔE_int = E_AB^AB(AB) − E_A^A(AB) − E_B^B(AB),

and their difference is the basis-set superposition error,

BSSE = ΔE_int^CP − ΔE_int = [E_A^A(AB) − E_A^AB(AB)] + [E_B^B(AB) − E_B^AB(AB)],

which is positive when the partner’s functions lower the fragment’s energy.

The relaxation of each fragment from its free geometry to the complex’s, the deformation energy E_A^A(AB) − E_A^A(A), is a separate term, computed only when the recipe asks for the free fragments too.

A ghost centre carries its element’s basis functions (and, in ORCA, the contracted functions NewGTO assigns to that element), but no nuclear charge, no electrons, no ECP, no dispersion atom and no cavity atom. The fragment’s real atoms keep their nuclei; the fragment’s charge and multiplicity are stated explicitly. Fragment jobs are single points on the complex species’ first conformer, so a fragment can never be at a geometry other than the complex’s.

Functions

centre_record(species, fragment)

Per atom of the complex: its element and role, real, ghost or omitted.

fragment_refusals(species, fragment)

Why fragment is not a fragment job on species; empty if it is.

ghost_atoms(species, fragment)

The atoms of species that are ghost centres in this fragment job.

real_species(species, fragment)

The fragment's real atoms alone, with the fragment's charge and multiplicity.

vibesketcher.document.counterpoise.centre_record(species, fragment)[source]

Per atom of the complex: its element and role, real, ghost or omitted.

Parameters:
  • species (Species)

  • fragment (FragmentCentres | None)

Return type:

list[dict[str, Any]]

vibesketcher.document.counterpoise.fragment_refusals(species, fragment)[source]

Why fragment is not a fragment job on species; empty if it is.

Parameters:
  • species (Species)

  • fragment (FragmentCentres)

Return type:

list[str]

vibesketcher.document.counterpoise.ghost_atoms(species, fragment)[source]

The atoms of species that are ghost centres in this fragment job.

Every atom outside the fragment when the job is in the complex’s basis; none when it is in the fragment’s own basis (they are left out instead).

Parameters:
  • species (Species)

  • fragment (FragmentCentres)

Return type:

list[int]

vibesketcher.document.counterpoise.real_species(species, fragment)[source]

The fragment’s real atoms alone, with the fragment’s charge and multiplicity.

Writers check electron counts, element limits and core potentials against this; ghost centres are added only when the coordinates are written. Its SMILES and InChIKey are dropped: they are the complex’s, not the fragment’s.

Parameters:
  • species (Species)

  • fragment (FragmentCentres)

Return type:

Species