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...")
 
Line 1: Line 1:
Solid effect DNP experiment. Computes either the time dependence of the
+
Solid effect DNP experiment.  
longitudinal magnetization in the system or its asymptotic amplitude.
 
Syntax:
 
  
              answer=solid_effect(spin_system,parameters)
+
==Syntax==
 
 
Parameters:
 
  
        parameters.mw_power  - microwave power in rad/s
+
    answer=solid_effect(spin_system,parameters)
  
          parameters.theory  - level of theory. Set to 'exact' for
+
This function generates its own Liouvillian and should be called directly, without a wrapper.
                                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 the header of average.m functi-
 
                                on for the meaning of these options.
 
  
      parameters.nuclear_frq  - nuclear Zeeman frequency in rad/s
+
==Description==
 +
Computes either the time dependence of the longitudinal magnetization in the system or its asymptotic amplitude. The simulation is performed as described in http://dx.doi.org/10.1039/C2CP23233B - this function is optimised for very large-scale simulations, but the system must have exactly one electron.
  
        parameters.calc_type  - set to 'time_dependence' to get the  
+
==Arguments==
                                time dependence of the longitudinal
+
 
                                magnetization and to 'steady_state'
+
    parameters.mw_power    - microwave power in rad/s
                                to get the asymptotic longitudinal
+
                                magnetization.
+
    parameters.theory      - level of theory. Set to 'exact' for the electron rotating frame calculation
 +
                              or to any of the following six options for the average Hamiltonian theory
 +
                              calculation on top of the electron + nuclear rotating frame: 'ah_first_order',
 +
                              'ah_second_order', 'ah_third_order', 'kb_first_order','kb_second_order',
 +
                              'kb_third_order'. See the description of [[average.m]] function and the paper
 +
                              cited above for the meaning of these options.
 +
 +
    parameters.nuclear_frq - nuclear Zeeman frequency in rad/s. This function only supports one nuclear type.
  
        parameters.time_step   - if 'time_dependence' is set in the
+
    parameters.calc_type   - set to 'time_dependence' to get the time dependence of the longitudinal magneti-
                                calc_type parameter, sets the time
+
                              sation and to 'steady_state' to get the asymptotic longitudinal magnetisation.
                                step, seconds.
 
  
          parameters.n_steps   - if 'time_dependence' is set in the
+
    parameters.time_step   - if 'time_dependence' is set in the calc_type parameter, sets the time step, seconds.
                                calc_type parameter, sets the num-
 
                                ber of time steps.
 
  
Note: the system must have exactly one electron.
+
    parameters.n_steps    - if 'time_dependence' is set in the calc_type parameter, sets the number of time steps.
  
Note: this function generates its own Liouvillian and should be called
+
==Returns==
directly, without "liquid", "powder", or other wrappers.
 

Revision as of 17:02, 15 August 2016

Solid effect DNP experiment.

Syntax

    answer=solid_effect(spin_system,parameters)

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

Description

Computes either the time dependence of the longitudinal magnetization in the system or its asymptotic amplitude. The simulation is performed as described in http://dx.doi.org/10.1039/C2CP23233B - this function is optimised for very large-scale simulations, but the system must have exactly one electron.

Arguments

    parameters.mw_power    - microwave power in rad/s

    parameters.theory      - level of theory. Set to 'exact' for the electron rotating frame calculation 
                             or to any of the following six options for the average Hamiltonian theory 
                             calculation on top of the electron + nuclear rotating frame: 'ah_first_order',
                             'ah_second_order', 'ah_third_order', 'kb_first_order','kb_second_order',
                             'kb_third_order'. See the description of average.m function and the paper
                             cited above for the meaning of these options.

    parameters.nuclear_frq - nuclear Zeeman frequency in rad/s. This function only supports one nuclear type.
    parameters.calc_type   - set to 'time_dependence' to get the time dependence of the longitudinal magneti-
                             sation and to 'steady_state' to get the asymptotic longitudinal magnetisation.
    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 number of time steps.

Returns