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
|
Atom, charge and site balances of a step and the reservoirs that close them. |
|
Every reason the scheme cannot be held; empty when it can. |
|
|
|
Atoms per formula unit, derived from the structure when not stated. |
|
|
|
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.
balancedis true when every quantity balances or has a stated reservoir;refusalssay why not.- Parameters:
step (SolidStep)
participants (Mapping[str, SolidParticipant])
structures (Mapping[str, PeriodicStructure])
- Return type:
- vibesketcher.document.solid_balance.check_scheme(participants, steps, structures, species)[source]¶
Every reason the scheme cannot be held; empty when it can.
speciesmaps molecular species IDs to their charges.
- vibesketcher.document.solid_balance.participant_charge(participant, structures)[source]¶
- Parameters:
participant (SolidParticipant)
structures (Mapping[str, PeriodicStructure])
- Return type:
- 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
atomsis a formula unit: the structure’s composition must be a whole multiple of it.- Parameters:
participant (SolidParticipant)
structures (Mapping[str, PeriodicStructure])
- Return type:
- vibesketcher.document.solid_balance.participant_sites(participant)[source]¶
- Parameters:
participant (SolidParticipant)
- Return type:
- 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_imagesays whether the stated image is the shortest of the translations to the end site; a longer one is kept as stated, never wrapped.