Difference between revisions of "Kinetics.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Sync syntax/arguments/outputs with current Spinach source)
(sync with Spinach main f053e432: K output 1i*K usage note; relaxation and kinetics in context note)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:kinetics.m}} __NOTOC__
 
{{DISPLAYTITLE:kinetics.m}} __NOTOC__
−
 
 
Chemical kinetics superoperator.
 
Chemical kinetics superoperator.
  
 
==Syntax==
 
==Syntax==
  
−
K=kinetics(spin_system)
+
    K=kinetics(spin_system)
  
−
==Arguments==
+
==Parameters==
  
−
spin_system  -  Spinach spin system description object
+
    spin_system  -  Spinach spin system description object
 
                     produced as described in the [[spin_system_specification|spin system]]
 
                     produced as described in the [[spin_system_specification|spin system]]
 
                     and [[basis_set_specification|basis]] specification sections, of the
 
                     and [[basis_set_specification|basis]] specification sections, of the
Line 18: Line 17:
 
==Outputs==
 
==Outputs==
  
−
K            -  kinetics superoperator
+
    K            -  kinetics superoperator. If a Liouvillian is
−
 
+
                    assembled manually, this dissipative super-
−
Note: a large variety of chemical reaction models is supported,
+
                    operator must enter as 1i*K, for example
−
      see the chemical kinetics parameters section of the onli-
+
                    L=H+1i*R+1i*K
−
      ne manual.
 
−
 
 
−
Note: Spinach context functions include kinetics superoperators
 
−
      into the total Liovillian automatically.
 
−
 
 
−
ilya.kuprov@weizmann.ac.il
 
−
ledwards@cbs.mpg.de
 
−
hannah.hogben@chem.ox.ac.uk
 
  
 
==Notes==
 
==Notes==
−
 
 
# A large variety of chemical reaction models is supported, see the [[chemical kinetics parameters]] section of the online manual.
 
# A large variety of chemical reaction models is supported, see the [[chemical kinetics parameters]] section of the online manual.
−
# Spinach [[kernel_contexts|context functions]] include kinetics superoperators into the total Liovillian automatically.
+
# Spinach [[kernel_contexts|context functions]] include relaxation and kinetics superoperators into the total Liovillian automatically.
  
 
==See also==
 
==See also==
−
 
+
[[relaxation.m]], [[hamiltonian.m]], [[lindbladian.m]], [[magpump.m]], [[bos2ist.m]], [[boson_mono.m]], [[boson_ortho.m]], [[centrans.m]], [[ct2ist.m]], [[enlev2bm.m]], [[enlev2ist.m]], [[equilibrate.m]], [[flow_gen.m]], [[oper2bm.m]], [[oper2ist.m]], [[operator.m]], [[orientation.m]], [[propagator.m]], [[react_gen.m]], [[sin_tran.m]], [[weyl.m]], [[Kernel_functions]], [[Kernel_utilities]]
−
[[relaxation.m]], [[hamiltonian.m]], [[lindbladian.m]], [[magpump.m]]
 
−
 
 
  
 
''Version 2.2, authors: [[Ilya Kuprov]], [[Luke Edwards]], [[Hannah Hogben]]''
 
''Version 2.2, authors: [[Ilya Kuprov]], [[Luke Edwards]], [[Hannah Hogben]]''

Latest revision as of 06:52, 30 August 2026

Chemical kinetics superoperator.

Syntax

    K=kinetics(spin_system)

Parameters

   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

   K            -  kinetics superoperator. If a Liouvillian is
                   assembled manually, this dissipative super-
                   operator must enter as 1i*K, for example 
                   L=H+1i*R+1i*K

Notes

  1. A large variety of chemical reaction models is supported, see the chemical kinetics parameters section of the online manual.
  2. Spinach context functions include relaxation and kinetics superoperators into the total Liovillian automatically.

See also

relaxation.m, hamiltonian.m, lindbladian.m, magpump.m, bos2ist.m, boson_mono.m, boson_ortho.m, centrans.m, ct2ist.m, enlev2bm.m, enlev2ist.m, equilibrate.m, flow_gen.m, oper2bm.m, oper2ist.m, operator.m, orientation.m, propagator.m, react_gen.m, sin_tran.m, weyl.m, Kernel_functions, Kernel_utilities

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