Difference between revisions of "Dnp field scan.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(See also)
(Update function See also links and function index membership)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
Magnetic field scan steady-state DNP experiment.  
+
{{DISPLAYTITLE:dnp_field_scan.m}} __NOTOC__
 
+
Magnetic field scan steady-state DNP experiment. Returns the steady-state population of the user-specified state as a function of magnetic field.
==Description==
 
Returns the steady-state population of the user-specified state as a function of magnetic field.
 
  
 
==Syntax==
 
==Syntax==
  
     answer=dnp_field_scan(spin_system,parameters,H,R,K)
+
     dnp=dnp_field_scan(spin_system,parameters,H,R,K)
  
This function should normally be called via [[powder.m]] or [[crystal.m]] wrapper.
+
==Parameters==
 
 
==Arguments==
 
  
 
     parameters.mw_pwr      -  microwave power, Hz
 
     parameters.mw_pwr      -  microwave power, Hz
 
   
 
   
     parameters.mw_frq      -  microwave frequency, Hz
+
     parameters.mw_frq      -  microwave frequency offset from
 +
                                the free electron frequency at
 +
                                the reference B0 field, Hz
 
   
 
   
     parameters.fields      -  a vector of B0 field values, T
+
     parameters.fields      -  a vector of magnetic field off-
 +
                                sets from the reference B0 field,
 +
                                Tesla
 
   
 
   
     parameters.rho_eq      thermal equilibrium state
+
     parameters.rho0        -  equilibrium state at the reference
 +
                                B0 field
 
   
 
   
 
     parameters.coil        -  detection state vector or a horizon-
 
     parameters.coil        -  detection state vector or a horizon-
Line 31: Line 32:
 
                                 to use ILU preconditioned GMRES
 
                                 to use ILU preconditioned GMRES
 
   
 
   
     H                     -   Hamiltonian commutation superoperator
+
     H - Hamiltonian matrix, received from context function
 
   
 
   
     R                     -   unthermalised relaxation superoperator  
+
     R - relaxation superoperator, received from context function
 
   
 
   
     K                     -   chemical kinetics superoperator
+
     K - kinetics superoperator, received from context function
  
 
==Returns==
 
==Returns==
  
     answer                -   the projection of the equilibrium density matrix
+
     dnp    - an array of the steady state amplitudes of the
                                on the user-specified state as a function of the
+
              states specified in parameters.coil as at each
                                applied magnetic field
+
              of the magnetic fields supplied
  
 
==Examples==
 
==Examples==
Line 56: Line 57:
 
# Thermal equilibrium state is assumed to be the same at all fields in the sweep. Do not use this function for broad magnetic field sweep experiments.
 
# Thermal equilibrium state is assumed to be the same at all fields in the sweep. Do not use this function for broad magnetic field sweep experiments.
 
# Backslash method is recommended for small spin systems and GMRES method for large ones.
 
# Backslash method is recommended for small spin systems and GMRES method for large ones.
# This function can be made to run on GPUs. If you would like that functionality added, send an email to [[Ilya Kuprov]].
 
  
 
==See also==
 
==See also==
[[dnp_freq_scan.m]], [[masdnp.m]], [[solid_effect.m]]
+
[[beamdnp.m]], [[dnp_freq_scan.m]], [[dnp_time_dep.m]], [[masdnp.m]], [[noveldnp.m]], [[noveldnp_steady.m]], [[solid_effect.m]], [[topdnp.m]], [[xixdnp.m]], [[xixdnp_steady.m]], [[Built-in_experiments]]
 
 
  
''Revision 3284, authors: [[Ilya Kuprov]], [[Walter Kockenberger]], [[Alexander Karabanov]]''
+
''Version 2.5, authors: [[Ilya Kuprov]], [[Walter Kockenberger]], [[Alexander Karabanov]], [[Maria Grazia Concilio]]''

Latest revision as of 19:36, 6 June 2026

Magnetic field scan steady-state DNP experiment. Returns the steady-state population of the user-specified state as a function of magnetic field.

Syntax

    dnp=dnp_field_scan(spin_system,parameters,H,R,K)

Parameters

    parameters.mw_pwr      -   microwave power, Hz

    parameters.mw_frq      -   microwave frequency offset from 
                               the free electron frequency at 
                               the reference B0 field, Hz

    parameters.fields      -   a vector of magnetic field off-
                               sets from the reference B0 field,
                               Tesla

    parameters.rho0        -   equilibrium state at the reference
                               B0 field

    parameters.coil        -   detection state vector or a horizon-
                               tal stack thereof

    parameters.mw_oper     -   microwave irradiation operator

    parameters.ez_oper     -   Lz operator on the electrons

    parameters.method      -   'backslash' to use Matlab's
                               linear equation solver, 'gmres'
                               to use ILU preconditioned GMRES

    H - Hamiltonian matrix, received from context function

    R - relaxation superoperator, received from context function

    K - kinetics superoperator, received from context function

Returns

    dnp    -  an array of the steady state amplitudes of the
              states specified in parameters.coil as at each
              of the magnetic fields supplied

Examples

Cross effect in a system with two spin-1/2 electrons (cross_effect_field_scan_1.m example file in examples/dnp_solids directory):

Dnp example 1.png

Solid effect in a system with a spin-7/2 gadolinium ion (solid_effect_field_scan_1.m example file in examples/dnp_solids directory):

Dnp example 2.png

Notes

  1. The relaxation superoperator supplied to this function should NOT be thermalized.
  2. Thermal equilibrium state is assumed to be the same at all fields in the sweep. Do not use this function for broad magnetic field sweep experiments.
  3. Backslash method is recommended for small spin systems and GMRES method for large ones.

See also

beamdnp.m, dnp_freq_scan.m, dnp_time_dep.m, masdnp.m, noveldnp.m, noveldnp_steady.m, solid_effect.m, topdnp.m, xixdnp.m, xixdnp_steady.m, Built-in_experiments

Version 2.5, authors: Ilya Kuprov, Walter Kockenberger, Alexander Karabanov, Maria Grazia Concilio