summary_mode_coup.m

From Spinach Documentation Wiki
Jump to: navigation, search

Prints bosonic mode coupling summary for a Spinach system. This covers mode-mode exchange couplings, cross-Kerr couplings, spin-mode exchange couplings, longitudinal and radiation pressure couplings, and dispersive couplings. The function prints the user-supplied header and then a table with one row per non-empty entry of the inter.modes.exchange, inter.modes.kerr, inter.modes.longitudinal and inter.modes.dispersive cell arrays, in that order. Each row gives the indices of the two particles involved, the coupling type, and the coupling amplitude in Hz, obtained by dividing the internally stored rad/s value by 2*pi. Entries of the longitudinal array are labelled 'radiation pressure' when both particles are bosonic modes, that is when both of their comp.types entries are 'C', 'V' or 'T', and 'longitudinal' otherwise. Printing goes through report.m. create.m calls this function with the header 'summary of bosonic mode couplings (Hz)' when a mode coupling block is present.

Syntax

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

Only the couplings actually stored in the spin system object are printed; empty cells are skipped, so the length of the table reflects the sparsity of the mode coupling specification.

See also

create.m, report.m, summary_modes.m, summary_mode_mods.m, Kernel utilities

Version 2.13, authors: Ilya Kuprov