vibe-sketcherDocumentation

vibesketcher.document.counterpoise_recipes

Counterpoise-corrected finite-cluster binding recipes (#243).

The binding recipe of vibesketcher.document.electrochemical_recipes with counterpoise: true. Boys and Bernardi, Mol. Phys. 19, 553 (1970), doi:10.1080/00268977000101561 (the formulas are in vibesketcher.document.counterpoise). Every job is an ordinary recorded job; the fragment jobs are on the complex species, so their geometry is the complex’s by construction, and the fragment mask travels in JobSpec.fragment through the job, its imported result and the saved document.

Jobs, for complex AB with fragments A (cluster) and B (adsorbate):

job id

species / fragment

energy

<id>-<AB>

AB

E_AB^AB(AB)

<id>-<A>-cp

AB, real A, B as ghosts

E_A^AB(AB)

<id>-<A>-own

AB, real A, B left out

E_A^A(AB)

<id>-<A>

A at its own geometry

E_A^A(A), with deformation

and the same for B.

Functions

counterpoise_jobs(identifier, analysis, spec)

(job id, species, role, specification) for every job of the recipe, in order.

counterpoise_result(document, identifier, ...)

CP-corrected and uncorrected interaction (and binding) energies from chosen runs.

fragment_mapping_refusals(document, analysis)

Why the fragments are not an explicit partition of the complex's atoms.

spec_refusals(spec)

What a counterpoise recipe's specification may not carry.

vibesketcher.document.counterpoise_recipes.counterpoise_jobs(identifier, analysis, spec)[source]

(job id, species, role, specification) for every job of the recipe, in order.

Parameters:
  • identifier (str)

  • analysis (BindingAnalysis)

  • spec (JobSpec)

Return type:

list[tuple[str, str, str, JobSpec]]

vibesketcher.document.counterpoise_recipes.counterpoise_result(document, identifier, analysis, calculation, runs)[source]

CP-corrected and uncorrected interaction (and binding) energies from chosen runs.

Parameters:
  • document (Document)

  • identifier (str)

  • analysis (BindingAnalysis)

  • calculation (CalculationStage)

  • runs (list[str])

Return type:

dict[str, Any]

vibesketcher.document.counterpoise_recipes.fragment_mapping_refusals(document, analysis)[source]

Why the fragments are not an explicit partition of the complex’s atoms.

Parameters:
  • document (Document)

  • analysis (BindingAnalysis)

Return type:

list[str]

vibesketcher.document.counterpoise_recipes.spec_refusals(spec)[source]

What a counterpoise recipe’s specification may not carry.

Parameters:

spec (JobSpec)

Return type:

list[str]