Difference between revisions of "Dipolar.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Update function See also links and function index membership)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:function.m}} __NOTOC__
+
{{DISPLAYTITLE:dipolar.m}} __NOTOC__
 
Computes dipolar couplings in the presence or absence of periodic boundary conditions. This is an auxiliary function of ''Spinach'' kernel, direct calls are discouraged. Use [[xyz2dd.m]] and [[xyz2hfc.m]] to convert Cartesian coordinates into dipolar and hyperfine couplings respectively.
 
Computes dipolar couplings in the presence or absence of periodic boundary conditions. This is an auxiliary function of ''Spinach'' kernel, direct calls are discouraged. Use [[xyz2dd.m]] and [[xyz2hfc.m]] to convert Cartesian coordinates into dipolar and hyperfine couplings respectively.
  
Line 6: Line 6:
 
     spin_system=dipolar(spin_system)
 
     spin_system=dipolar(spin_system)
  
==Arguments==
+
==Parameters==
  
 
     spin_system  - Spinach data object containing infor-
 
     spin_system  - Spinach data object containing infor-
Line 20: Line 20:
  
 
==See also==
 
==See also==
[[xyz2dd.m]], [[xyz2hfc.m]], [[xyz2pms.m]]
+
[[xyz2dd.m]], [[xyz2hfc.m]], [[xyz2pms.m]], [[banner.m]], [[cacheman.m]], [[compile_mex.m]], [[existentials.m]], [[exorcise.m]], [[forum.m]], [[hebrew.m]], [[iseye.m]], [[patrol.m]], [[rearm.m]], [[report.m]], [[sniff.m]], [[summary.m]], [[symmetry.m]], [[tolerances.m]], [[wiki.m]], [[wipe_cache.m]], [[Kernel_utilities]]
 
 
  
 
''Version 2.3, authors: [[Ilya Kuprov]]''
 
''Version 2.3, authors: [[Ilya Kuprov]]''

Latest revision as of 19:35, 6 June 2026

Computes dipolar couplings in the presence or absence of periodic boundary conditions. This is an auxiliary function of Spinach kernel, direct calls are discouraged. Use xyz2dd.m and xyz2hfc.m to convert Cartesian coordinates into dipolar and hyperfine couplings respectively.

Syntax

    spin_system=dipolar(spin_system)

Parameters

    spin_system   - Spinach data object containing infor-
                    mation about chemical subsystems, ato-
                    mic coordinates, and periodic bounda-
                    ry conditions

Outputs

    spin_system   - Spinach data object with the interac-
                    tion arrays updated with dipolar and
                    hyperfine coupling information

See also

xyz2dd.m, xyz2hfc.m, xyz2pms.m, banner.m, cacheman.m, compile_mex.m, existentials.m, exorcise.m, forum.m, hebrew.m, iseye.m, patrol.m, rearm.m, report.m, sniff.m, summary.m, symmetry.m, tolerances.m, wiki.m, wipe_cache.m, Kernel_utilities

Version 2.3, authors: Ilya Kuprov