Difference between revisions of "Gridfree.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Restore pre-bulk-edit wiki content)
(sync with Spinach main f053e432: parameters block restructured per source header; tau_c tensor definition and spinning rate sign conventions added)
 
(4 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
==Syntax==
 
==Syntax==
  
−
     answer=gridfree(spin_system,@pulse_sequence,parameters,assumptions)
+
     answer=gridfree(spin_system,pulse_sequence,parameters,assumptions)
  
−
==Arguments==
+
==Parameters==
  
−
    @pulse_sequence     - pulse sequence function handle
+
    pulse_sequence - a function handle to one of the pulse sequences
 +
                    located in the experiments directory
 
   
 
   
−
    parameters.rate     - spinning rate in Hz
+
     assumptions    - is a string that would be passed to assume.m
 +
                    when the Hamiltonian is built
 
   
 
   
−
    parameters.axis     - spinning axis, given as a normalized
+
    parameters    - a structure with the following subfields:
−
                          3-element vector
 
 
   
 
   
−
    parameters.spins    - a cell array giving the spins that
+
        .rate    - spinning rate in Hz. Positive numbers
−
                          the pulse sequence involves, e.g.
+
                    for JEOL, negative for Varian and Bruker
−
                          {'1H','13C'}
+
                    due to different rotation directions.
 
   
 
   
−
    parameters.offset  - a cell array giving transmitter off-
+
        .axis    - spinning axis, given as a normalized
−
                          sets in Hz on each of the spins listed
+
                    3-element vector
−
                          in parameters.spins array
 
 
   
 
   
−
    parameters.max_rank - maximum D-function rank to retain in
+
        .spins    - a cell array giving the spins that
−
                          the solution (increase till conver-
+
                    the pulse sequence involves, e.g.
−
                          gence is achieved, approximately
+
                    {'1H','13C'}
−
                          equal to the number of spinning si-
 
−
                          debands in the spectrum)
 
 
   
 
   
−
    parameters.tau_c    - correlation times (in seconds) for rotational  
+
        .offset  - a cell array giving transmitter off-
−
                          diffusion. Single number for isotropic rotati-
+
                    sets in Hz on each of the spins listed
−
                          onal diffusion, and a 3x3 matrix for anisotro-
+
                    in parameters.spins array
−
                          pic rotational diffusion.  
+
−
 
+
        .max_rank - maximum D-function rank to retain in
−
    parameters.*        - additional subfields may be required by your
+
                    the solution (increase till conver-
−
                          pulse sequence - check its documentation page  
+
                    gence is achieved, approximately
 +
                    equal to the number of spinning si-
 +
                    debands in the spectrum)
 +
 +
        .tau_c    - correlation times (in seconds) for rotational
 +
                    diffusion. Single number for isotropic rotati-
 +
                    onal diffusion, and a symmetric positive defi-
 +
                    nite 3x3 correlation time tensor for anisotro-
 +
                    pic rotational diffusion; the rotational dif-
 +
                    fusion tensor is inv(6*tau_c).
 +
 +
        .*        - additional subfields may be required by your
 +
                    pulse sequence - check its documentation page  
  
 
Additional subfields may be required by the pulse sequence. The parameters structure is passed to the pulse sequence with the following additional parameters set:
 
Additional subfields may be required by the pulse sequence. The parameters structure is passed to the pulse sequence with the following additional parameters set:
Line 52: Line 62:
 
#Rotational correlation times for SLE go into parameters.tau_c, not inter.tau_c (the latter is only used by the Redfield theory module).
 
#Rotational correlation times for SLE go into parameters.tau_c, not inter.tau_c (the latter is only used by the Redfield theory module).
 
#The state projector assumes a powder - single crystal MAS is not supported, use [[singlerot.m]] instead.
 
#The state projector assumes a powder - single crystal MAS is not supported, use [[singlerot.m]] instead.
−
#Perturbative corrections to the rotating frame transformation are not supported - use [[singlerot.m]] instead.
+
#Perturbative corrections to the rotating frame transformation are not supported - use [[singlerot.m]] if you need them.
  
 
==See also==
 
==See also==
−
[[Kernel contexts]]
+
[[singlerot.m]], [[crystal.m]], [[doublerot.m]], [[floquet.m]], [[imaging.m]], [[liquid.m]], [[meshflow.m]], [[powder.m]], [[Kernel contexts]], [[Built-in_experiments]]
−
 
 
−
[[Built-in_experiments#Solid_state_NMR_experiments|Solid state NMR experiments]]
 
−
 
 
−
[[Built-in_experiments#ESR_experiments|ESR experiments]]
 
−
 
 
  
 
''Version 2.8, authors: [[Ilya Kuprov]]''
 
''Version 2.8, authors: [[Ilya Kuprov]]''

Latest revision as of 06:52, 30 August 2026

Fokker-Planck magic angle spinning and SLE context that uses full Wigner D-function basis and therefore solved directly for the powder average - a spherical grid is not required. This function generates the Fokker-Planck Hamiltonian, external relaxation superoperator, kinetics superoperator, applies the necessary offsets, updates the parameter set, and passes all of that to the pulse sequence, which should be supplied as a handle.

Syntax

    answer=gridfree(spin_system,pulse_sequence,parameters,assumptions)

Parameters

   pulse_sequence - a function handle to one of the pulse sequences
                    located in the experiments directory

   assumptions    - is a string that would be passed to assume.m 
                    when the Hamiltonian is built

   parameters     - a structure with the following subfields:

        .rate     - spinning rate in Hz. Positive numbers
                    for JEOL, negative for Varian and Bruker
                    due to different rotation directions.

        .axis     - spinning axis, given as a normalized
                    3-element vector

        .spins    - a cell array giving the spins that 
                    the pulse sequence involves, e.g. 
                    {'1H','13C'}

        .offset   - a cell array giving transmitter off-
                    sets in Hz on each of the spins listed
                    in parameters.spins array

        .max_rank - maximum D-function rank to retain in
                    the solution (increase till conver-
                    gence is achieved, approximately
                    equal to the number of spinning si-
                    debands in the spectrum)

        .tau_c    - correlation times (in seconds) for rotational
                    diffusion. Single number for isotropic rotati-
                    onal diffusion, and a symmetric positive defi-
                    nite 3x3 correlation time tensor for anisotro-
                    pic rotational diffusion; the rotational dif-
                    fusion tensor is inv(6*tau_c).

        .*        - additional subfields may be required by your
                    pulse sequence - check its documentation page 

Additional subfields may be required by the pulse sequence. The parameters structure is passed to the pulse sequence with the following additional parameters set:

    parameters.spc_dim  - matrix dimension for the spatial
                          dynamics subspace

    parameters.spn_dim  - matrix dimension for the spin 
                          dynamics subspace

Outputs

This function returns the powder average of whatever it is that the pulse sequence returns.

Notes

  1. The choice of the Wigner D function rank truncation level depends on on the spinning rate (the slower the spinning, the greater ranks are required). The rank should be set approximately equal to the expected number of spinning sidebands. For diffusive dynamics, increase till the answer stops changing.
  2. Rotational correlation times for SLE go into parameters.tau_c, not inter.tau_c (the latter is only used by the Redfield theory module).
  3. The state projector assumes a powder - single crystal MAS is not supported, use singlerot.m instead.
  4. Perturbative corrections to the rotating frame transformation are not supported - use singlerot.m if you need them.

See also

singlerot.m, crystal.m, doublerot.m, floquet.m, imaging.m, liquid.m, meshflow.m, powder.m, Kernel contexts, Built-in_experiments

Version 2.8, authors: Ilya Kuprov