Difference between revisions of "Levelpop.m"
(Sync syntax/arguments/outputs with current Spinach source) |
(Update function See also links and function index membership) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:levelpop.m}} __NOTOC__ | {{DISPLAYTITLE:levelpop.m}} __NOTOC__ | ||
| − | |||
Equilibrium populations of the energy levels of a user-specified spin at the user-specified temperature. Energies are reported as fractions of kT at the temperature specified. | Equilibrium populations of the energy levels of a user-specified spin at the user-specified temperature. Energies are reported as fractions of kT at the temperature specified. | ||
==Syntax== | ==Syntax== | ||
| − | [E,P,dP]=levelpop(isotope,field,temperature) | + | [E,P,dP]=levelpop(isotope,field,temperature) |
| − | == | + | ==Parameters== |
| − | isotope - character string specifying the isotope. | + | isotope - character string specifying the isotope. |
e.g. '1H', '13C', 'E', etc. | e.g. '1H', '13C', 'E', etc. | ||
| Line 18: | Line 17: | ||
==Outputs== | ==Outputs== | ||
| − | E - vector of level energies, frac- | + | E - vector of level energies, frac- |
tions of kT at the temperature | tions of kT at the temperature | ||
specified | specified | ||
| − | + | ||
P - vector of level populations | P - vector of level populations | ||
| − | + | ||
dP - vector of population differences | dP - vector of population differences | ||
for adjacent levels | for adjacent levels | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Examples== | ==Examples== | ||
| − | |||
Free electron energy level populations at 4.0 Kelvin: | Free electron energy level populations at 4.0 Kelvin: | ||
| Line 44: | Line 37: | ||
==Notes== | ==Notes== | ||
| − | |||
The function is sensitive to the sign of the magnetogyric ratio - negative for electrons, positive for protons, ''etc.'' | The function is sensitive to the sign of the magnetogyric ratio - negative for electrons, positive for protons, ''etc.'' | ||
==See also== | ==See also== | ||
| − | + | [[spin.m]], [[equilibrium.m]], [[pauli.m]], [[carrier.m]], [[hamiltonian.m]], [[brokensymm.m]], [[quad_shift.m]], [[r1csa2tauc.m]], [[r1n_dnp.m]], [[r2csa2tauc.m]], [[rlx_csa.m]], [[rlx_dd_csa.m]], [[rlx_dip.m]], [[rlx_hfc.m]], [[rlx_nqi.m]], [[trosy_eff.m]], [[Textbook_module]] | |
| − | [[spin.m]], [[equilibrium.m]], [[pauli.m]], [[carrier.m]], [[hamiltonian.m]] | ||
| − | |||
''Version 2.4, authors: [[Ilya Kuprov]]'' | ''Version 2.4, authors: [[Ilya Kuprov]]'' | ||
Latest revision as of 19:38, 6 June 2026
Equilibrium populations of the energy levels of a user-specified spin at the user-specified temperature. Energies are reported as fractions of kT at the temperature specified.
Syntax
[E,P,dP]=levelpop(isotope,field,temperature)
Parameters
isotope - character string specifying the isotope.
e.g. '1H', '13C', 'E', etc.
field - primary magnet field in Tesla
temperature - spin temperature, Kelvin
Outputs
E - vector of level energies, frac-
tions of kT at the temperature
specified
P - vector of level populations
dP - vector of population differences
for adjacent levels
Examples
Free electron energy level populations at 4.0 Kelvin:
>> [~,P]=levelpop('E',14.1,4.0)
P =
(1,1) 0.0087
(2,1) 0.9913
Notes
The function is sensitive to the sign of the magnetogyric ratio - negative for electrons, positive for protons, etc.
See also
spin.m, equilibrium.m, pauli.m, carrier.m, hamiltonian.m, brokensymm.m, quad_shift.m, r1csa2tauc.m, r1n_dnp.m, r2csa2tauc.m, rlx_csa.m, rlx_dd_csa.m, rlx_dip.m, rlx_hfc.m, rlx_nqi.m, trosy_eff.m, Textbook_module
Version 2.4, authors: Ilya Kuprov