vibe-sketcherDocumentation

vibesketcher.document.solid_balance

Atom, charge and site balances of solid reaction steps; periodic site hops (#192).

The data model is vibesketcher.document.solid_reaction_model. Counting sites per site type follows Kröger-Vink notation (Kröger and Vink, Solid State Phys. 3, 307 (1956)): a vacancy still occupies its lattice site.

Functions

balance(step, participants, structures)

Atom, charge and site balances of a step and the reservoirs that close them.

check_scheme(participants, steps, ...)

Every reason the scheme cannot be held; empty when it can.

participant_charge(participant, structures)

participant_formula(participant, structures)

Atoms per formula unit, derived from the structure when not stated.

participant_sites(participant)

site_hops(step, participants, structures)

Each site-map entry resolved: start and end sites, image and hop vector (angstrom).

vibesketcher.document.solid_balance.balance(step, participants, structures)[source]

Atom, charge and site balances of a step and the reservoirs that close them.

Imbalance is products minus reactants. balanced is true when every quantity balances or has a stated reservoir; refusals say why not.

Parameters:
Return type:

dict[str, Any]

vibesketcher.document.solid_balance.check_scheme(participants, steps, structures, species)[source]

Every reason the scheme cannot be held; empty when it can.

species maps molecular species IDs to their charges.

Parameters:
Return type:

list[str]

vibesketcher.document.solid_balance.participant_charge(participant, structures)[source]
Parameters:
Return type:

int

vibesketcher.document.solid_balance.participant_formula(participant, structures)[source]

Atoms per formula unit, derived from the structure when not stated.

A stated formula of a structure-backed participant without atoms is a formula unit: the structure’s composition must be a whole multiple of it.

Parameters:
Return type:

dict[str, int]

vibesketcher.document.solid_balance.participant_sites(participant)[source]
Parameters:

participant (SolidParticipant)

Return type:

dict[str, int]

vibesketcher.document.solid_balance.site_hops(step, participants, structures)[source]

Each site-map entry resolved: start and end sites, image and hop vector (angstrom).

minimum_image says whether the stated image is the shortest of the translations to the end site; a longer one is kept as stated, never wrapped.

Parameters:
Return type:

list[dict[str, Any]]