Difference between revisions of "Fieldscan enlev.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(→‎Arguments)
(Update function See also links and function index membership)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:fieldscan_enlev.m}}
+
{{DISPLAYTITLE:fieldscan_enlev.m}} __NOTOC__
−
One-sentence summary of what the function does.
+
Plots a user-specified number of the lowest energy levels of the system as a function of the applied magnetic field. The energies are obtained using the Arnoldi method.
  
 
==Syntax==
 
==Syntax==
Line 6: Line 6:
 
     fieldscan_enlev(spin_system,parameters)
 
     fieldscan_enlev(spin_system,parameters)
  
−
==Description==
+
==Parameters==
−
Plots a user-specified number of the lowest energy levels of the system as a function of the applied magnetic field. The energies are obtained using the Arnoldi method.
 
−
 
 
−
==Arguments==
 
  
 
   parameters.fields  - two-element vector in Tesla,
 
   parameters.fields  - two-element vector in Tesla,
Line 34: Line 31:
  
 
==See also==
 
==See also==
−
[[eqmag.m]], [[stevens.m]], [[stev2sph.m]], [[fieldscan_magn.m]]
+
[[eqmag.m]], [[stevens.m]], [[stev2sph.m]], [[fieldscan_magn.m]], [[fieldsweep.m]], [[centroid.m]], [[csa2racs.m]], [[geffect.m]], [[hfc2pcs.m]], [[hfc2pms.m]], [[ipcs.m]], [[ippcs.m]], [[kpcs.m]], [[pcs2chi.m]], [[pcs_combi_fit.m]], [[pms2chi.m]], [[ppcs.m]], [[probmax.m]], [[Built-in_experiments]]
−
 
 
  
−
''Version 2.1, authors: [[Ilya Kuprov]], [[Liza Suturina]]''
+
''Version 2.2, authors: [[Ilya Kuprov]], [[Elizaveta Suturina]]''

Latest revision as of 19:36, 6 June 2026

Plots a user-specified number of the lowest energy levels of the system as a function of the applied magnetic field. The energies are obtained using the Arnoldi method.

Syntax

    fieldscan_enlev(spin_system,parameters)

Parameters

  parameters.fields  - two-element vector in Tesla,
                       ordered as [from to]

  parameters.npoints - number of points in the scan

  parameters.orientation - system orientation, three-
                           element vector containing
                           Euler angles in radians,
                           ordered as [alp bet gam]

  parameters.nstates - number of lowest energy states
                       to solve for

Outputs

This function plots a graph.

Examples

See quartet_levels.m, triple_dy_levels.m, and dy_lft_single_2.m files in examples/giant_spin directory.

Notes

The function runs in parallel over the values of the applied magnetic field. The sys.magnet parameter is used for internal normalisation and must be set to exactly 1 Tesla.

See also

eqmag.m, stevens.m, stev2sph.m, fieldscan_magn.m, fieldsweep.m, centroid.m, csa2racs.m, geffect.m, hfc2pcs.m, hfc2pms.m, ipcs.m, ippcs.m, kpcs.m, pcs2chi.m, pcs_combi_fit.m, pms2chi.m, ppcs.m, probmax.m, Built-in_experiments

Version 2.2, authors: Ilya Kuprov, Elizaveta Suturina