summary_pbc.m

Prints periodic boundary condition vector summary for a Spinach system. The function prints the user-supplied header and then a table with one row per translation vector stored in inter.pbc, giving its X, Y and Z components to three decimal places with an explicit sign. The table is bracketed by rule lines and the printing goes through report.m, so the output honours the destination and the silence settings stored in the spin system object. create.m calls this function with the header 'PBC translation vectors (Angstrom)' when periodic boundary conditions have been specified.

Syntax

    summary_pbc(spin_system,header)

Parameters

    spin_system  - Spinach spin system description object

    header       - a string of text to precede the summary

Outputs

    this function prints to the console or to the user-specified
    output via report.m function

Notes

create.m accepts zero, one, two or three linearly independent translation vectors in inter.pbc; they are subsequently used by dipolar.m to sum dipolar couplings over the periodic images of the lattice.

See also

create.m, report.m, dipolar.m, cubic_lattice.m, summary_coordinates.m, Kernel utilities

Version 2.13, authors: Ilya Kuprov