Difference between revisions of "Tolerances.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Created page with "Tolerances and fundamental constants. Sets the various accuracy cut-offs, constants and tolerances used throughout Spinach kernel. Modifications to this function are discour...")
 
(Update function See also links and function index membership)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Tolerances and fundamental constants. Sets the various accuracy cut-offs,
+
{{DISPLAYTITLE:tolerances.m}} __NOTOC__
constants and tolerances used throughout Spinach kernel.  
+
Tolerances and fundamental constants. Sets the various accuracy cut-offs, constants and tolerances used throughout ''Spinach'' kernel.
  
Modifications to this function are discouraged -- the accuracy settings
+
==Syntax==
should be modified by setting the sub-fields of the sys.tols structure,
+
 
see the input preparation manual in the /docs directory.
+
 
 +
    [spin_system,sys]=tolerances(spin_system,sys)
 +
 
 +
==Parameters==
 +
 
 +
    [[Appendix D: kernel data structures|spin_system]]  -  Spinach system description object
 +
 +
    [[Spin_system_specification|sys]]          -  system specification object described
 +
                    in the input preparation section of
 +
                    the manual
 +
 
 +
==Outputs==
 +
 
 +
    [[Appendix D: kernel data structures|spin_system]]  -  updated system description object
 +
 
 +
==Notes==
 +
Direct calls and modifications to this function are discouraged: the [[Appendix_A:_internal_tolerances|accuracy settings]] should be modified by setting the sys.tols structure, see the [[Spin_system_specification|input preparation manual]].
 +
 
 +
==See also==
 +
[[create.m]], [[clean_up.m]], [[banner.m]], [[cacheman.m]], [[compile_mex.m]], [[dipolar.m]], [[existentials.m]], [[exorcise.m]], [[forum.m]], [[hebrew.m]], [[iseye.m]], [[patrol.m]], [[rearm.m]], [[report.m]], [[sniff.m]], [[summary.m]], [[symmetry.m]], [[wiki.m]], [[wipe_cache.m]], [[Kernel_utilities]]
 +
 
 +
''Version 2.2, authors: [[Ilya Kuprov]], [[Hannah Hogben]]''

Latest revision as of 19:42, 6 June 2026

Tolerances and fundamental constants. Sets the various accuracy cut-offs, constants and tolerances used throughout Spinach kernel.

Syntax

    [spin_system,sys]=tolerances(spin_system,sys)

Parameters

   spin_system  -  Spinach system description object

   sys          -  system specification object described
                   in the input preparation section of 
                   the manual

Outputs

   spin_system  -  updated system description object

Notes

Direct calls and modifications to this function are discouraged: the accuracy settings should be modified by setting the sys.tols structure, see the input preparation manual.

See also

create.m, clean_up.m, banner.m, cacheman.m, compile_mex.m, dipolar.m, existentials.m, exorcise.m, forum.m, hebrew.m, iseye.m, patrol.m, rearm.m, report.m, sniff.m, summary.m, symmetry.m, wiki.m, wipe_cache.m, Kernel_utilities

Version 2.2, authors: Ilya Kuprov, Hannah Hogben