Difference between revisions of "Corrfun.m"

From Spinach Documentation Wiki
Jump to: navigation, search
 
(Update function See also links and function index membership)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Rotational correlation function, normalized to be the correlation func-
+
{{DISPLAYTITLE:corrfun.m}} __NOTOC__
−
tion between second rank Wigner functions. Syntax:
+
Wigner matrix element correlation function under isotropic, axial, and rhombic rotational diffusion.
  
−
              [weights,rates]=corrfun(spin_system,k,m,p,q)
+
==Syntax==
  
−
where the indices k,m,p,q correspond to the four indices found in the
+
    [weights,rates,states]=corrfun(spin_system,n,k,m,p,q)
−
ensemble-averaged Wigner function product:
 
  
−
                        G=<D2(k,m)'*D2(p,q)>
+
==Parameters==
  
−
the function requires spin_system.rlx.tau_c to be either a single cor-
+
    spin_system  - the output of [[create.m]] to which ro-
−
relation time (in which case the isotropic rotational diffusion model
+
                    tational correlation time should have
−
is used) or vector with two correlation times (in which case they are
+
                    been supplied. For a single correlation
−
assumed to be correlation times for rotation around and perpendicular-
+
                    time, the isotropic rotational diffusi-
−
ly to the main axis respectively) or vector with three correlation ti-
+
                    on model is used; a vector with two
−
mes (in which case those are assumed to be the correlation times for
+
                    correlation times is assumed to be cor-
−
the rotation around the XX, YY and ZZ direction respectively of the
+
                    relation times for rotation around and
−
rotational diffusion tensor).
+
                    perpendicularly to the main axis res-
 +
                    pectively); a vector with three corre-
 +
                    lation times is assumed to be the cor-
 +
                    relation times for the rotation around
 +
                    the XX, YY and ZZ direction respecti-
 +
                    vely of the rotational diffusion tensor.
 +
 +
      n,k,m,p,q  - the five indices found in the ensemble-
 +
                    averaged Wigner function product:
 +
 +
                          <D{n}{k,m}(0)*D{n}{p,q}(t)'>
  
−
The function returns the weights and decay rates of the individual ex-
+
==Outputs==
−
ponentials in the correlation function. Note that the decay rates re-
 
−
turned are negative numbers.
 
  
−
Note: Wigner function indices are sorted in descending order, that is,
+
      weights    - a cell array (one element for each che-
−
[1 2 3 4 5] in the input maps onto [2 1 0 -1 -2].
+
                    mical species) of vectors listing the
 +
                    weights of the exponential components
 +
                    of the decays
 +
 +
      rates      - a cell array (one element for each che-
 +
                    mical species) of vectors listing the
 +
                    decay rates (negative numbers) of the
 +
                    exponential components of the decays
 +
 +
      states      - a cell array (one element for each che-
 +
                    mical species) of logical vectors indi-
 +
                    cating which states in the basis set
 +
                    belong to which chemical species
 +
 
 +
==Notes==
 +
# Wigner function indices are sorted in descending order, that is, k=[1 2 3 4 5] in the input represents [2 1 0 -1 -2] for n=2.
 +
# Second rank rotational correlation times (as per Spinach input) will be updated automatically if other ranks are specified.
 +
 
 +
==See also==
 +
[[relaxation.m]], [[lindbladian.m]], [[rwalk.m]], [[create.m]], [[adelim.m]], [[blinv.m]], [[blprod.m]], [[fdhess.m]], [[fdkup.m]], [[fdlap.m]], [[fdmat.m]], [[fdvec.m]], [[fdweights.m]], [[fpl2phan.m]], [[fpl2rho.m]], [[hydrodynamics.m]], [[interpmat.m]], [[magpump.m]], [[ngce.m]], [[oscillator.m]], [[overwound.m]], [[phan2fpl.m]], [[qxspen_kernel.m]], [[rlx_scalar.m]], [[rlx_split.m]], [[rlx_t1_t2.m]], [[sec2kite.m]], [[spden.m]], [[Kernel_utilities]]
 +
 
 +
''Version 2.3, authors: [[Ilya Kuprov]]''

Latest revision as of 19:35, 6 June 2026

Wigner matrix element correlation function under isotropic, axial, and rhombic rotational diffusion.

Syntax

    [weights,rates,states]=corrfun(spin_system,n,k,m,p,q)

Parameters

    spin_system  - the output of create.m to which ro-
                   tational correlation time should have 
                   been supplied. For a single correlation
                   time, the isotropic rotational diffusi-
                   on model is used; a vector with two
                   correlation times is assumed to be cor-
                   relation times for rotation around and
                   perpendicularly to the main axis res-
                   pectively); a vector with three corre-
                   lation times is assumed to be the cor-
                   relation times for the rotation around
                   the XX, YY and ZZ direction respecti-
                   vely of the rotational diffusion tensor.

     n,k,m,p,q   - the five indices found in the ensemble-
                   averaged Wigner function product:

                         <D{n}{k,m}(0)*D{n}{p,q}(t)'>

Outputs

     weights     - a cell array (one element for each che-
                   mical species) of vectors listing the 
                   weights of the exponential components
                   of the decays

     rates       - a cell array (one element for each che-
                   mical species) of vectors listing the 
                   decay rates (negative numbers) of the
                   exponential components of the decays

     states      - a cell array (one element for each che-
                   mical species) of logical vectors indi-
                   cating which states in the basis set
                   belong to which chemical species

Notes

  1. Wigner function indices are sorted in descending order, that is, k=[1 2 3 4 5] in the input represents [2 1 0 -1 -2] for n=2.
  2. Second rank rotational correlation times (as per Spinach input) will be updated automatically if other ranks are specified.

See also

relaxation.m, lindbladian.m, rwalk.m, create.m, adelim.m, blinv.m, blprod.m, fdhess.m, fdkup.m, fdlap.m, fdmat.m, fdvec.m, fdweights.m, fpl2phan.m, fpl2rho.m, hydrodynamics.m, interpmat.m, magpump.m, ngce.m, oscillator.m, overwound.m, phan2fpl.m, qxspen_kernel.m, rlx_scalar.m, rlx_split.m, rlx_t1_t2.m, sec2kite.m, spden.m, Kernel_utilities

Version 2.3, authors: Ilya Kuprov