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...")
 
Line 1: Line 1:
Tolerances and fundamental constants. Sets the various accuracy cut-offs,
+
{{DISPLAYTITLE:tolerances.m}}
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=tolerances(spin_system,sys)
 +
 
 +
==Arguments==
 +
 
 +
    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==
 +
Links to related functions.
 +
 
 +
 
 +
''Version 2.2, authors: [[Ilya Kuprov]], [[Hannah Hogben]]''

Revision as of 11:31, 21 August 2018

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

Syntax

    spin_system=tolerances(spin_system,sys)

Arguments

   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

Links to related functions.


Version 2.2, authors: Ilya Kuprov, Hannah Hogben