Difference between revisions of "Kinetics.m"

From Spinach Documentation Wiki
Jump to: navigation, search
Line 1: Line 1:
−
Returns the chemical kinetics superoperator for the current spin system. Syntax:
+
{{DISPLAYTITLE:kinetics.m}}
 +
Chemical kinetics superoperator.
 +
 
 +
==Syntax==
  
 
     K=kinetics(spin_system)
 
     K=kinetics(spin_system)
  
−
This function has no adjustable parameters -- all chemical reaction properties are suppl;ied at the spin system specificatino stage, see the [[chemical kinetics parameters]] section.
+
==Arguments==
 +
 
 +
    spin_system  - Spinach spin system description object
 +
                    produced as described in the [[spin system]]
 +
                    and [[basis]] specification sections, of the
 +
                    of the online manual. All adjustable pa-
 +
                    rameters are described in the chemical  
 +
                    kinetics parameters [[chemical_kinetics_parameters|section]].
 +
 
 +
==Outputs==
 +
 
 +
    output  - description of the output
 +
 +
    output  - description of the output
 +
              description of the output
 +
 
 +
==Examples==
 +
A description of what is done in the example below:
 +
 
 +
    % Comment
 +
    matlab code
 +
 +
    % Comment
 +
    matlab code
 +
 
 +
==Notes==
 +
Reasonable further notes on good and bad practices.
 +
 
 +
==See also==
 +
Links to related functions.
  
  
−
''Version 1.10, authors: [[Ilya Kuprov]], [[Luke Edwards]], [[Hannah Hogben]]''
+
''Version 2.2, authors: [[Ilya Kuprov]], [[Luke Edwards]], [[Hannah Hogben]]''

Revision as of 10:11, 30 August 2018

Chemical kinetics superoperator.

Syntax

    K=kinetics(spin_system)

Arguments

   spin_system  -  Spinach spin system description object
                   produced as described in the spin system
                   and basis specification sections, of the
                   of the online manual. All adjustable pa-
                   rameters are described in the chemical 
                   kinetics parameters section.

Outputs

    output  - description of the output

    output  - description of the output
              description of the output

Examples

A description of what is done in the example below:

    % Comment
    matlab code

    % Comment
    matlab code

Notes

Reasonable further notes on good and bad practices.

See also

Links to related functions.


Version 2.2, authors: Ilya Kuprov, Luke Edwards, Hannah Hogben