summary_mode_mods.m

From Spinach Documentation Wiki
Jump to: navigation, search

Prints the summary of spin Hamiltonian modulation by bosonic mode coordinates: derivatives of spin-spin coupling tensors and of effective local fields with respect to dimensionless mode displacement coordinates. The function prints the user-supplied header and then walks the inter.modes.coupling_mod and inter.modes.zeeman_mod cell arrays. For each non-empty mode pair, and within it for each non-empty derivative order, every stored derivative is printed on its own row giving the two mode indices, the derivative order, the modulation target, and the norm of the derivative in Hz. For coupling tensor derivatives the target is written as 'coupling {i,j}' with the spin pair indices, and the norm reported is the Frobenius norm of the 3x3 derivative matrix. For effective field derivatives the target is written as 'field, spin i' and the norm reported is the 2-norm of the derivative vector. In both cases the internally stored rad/s values are divided by 2*pi. Printing goes through report.m. create.m calls this function with the header 'summary of spin Hamiltonian modulation by modes'.

Syntax

    summary_mode_mods(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

The derivatives summarised here are taken with respect to dimensionless mode displacement coordinates; cart2mode.m converts Cartesian derivatives of spin interactions into that representation.

See also

create.m, report.m, cart2mode.m, summary_modes.m, summary_mode_coup.m, Kernel utilities

Version 2.13, authors: Ilya Kuprov