Difference between revisions of "Superop.m"
(Fix lead description from MATLAB header (folding/hyphenation pass)) |
(Sync syntax/arguments/outputs with current Spinach source) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:superop.m}} __NOTOC__ | {{DISPLAYTITLE:superop.m}} __NOTOC__ | ||
| + | |||
Sided product superoperator in the spherical tensor basis set. Returns superoperators corresponding to right or left multiplication of a density matrix by a user-specified operator. | Sided product superoperator in the spherical tensor basis set. Returns superoperators corresponding to right or left multiplication of a density matrix by a user-specified operator. | ||
==Syntax== | ==Syntax== | ||
| − | + | A=superop(spin_system,opspec,side) | |
==Arguments== | ==Arguments== | ||
| − | + | opspec - Spinach operator specification described in Sections 2.1 | |
and 3.3 of the following paper: | and 3.3 of the following paper: | ||
http://dx.doi.org/10.1016/j.jmr.2010.11.008 | http://dx.doi.org/10.1016/j.jmr.2010.11.008 | ||
| Line 18: | Line 19: | ||
==Outputs== | ==Outputs== | ||
| − | + | A - a three-column array of row indices (first column), | |
| − | + | column indices (second column) and values (third column). | |
| + | |||
| + | Note: this is a very general function to which direct calls are not | ||
| + | usually required - please use the (much friendlier) operator() | ||
| + | function. | ||
| + | |||
| + | Note: the superoperator is returned in XYZ sparse format, which is | ||
| + | different from Matlab's CSC format. | ||
| + | |||
| + | ilya.kuprov@weizmann.ac.il | ||
| + | hannah.hogben@chem.ox.ac.uk | ||
==Examples== | ==Examples== | ||
| + | |||
See examples in the Spinach distribution relevant to this function. | See examples in the Spinach distribution relevant to this function. | ||
==Notes== | ==Notes== | ||
| + | |||
This page was generated from the function header in the Spinach repository. | This page was generated from the function header in the Spinach repository. | ||
==See also== | ==See also== | ||
| + | |||
* [[oper2ist.m]] | * [[oper2ist.m]] | ||
* [[oper2bm.m]] | * [[oper2bm.m]] | ||
Revision as of 15:06, 5 April 2026
Sided product superoperator in the spherical tensor basis set. Returns superoperators corresponding to right or left multiplication of a density matrix by a user-specified operator.
Syntax
A=superop(spin_system,opspec,side)
Arguments
opspec - Spinach operator specification described in Sections 2.1
and 3.3 of the following paper:
http://dx.doi.org/10.1016/j.jmr.2010.11.008
side - 'left' or 'right' causes the function to return a product
superoperator corresponding to a product from that side;
'comm' or 'acomm' results in commutation and anticommuta-
tion superoperator respectively.
Outputs
A - a three-column array of row indices (first column),
column indices (second column) and values (third column).
Note: this is a very general function to which direct calls are not
usually required - please use the (much friendlier) operator()
function.
Note: the superoperator is returned in XYZ sparse format, which is
different from Matlab's CSC format.
ilya.kuprov@weizmann.ac.il hannah.hogben@chem.ox.ac.uk
Examples
See examples in the Spinach distribution relevant to this function.
Notes
This page was generated from the function header in the Spinach repository.
See also
Version 2.11, authors: Ilya Kuprov, Hannah Hogben
