Difference between revisions of "Solid effect.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Created page with "Solid effect DNP experiment. Computes either the time dependence of the longitudinal magnetization in the system or its asymptotic amplitude. Syntax: answer=so...")
 
(Update function See also links and function index membership)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Solid effect DNP experiment. Computes either the time dependence of the
+
{{DISPLAYTITLE:solid_effect.m}} __NOTOC__
longitudinal magnetization in the system or its asymptotic amplitude.
+
Solid effect DNP experiment, computed using the large-scale formalism described in (http://dx.doi.org/10.1039/C2CP23233B). The system is restricted to one electron and one nucleus type, but the number of nuclei may be very large.
Syntax:
 
  
              answer=solid_effect(spin_system,parameters)
+
==Syntax==
 
 
Parameters:
 
  
        parameters.mw_power  - microwave power in rad/s
+
    answer=solid_effect(spin_system,parameters)
  
 +
==Parameters==
 +
 
 +
          parameters.mw_pwr  - microwave power in rad/s
 +
 
           parameters.theory  - level of theory. Set to 'exact' for  
 
           parameters.theory  - level of theory. Set to 'exact' for  
 
                                 the electron rotating frame calcula-
 
                                 the electron rotating frame calcula-
Line 18: Line 19:
 
                                 'ah_third_order', 'kb_first_order',
 
                                 'ah_third_order', 'kb_first_order',
 
                                 'kb_second_order', 'kb_third_order'.
 
                                 'kb_second_order', 'kb_third_order'.
                                 See the header of average.m functi-
+
                                 See [[average.m]] function for the mea-
                                 on for the meaning of these options.
+
                                 ning of these options.
 
+
 
       parameters.nuclear_frq  - nuclear Zeeman frequency in rad/s
 
       parameters.nuclear_frq  - nuclear Zeeman frequency in rad/s
 
+
 
         parameters.calc_type  - set to 'time_dependence' to get the  
 
         parameters.calc_type  - set to 'time_dependence' to get the  
 
                                 time dependence of the longitudinal
 
                                 time dependence of the longitudinal
Line 28: Line 29:
 
                                 to get the asymptotic longitudinal
 
                                 to get the asymptotic longitudinal
 
                                 magnetization.
 
                                 magnetization.
 
+
 
         parameters.time_step  - if 'time_dependence' is set in the
 
         parameters.time_step  - if 'time_dependence' is set in the
 
                                 calc_type parameter, sets the time
 
                                 calc_type parameter, sets the time
 
                                 step, seconds.
 
                                 step, seconds.
 
+
 
           parameters.n_steps  - if 'time_dependence' is set in the
 
           parameters.n_steps  - if 'time_dependence' is set in the
 
                                 calc_type parameter, sets the num-
 
                                 calc_type parameter, sets the num-
 
                                 ber of time steps.
 
                                 ber of time steps.
  
Note: the system must have exactly one electron.
+
==Outputs==
 +
 
 +
      answer  -  with the 'time_dependence' calculation type, the
 +
                function returns the observables detected using
 +
                the coil states specified at each point in time;
 +
                with the 'steady_state' option specified, the
 +
                function returns the steady state values detec-
 +
                ted using the coil states specified.
 +
 
 +
==Examples==
 +
The following figure is returned by examples/dnp_solids/solid_effect_timedep_1.m function:
 +
 
 +
[[File:dnp_example_4.png]]
 +
 
 +
==Notes==
 +
# This function generates its own Liouvillian and should be called directly, without a context wrapper.
 +
 
 +
==See also==
 +
[[average.m]], [[beamdnp.m]], [[dnp_field_scan.m]], [[dnp_freq_scan.m]], [[dnp_time_dep.m]], [[masdnp.m]], [[noveldnp.m]], [[noveldnp_steady.m]], [[topdnp.m]], [[xixdnp.m]], [[xixdnp_steady.m]], [[Built-in_experiments]]
  
Note: this function generates its own Liouvillian and should be called
+
''Version 2.5, authors: [[Ilya Kuprov]], [[Walter Kockenberger]], [[Alexander Karabanov]]''
directly, without "liquid", "powder", or other wrappers.
 

Latest revision as of 19:41, 6 June 2026

Solid effect DNP experiment, computed using the large-scale formalism described in (http://dx.doi.org/10.1039/C2CP23233B). The system is restricted to one electron and one nucleus type, but the number of nuclei may be very large.

Syntax

    answer=solid_effect(spin_system,parameters)

Parameters

          parameters.mw_pwr   - microwave power in rad/s

          parameters.theory   - level of theory. Set to 'exact' for 
                                the electron rotating frame calcula-
                                tion or to any of the following six 
                                options for the average Hamiltonian
                                theory calculation on top of the el-
                                ectron + nuclear rotating frame:
                                'ah_first_order', 'ah_second_order',
                                'ah_third_order', 'kb_first_order',
                                'kb_second_order', 'kb_third_order'.
                                See average.m function for the mea-
                                ning of these options.

     parameters.nuclear_frq   - nuclear Zeeman frequency in rad/s

       parameters.calc_type   - set to 'time_dependence' to get the 
                                time dependence of the longitudinal
                                magnetization and to 'steady_state'
                                to get the asymptotic longitudinal
                                magnetization.

       parameters.time_step   - if 'time_dependence' is set in the
                                calc_type parameter, sets the time
                                step, seconds.

         parameters.n_steps   - if 'time_dependence' is set in the
                                calc_type parameter, sets the num-
                                ber of time steps.

Outputs

     answer  -  with the 'time_dependence' calculation type, the 
                function returns the observables detected using 
                the coil states specified at each point in time;
                with the 'steady_state' option specified, the 
                function returns the steady state values detec-
                ted using the coil states specified.

Examples

The following figure is returned by examples/dnp_solids/solid_effect_timedep_1.m function:

Dnp example 4.png

Notes

  1. This function generates its own Liouvillian and should be called directly, without a context wrapper.

See also

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

Version 2.5, authors: Ilya Kuprov, Walter Kockenberger, Alexander Karabanov