1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>XMDS2 script elements — XMDS2 2.2.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.2.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML,http://www.xmds.org/_static/mathjax-use-tex-fonts.js"></script>
<link rel="shortcut icon" href="_static/xmds_favicon.ico"/>
<link rel="top" title="XMDS2 2.2.2 documentation" href="index.html" />
<link rel="up" title="Reference section" href="reference_index.html" />
<link rel="next" title="Modified Midpoint Method" href="bulirschStoer.html" />
<link rel="prev" title="XMDS2 XML Schema" href="reference_schema.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="bulirschStoer.html" title="Modified Midpoint Method"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="reference_schema.html" title="XMDS2 XML Schema"
accesskey="P">previous</a> |</li>
<li><a href="index.html">XMDS2 2.2.2 documentation</a> »</li>
<li><a href="reference_index.html" accesskey="U">Reference section</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="xmds2-script-elements">
<span id="referenceelements"></span><span id="index-0"></span><h1>XMDS2 script elements<a class="headerlink" href="#xmds2-script-elements" title="Permalink to this headline">¶</a></h1>
<p>This section outlines all the elements and options available in an XMDS2 script. This is very much a <strong>work in progress</strong>, beginning with placeholders in most cases, as we have prioritised the tutorials for new users. One of the most productive ways that non-developer veterans can contribute to the project is to help develop this documentation.</p>
<div class="section" id="simulation-element">
<span id="simulationelement"></span><span id="index-1"></span><h2>Simulation element<a class="headerlink" href="#simulation-element" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre"><simulation></span></tt> element is the single top level element in an XMDS2 simulation, and contains all the other elements. All XMDS scripts must contain exactly one simulation element, and it must have the <tt class="docutils literal"><span class="pre">xmds-version="2"</span></tt> attribute defined.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="c"><!-- Rest of simulation goes here --></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="name-element">
<span id="nameelement"></span><span id="index-2"></span><h2>Name element<a class="headerlink" href="#name-element" title="Permalink to this headline">¶</a></h2>
<p>The name of your simulation. This element is optional, but recommended. If it is set, it will be the name of the executable file generated from this script. It will also be the name of the output file (with an appropriate extension) if the <tt class="docutils literal"><span class="pre">filename</span></tt> attribute is not given a value in the <tt class="docutils literal"><span class="pre"><output></span></tt> element.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><name></span> funky_solver <span class="nt"></name></span>
</pre></div>
</div>
</div>
<div class="section" id="author-element">
<span id="authorelement"></span><span id="index-3"></span><h2>Author element<a class="headerlink" href="#author-element" title="Permalink to this headline">¶</a></h2>
<p>The author(s) of this script. This element is optional, but can be useful if you need to find the person who has written an incomprehensible script and thinks comments are for the weak.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><author></span> Ima Mollusc <span class="nt"></author></span>
</pre></div>
</div>
</div>
<div class="section" id="description-element">
<span id="descriptionelement"></span><span id="index-4"></span><h2>Description element<a class="headerlink" href="#description-element" title="Permalink to this headline">¶</a></h2>
<p>A description of what the simulation does. Optional, but recommended, in case you (or someone else) has to revist the script at some distant point in the future.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><description></span>
Calculate the 3D ground state of a Rubidium BEC in a harmonic magnetic trap assuming
cylindrical symmetry about the z axis and reflection symmetry about z=0.
This permits us to use the cylindrical Bessel functions to expand the solution transverse
to z and a cosine series to expand the solution along z.
<span class="nt"></description></span>
</pre></div>
</div>
</div>
<div class="section" id="features-elements">
<span id="featureselement"></span><span id="index-5"></span><h2>Features Elements<a class="headerlink" href="#features-elements" title="Permalink to this headline">¶</a></h2>
<p>Features elements are where simulation-wide options are specified. The <tt class="docutils literal"><span class="pre"><features></span></tt> element wraps one or more elements describing features. There are many possible feature elements. Currently, a full list of the features supported is:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="#argumentselement"><em>arguments</em></a></li>
<li><a class="reference internal" href="#autovectorise"><em>auto_vectorise</em></a></li>
<li><a class="reference internal" href="#benchmark"><em>benchmark</em></a></li>
<li><a class="reference internal" href="#bing"><em>bing</em></a></li>
<li><a class="reference internal" href="#cflags"><em>cflags</em></a></li>
<li><a class="reference internal" href="#chunkedoutput"><em>chunked_output</em></a></li>
<li><a class="reference internal" href="#diagnostics"><em>diagnostics</em></a></li>
<li><a class="reference internal" href="#errorcheck"><em>error_check</em></a></li>
<li><a class="reference internal" href="#haltnonfinite"><em>halt_non_finite</em></a></li>
<li><a class="reference internal" href="#fftw"><em>fftw</em></a></li>
<li><a class="reference internal" href="#globals"><em>globals</em></a></li>
<li><a class="reference internal" href="#openmp"><em>OpenMP</em></a></li>
<li><a class="reference internal" href="#precision"><em>precision</em></a></li>
<li><a class="reference internal" href="#validation"><em>validation</em></a></li>
</ul>
</div></blockquote>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><features></span>
<span class="nt"><bing</span> <span class="nt">/></span>
<span class="nt"><precision></span> double <span class="nt"></precision></span>
...
<span class="nt"></features></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
<div class="section" id="arguments-element">
<span id="argumentselement"></span><span id="index-6"></span><h3>Arguments Element<a class="headerlink" href="#arguments-element" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre"><arguments></span></tt> element is optional, and allows defining variables that can be passed to the simulation at run time. These variables are then globally accessible throughout the simulation script. Each of the variables must be defined in an <tt class="docutils literal"><span class="pre"><argument></span></tt> element (see below). The variables can then be passed to the simulation executable as options on the command line. For example, one could define the variables <tt class="docutils literal"><span class="pre">size</span></tt>, <tt class="docutils literal"><span class="pre">number</span></tt>, and <tt class="docutils literal"><span class="pre">pulse_shape</span></tt></p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><name></span> arguments_test <span class="nt"></name></span>
<span class="nt"><features></span>
<span class="nt"><arguments></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"size"</span> <span class="na">type=</span><span class="s">"real"</span> <span class="na">default_value=</span><span class="s">"20.0"</span><span class="nt">/></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"number"</span> <span class="na">type=</span><span class="s">"integer"</span> <span class="na">default_value=</span><span class="s">"7"</span><span class="nt">/></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"pulse_shape"</span> <span class="na">type=</span><span class="s">"string"</span> <span class="na">default_value=</span><span class="s">"gaussian"</span><span class="nt">/></span>
<span class="nt"></arguments></span>
<span class="nt"></features></span>
</pre></div>
</div>
<p>When <tt class="docutils literal"><span class="pre">XMDS2</span></tt> is run on this script the executable <tt class="docutils literal"><span class="pre">arguments_test</span></tt> is created. The values of <tt class="docutils literal"><span class="pre">size</span></tt>, <tt class="docutils literal"><span class="pre">number</span></tt>, and <tt class="docutils literal"><span class="pre">pulse_shape</span></tt> can then be set to whatever is desired at runtime via</p>
<div class="highlight-xmds2"><div class="highlight"><pre>./arguments_test --size=1.3 --number=2 --pulse_shape=lorentzian
</pre></div>
</div>
<p>It is also possible to include an optional <tt class="docutils literal"><span class="pre">CDATA</span></tt> block inside the <tt class="docutils literal"><span class="pre"><arguments></span></tt> block. This code will run after the arguments have been initialised with the values passed from the command line. This code block could be used, for example, to sanity check the parameters passed in, or for assigning values to global variables based on those parameters. Any references to variables defined in an <tt class="docutils literal"><span class="pre"><argument></span></tt> element should be made here rather than in the <a class="reference internal" href="#globals"><em>Globals</em></a> element, or else the variables will only have their default values. For example, one could have the following</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><features></span>
<span class="nt"><globals></span>
<span class="cp"><![CDATA[</span>
<span class="nf">real</span> <span class="n">atom_kick</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"><globals></span>
<span class="nt"><arguments></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"bragg_order"</span> <span class="na">type=</span><span class="s">"integer"</span> <span class="na">default_value=</span><span class="s">"2"</span><span class="nt">/></span>
<span class="cp"><![CDATA[</span>
<span class="n">atom_kick</span> <span class="o">=</span> <span class="n">bragg_order</span> <span class="o">*</span> <span class="mi">2</span><span class="o">*</span><span class="n">M_PI</span> <span class="o">/</span> <span class="mf">780e-9</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></arguments></span>
<span class="nt"></features></span>
</pre></div>
</div>
<p>The arguments and their values can be added to the filename of the output files by using the <tt class="docutils literal"><span class="pre">append_args_to_output_filename</span></tt> attribute. For example:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><name></span> arguments_test <span class="nt"></name></span>
<span class="nt"><features></span>
<span class="nt"><arguments</span> <span class="na">append_args_to_output_filename=</span><span class="s">"yes"</span><span class="nt">></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"size"</span> <span class="na">type=</span><span class="s">"real"</span> <span class="na">default_value=</span><span class="s">"20.0"</span><span class="nt">/></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"number"</span> <span class="na">type=</span><span class="s">"integer"</span> <span class="na">default_value=</span><span class="s">"7"</span><span class="nt">/></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"pulse_shape"</span> <span class="na">type=</span><span class="s">"string"</span> <span class="na">default_value=</span><span class="s">"gaussian"</span><span class="nt">/></span>
<span class="nt"></arguments></span>
<span class="nt"></features></span>
</pre></div>
</div>
<p>When the <tt class="docutils literal"><span class="pre">arguments_test</span></tt> executable is run, it will create output files named <tt class="docutils literal"><span class="pre">arguments_test.number_7.pulse_shape_gaussian.size_20.0.xsil</span></tt> and <tt class="docutils literal"><span class="pre">arguments_test.number_7.pulse_shape_gaussian.size_20.0.h5</span></tt>.</p>
<div class="section" id="argument-element">
<span id="argumentelement"></span><span id="index-7"></span><h4>Argument element<a class="headerlink" href="#argument-element" title="Permalink to this headline">¶</a></h4>
<p id="index-8">Each <tt class="docutils literal"><span class="pre"><argument></span></tt> element describes one variable that can be passed to the simulation at runtime via the command line. There are three mandatory attributes: <tt class="docutils literal"><span class="pre">name</span></tt>, <tt class="docutils literal"><span class="pre">type</span></tt>, and <tt class="docutils literal"><span class="pre">default_value</span></tt>. <tt class="docutils literal"><span class="pre">name</span></tt> is the name by which you can refer to that variable later in the script, as well as the name of the command line parameter. <tt class="docutils literal"><span class="pre">type</span></tt> defines the data type of the variable, and <tt class="docutils literal"><span class="pre">default_value</span></tt> is the value to which the variable is set if it is not given a value on the command line.</p>
</div>
</div>
<div class="section" id="auto-vectorise-element">
<span id="autovectorise"></span><span id="index-9"></span><h3>Auto_vectorise element<a class="headerlink" href="#auto-vectorise-element" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre"><auto_vectorise</span> <span class="pre">/></span></tt> feature attempts to activate automatic vectorisation for large loops, if it is available in the compiler. This should make some simulations go faster.</p>
</div>
<div class="section" id="benchmark">
<span id="index-10"></span><span id="id1"></span><h3>Benchmark<a class="headerlink" href="#benchmark" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre"><benchmark</span> <span class="pre">/></span></tt> feature includes a timing routine in the generated code, so that it is possible to see how long the simulations take to run.</p>
</div>
<div class="section" id="bing">
<span id="index-11"></span><span id="id2"></span><h3>Bing<a class="headerlink" href="#bing" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre"><bing</span> <span class="pre">/></span></tt> feature causes the simulation to make an invigorating sound when the simulation finishes executing.</p>
</div>
<div class="section" id="c-flags">
<span id="cflags"></span><span id="index-12"></span><h3>C Flags<a class="headerlink" href="#c-flags" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre"><cflags></span></tt> feature allows extra flags to be passed to the compiler. This can be useful for optimisation, and also using specific external libraries. The extra options to be passed are defined with a ‘CDATA’ block. The compile options can be made visible by running XMDS2 either with the “-v” (verbose) option, or the “-g” (debug) option.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><cflags></span>
<span class="cp"><![CDATA[</span>
<span class="o">-</span><span class="n">O4</span>
<span class="cp">]]></span>
<span class="nt"></cflags></span>
</pre></div>
</div>
</div>
<div class="section" id="chunked-output">
<span id="chunkedoutput"></span><span id="index-13"></span><h3>Chunked Output<a class="headerlink" href="#chunked-output" title="Permalink to this headline">¶</a></h3>
<p>By default, XMDS2 keeps the contents of all output moment groups in memory until the end of the simulation when they are written to the output file. This can be a problem if your simulation creates a very large amount of output. <tt class="docutils literal"><span class="pre"><chunked_output</span> <span class="pre">/></span></tt> causes the simulation to save the output data in chunks as the simulation progresses. For some simulations this can significantly reduce the amount of memory required. The amount of data in a chunk can be specified with the <tt class="docutils literal"><span class="pre">size</span></tt> attribute where the suffixes “KB” (kilobytes), “MB” (megabytes), “GB” (gigabytes) and “TB” (terabytes) are understood. Note that <tt class="docutils literal"><span class="pre">size</span></tt> specifies the chunk size per output sampling group, per MPI process. So a chunk size of 4MB for a distributed-MPI simulation using 20 processes will cause each process to save up 4MB of data, and data to be written to the output file 80MB at a time.</p>
<p>Limitations (XMDS will give you an error if you violate any of these):</p>
<ul class="simple">
<li>This feature cannot be used with the ASCII output file format due to limitations in the file format.</li>
<li>This feature cannot be used with the <tt class="docutils literal"><span class="pre">multi-path</span></tt> drivers because all sampling data is required to compute the mean and standard error statistics.</li>
<li>Neither is this feature compatible with the <tt class="docutils literal"><span class="pre">error_check</span></tt> feature as that relies on all sampling data being available to compute the error.</li>
</ul>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><features></span>
<span class="nt"><chunked_output</span> <span class="na">size=</span><span class="s">"5MB"</span> <span class="nt">/></span>
<span class="nt"></features></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="diagnostics">
<span id="index-14"></span><span id="id3"></span><h3>Diagnostics<a class="headerlink" href="#diagnostics" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre"><diagnostics</span> <span class="pre">/></span></tt> feature causes a simulation to output more information as it executes. This should be useful when a simulation is dying / giving bad results to help diagnose the cause. Currently, it largely outputs step error information.</p>
</div>
<div class="section" id="error-check">
<span id="errorcheck"></span><span id="index-15"></span><h3>Error Check<a class="headerlink" href="#error-check" title="Permalink to this headline">¶</a></h3>
<p>It’s often important to know whether you’ve got errors. This feature runs each integration twice: once with the specified error tolerance or defined lattice spacing in the propagation dimension, and then again with half the lattice spacing, or an equivalently lower error tolerance. Each component of the output then shows the difference between these two integrations as an estimate of the error. This feature is particularly useful when integrating stochastic equations, as it treats the noise generation correctly between the two runs, and thus makes a reasonable estimate of the strong convergence of the equations.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><features></span>
<span class="nt"><error_check</span> <span class="nt">/></span>
<span class="nt"></features></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="halt-non-finite">
<span id="haltnonfinite"></span><span id="index-16"></span><h3>Halt_Non_Finite<a class="headerlink" href="#halt-non-finite" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre"><halt_non_finite</span> <span class="pre">/></span></tt> feature is used to stop computations from continuing to run after the vectors stop having numerical values. This can occur when a number is too large to represent numerically, or when an illegal operation occurs. Processing variables with non-numerical values is usually much slower than normal processing, and the results are meaningless. Of course, there is a small cost to introducing a run-time check, so this feature is optional.</p>
</div>
<div class="section" id="fftw-element">
<span id="fftw"></span><span id="index-17"></span><h3>fftw element<a class="headerlink" href="#fftw-element" title="Permalink to this headline">¶</a></h3>
<p id="index-18">The <tt class="docutils literal"><span class="pre"><fftw</span> <span class="pre">\></span></tt> feature can be used to pass options to the <a class="reference external" href="http://fftw.org">Fast Fourier Transform library</a> used by XMDS. This library tests algorithms on each architecture to determine the fastest method of solving each problem. Typically this costs very little overhead, as the results of all previous tests are stored in the directory “~/.xmds/wisdom”. The level of detail for the search can be specified using the <tt class="docutils literal"><span class="pre">plan</span></tt> attribute, which can take values of <tt class="docutils literal"><span class="pre">"estimate"</span></tt>, <tt class="docutils literal"><span class="pre">"measure"</span></tt>,``”patient”<tt class="docutils literal"><span class="pre">,</span> <span class="pre">or</span> <span class="pre">``"exhaustive"</span></tt>, in order of the depth of the search. The number of threads for threaded FFTs can be specified with the <tt class="docutils literal"><span class="pre">threads</span></tt> attribute, which must be a positive integer.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><fftw</span> <span class="na">plan=</span><span class="s">"patient"</span> <span class="na">threads=</span><span class="s">"3"</span> <span class="nt">/></span>
</pre></div>
</div>
</div>
<div class="section" id="globals">
<span id="index-19"></span><span id="id4"></span><h3>Globals<a class="headerlink" href="#globals" title="Permalink to this headline">¶</a></h3>
<p>The globals feature places the contents of a ‘CDATA’ block near the top of the generated program. Amongst other things, this is useful for defining variables that are then accessible throughout the entire program.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><globals></span>
<span class="cp"><![CDATA[</span>
<span class="k">const</span> <span class="nf">real</span> <span class="n">omegaz</span> <span class="o">=</span> <span class="mi">2</span><span class="o">*</span><span class="n">M_PI</span><span class="o">*</span><span class="mi">20</span><span class="p">;</span>
<span class="kt">long</span> <span class="n">Nparticles</span> <span class="o">=</span> <span class="mi">50000</span><span class="p">;</span>
<span class="cm">/* offset constants */</span>
<span class="nf">real</span> <span class="n">frequency</span> <span class="o">=</span> <span class="n">omegaz</span><span class="o">/</span><span class="mi">2</span><span class="o">/</span><span class="n">M_PI</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></globals></span>
</pre></div>
</div>
</div>
<div class="section" id="openmp">
<span id="index-20"></span><span id="id5"></span><h3>OpenMP<a class="headerlink" href="#openmp" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre"><openmp</span> <span class="pre">/></span></tt> feature instructs compatible compilers to parallelise key loops using the <a class="reference external" href="http://www.openmp.org">OpenMP API</a> standard. By default the simulation will use all available CPUs. The number of threads used can be restricted by specifying the number of threads in the script with <tt class="docutils literal"><span class="pre"><openmp</span> <span class="pre">threads="2"/></span></tt>, or by setting the <tt class="docutils literal"><span class="pre">OMP_NUM_THREADS</span></tt> environment variable at run-time like so:</p>
<div class="highlight-xmds2"><div class="highlight"><pre>OMP_NUM_THREADS=2 ./simulation_name
</pre></div>
</div>
</div>
<div class="section" id="precision">
<span id="index-21"></span><span id="id6"></span><h3>Precision<a class="headerlink" href="#precision" title="Permalink to this headline">¶</a></h3>
<p>This specifies the precision of the XMDS2 <tt class="docutils literal"><span class="pre">real</span></tt> and <tt class="docutils literal"><span class="pre">complex</span></tt> datatypes, as well as the precision used when computing transforms. Currently two values are accepted: <tt class="docutils literal"><span class="pre">single</span></tt> and <tt class="docutils literal"><span class="pre">double</span></tt>. If this feature isn’t specified, XMDS2 defaults to using double precision for its variables and internal calculations.</p>
<p>Single precision has approximately 7.2 decimal digits of accuracy, with a minimum value of 1.4×10<sup>-45</sup> and a maximum of 3.8×10<sup>34</sup>. Double precision has approximately 16 decimal digits of accuracy, a minimum value of 4.9×10<sup>-324</sup> and a maximum value of 1.8×10<sup>308</sup>.</p>
<p>Using single precision can be attractive, as it can be more than twice as fast, depending on whether a simulation is CPU bound, memory bandwidth bound, MPI bound or bottlenecked elsewhere, although in some situations you may see no speed-up at all. Caution should be exercised, however. Keep in mind how many timesteps your simulation requires, and take note of the tolerance you have set per step, to see if the result will lie within your acceptable total error - seven digit precision isn’t a lot. Quite apart from the precision, the range of single precision can often be inadequate for many physical problems. In atomic physics, for example, intermediate values below 1.4×10<sup>-45</sup> are easily obtained, and will be taken as zero. Similarly, values above 3.8×10<sup>34</sup> will result in NaNs and make the simulation results invalid.</p>
<p>Also note that when using an adaptive step integrator, setting a tolerance close to limits of the precision can lead to very slow performance.</p>
<p>A further limitation is that not all the combinations of random number generators and probability distributions that are supported in double precision are supported in single precision. For example, the <tt class="docutils literal"><span class="pre">solirte</span></tt> generator does not support single precision gaussian distributions. <tt class="docutils literal"><span class="pre">dsfmt</span></tt>, however, is one of the fastest generators, and does support single precision.</p>
<p>WARNING: Single precision mode has not been tested anywhere near as thoroughly as the default double precision mode, and there is a higher chance you will run into bugs.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><features></span>
<span class="nt"><precision></span> single <span class="nt"></precision></span>
<span class="nt"></features></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="validation">
<span id="index-22"></span><span id="id7"></span><h3>Validation<a class="headerlink" href="#validation" title="Permalink to this headline">¶</a></h3>
<p>XMDS2 makes a large number of checks in the code generation process to verify that the values for all parameters are safe choices. Sometimes we wish to allow these parameters to be specified by variables. This opens up many possibilities, but requires that any safety checks for parameters be performed during the execution of the program itself. The <tt class="docutils literal"><span class="pre"><validation></span></tt> feature activates that option, with allowable attributes being “run-time”, “compile-time” and “none”.</p>
<p>As an example, one may wish to define the number of grid points and the range of the grid at run-time rather than explicitly define them in the XMDS2 script. To accomplish this, one could do the following:</p>
<div class="highlight-xmds2"><div class="highlight"><pre> <span class="nt"><name></span> validation_test <span class="nt"></name></span>
<span class="nt"><features></span>
<span class="nt"><validation</span> <span class="na">kind=</span><span class="s">"run-time"</span> <span class="nt">/></span>
<span class="nt"><arguments></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"xmin"</span> <span class="na">type=</span><span class="s">"real"</span> <span class="na">default_value=</span><span class="s">"-1.0"</span><span class="nt">/></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"xmax"</span> <span class="na">type=</span><span class="s">"real"</span> <span class="na">default_value=</span><span class="s">"1.0"</span><span class="nt">/></span>
<span class="nt"><argument</span> <span class="na">name=</span><span class="s">"numGridPoints"</span> <span class="na">type=</span><span class="s">"integer"</span> <span class="na">default_value=</span><span class="s">"128"</span><span class="nt">/></span>
<span class="nt"></arguments></span>
<span class="nt"></features></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"numGridPoints"</span> <span class="na">domain=</span><span class="s">"(xmin, xmax)"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
</pre></div>
</div>
<p>and then run the resulting executable with:</p>
<div class="highlight-xmds2"><div class="highlight"><pre>./validation_test --xmin=-2.0 --xmax=2.0 --numGridPoints=64
</pre></div>
</div>
<p>This approach means that when XMDS2 is parsing the script it is unable to tell, for example, if the number of sampling points requested is less than or equal to the lattice size. Consequently it will create an executable with “numGridPoints” as an internal variable, and make the check at run-time, when it knows the value of “numGridPoints” rather than at compile time, when it doesn’t.</p>
<p id="index-23">..index:: MPI</p>
</div>
</div>
<div class="section" id="driver-element">
<span id="driverelement"></span><h2>Driver Element<a class="headerlink" href="#driver-element" title="Permalink to this headline">¶</a></h2>
<p>The driver element controls the overall management of the simulation, including how many paths of a stochastic simulation are to be averaged, and whether or not it is to be run using distributed memory parallelisation. If it is not included, then the simulation is performed once without using MPI parallelisation. If it is included, it must have a <tt class="docutils literal"><span class="pre">name</span></tt> attribute.</p>
<p>The <tt class="docutils literal"><span class="pre">name</span></tt> attribute can have values of “none” (which is equivalent to the default option of not specifying a driver), “distributed-mpi”, “multi-path”, “mpi-multi-path” or “adaptive-mpi-multi-path”.</p>
<p>Choosing the <tt class="docutils literal"><span class="pre">name="distributed-mpi"</span></tt> option allows a single integration over multiple processors. The resulting executable can then be run according to your particular implementation of MPI. The FFTW library only allows MPI processing of multidimensional vectors, as otherwise shared memory parallel processing requires too much inter-process communication to be efficient. Maximally efficient parallelisation occurs where evolution is entirely local in one transverse dimension (see <a class="reference internal" href="#transversedimensionselement"><em>transverse dimensions</em></a> below). In that case, that dimension should be listed first in the <a class="reference internal" href="#geometryelement"><em><geometry></em></a> element. As noted in the worked example <a class="reference internal" href="worked_examples.html#wignerarguments"><em>Wigner Function</em></a>, it is wise to test the speed of the simulation using different numbers of processors.</p>
<p>The <tt class="docutils literal"><span class="pre">name="multi-path"</span></tt> option is used for stochastic simulations, which are typically run multiple times and averaged. It requires a <tt class="docutils literal"><span class="pre">paths</span></tt> attribute with the number of iterations of the integration to be averaged. The output will report the averages of the desired samples, and the standard error in those averages.
The <tt class="docutils literal"><span class="pre">name="mpi-multi-path"</span></tt> option integrates separate paths on different processors, which is typically a highly efficient process.
The <tt class="docutils literal"><span class="pre">name="adaptive-mpi-multi-path"</span></tt> option integrates separate paths on different processors with load balancing.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><driver</span> <span class="na">name=</span><span class="s">"distributed-mpi"</span> <span class="nt">/></span>
<span class="c"><!-- or --></span>
<span class="nt"><driver</span> <span class="na">name=</span><span class="s">"multi-path"</span> <span class="na">paths=</span><span class="s">"10"</span> <span class="nt">/></span>
<span class="c"><!-- or --></span>
<span class="nt"><driver</span> <span class="na">name=</span><span class="s">"mpi-multi-path"</span> <span class="na">paths=</span><span class="s">"1000"</span> <span class="nt">/></span>
<span class="c"><!-- or --></span>
<span class="nt"><driver</span> <span class="na">name=</span><span class="s">"adaptive-mpi-multi-path"</span> <span class="na">paths=</span><span class="s">"1000"</span> <span class="nt">/></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="geometry-element">
<span id="geometryelement"></span><span id="index-24"></span><h2>Geometry Element<a class="headerlink" href="#geometry-element" title="Permalink to this headline">¶</a></h2>
<p id="propagationdimensionelement"><span id="index-25"></span>The <tt class="docutils literal"><span class="pre"><geometry></span></tt> element describes the dimensions used in your simulation, and is required. The only required element inside is the <tt class="docutils literal"><span class="pre"><propagation_dimension></span></tt> element, which defines the name of the dimension along which your simulation will integrate. Nothing else about this dimension is specified, as requirements for the lattice along the integration dimension is specified by the <tt class="docutils literal"><span class="pre"><integrate></span></tt> blocks themselves, as described in section <a class="reference internal" href="#integrateelement"><em>Integrate element</em></a>.</p>
<span class="target" id="transversedimensionselement"><span id="index-26"></span></span><p id="dimensionelement"><span id="index-27"></span>If there are other dimensions in your problem, they are called “transverse dimensions”, and are described in the <tt class="docutils literal"><span class="pre"><transverse_dimensions></span></tt> element. Each dimension is then described in its own <tt class="docutils literal"><span class="pre"><dimension></span></tt> element. A transverse dimension must have a unique name defined by a <tt class="docutils literal"><span class="pre">name</span></tt> attribute. If it is not specified, the type of dimension will default to “real”, otherwise it can be specified with the <tt class="docutils literal"><span class="pre">type</span></tt> attribute. Allowable types (other than “real”) are “long”, “int”, and “integer”, which are actually all synonyms for an integer-valued dimension.</p>
<p id="index-28">Each transverse dimension must specify how many points or modes it requires, and the range over which it is defined. This is done by the <tt class="docutils literal"><span class="pre">lattice</span></tt> and <tt class="docutils literal"><span class="pre">domain</span></tt> attributes respectively. The <tt class="docutils literal"><span class="pre">lattice</span></tt> attribute is an integer, and is optional for integer dimensions, where it can be defined implicitly by the domain. The <tt class="docutils literal"><span class="pre">domain</span></tt> attribute is specified as a pair of numbers (e.g. <tt class="docutils literal"><span class="pre">domain="(-17,3)"</span></tt>) defining the minimum and maximum of the grid.</p>
<p id="index-29">Any dimension can have a number of aliases. These act exactly like copies of that dimension, but must be included explicitly in the definition of subsequent vectors (i.e. they are not included in the default list of dimensions for a new vector). The list of aliases for a dimension are included in an <tt class="docutils literal"><span class="pre">aliases</span></tt> attribute. They are useful for non-local reference of variables. See <tt class="docutils literal"><span class="pre">groundstate_gaussian.xmds</span></tt> and <tt class="docutils literal"><span class="pre">2DMultistateSE.xmds</span></tt> as examples.</p>
<p id="index-30">Integrals over a dimension can be multiplied by a common prefactor, which is specified using the <tt class="docutils literal"><span class="pre">volume_prefactor</span></tt> attribute. For example, this allows the automatic inclusion of a factor of two due to a reflection symmetry by adding the attribute <tt class="docutils literal"><span class="pre">volume_prefactor="2"</span></tt>. In very specific cases, you may wish to refer to volume elements explicitly. This will lead to grid-dependent behaviour, which is sometimes required in certain stochastic field simulations, for example. In this case, the volume element for each variable is described by a <tt class="docutils literal"><span class="pre">d</span></tt> prefix (e.g. <tt class="docutils literal"><span class="pre">lambda</span></tt> would be referred to as <tt class="docutils literal"><span class="pre">dlambda</span></tt>). These volume elements contain any implicit prefactors (for example, the radial coordinate for dimensions defined using <a class="reference internal" href="#besseltransform"><em>Bessel transforms</em></a>), including the <tt class="docutils literal"><span class="pre">volume_prefactor</span></tt> element.</p>
<p>If you are using the <tt class="docutils literal"><span class="pre">distributed-mpi</span></tt> driver to parallelise the simulation, place the dimension you wish to split over multiple processors first. The most efficient parallelisation would involve distributing a dimension with only local evolution, as the different memory blocks would not need to communicate. Nonlocal evolution that is local in Fourier space is the second preference, as the Fourier transform can also be successfully parallelised with minimum communication.</p>
<p id="transforms"><span id="index-31"></span>Each transverse dimension can be associated with a transform. This allows the simulation to manipulate vectors defined on that dimension in the transform space. The default is Fourier space (with the associated transform being the discrete Fourier transform, or “dft”), but others can be specified with the <tt class="docutils literal"><span class="pre">transform</span></tt> attribute. The other options are “none”, “dst”, “dct”, “bessel”, “spherical-bessel”, “bessel-neumann” and “hermite-gauss”. Using the right transform can dramatically improve the speed of a calculation.</p>
<p id="index-32">An advanced feature discussed further in <a class="reference internal" href="advanced_topics.html#dimensionaliases"><em>Dimension aliases</em></a> are dimension aliases, which are specified by the <tt class="docutils literal"><span class="pre">aliases</span></tt> attribute. This feature is useful for example, when calculating correlation functions.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="c"><!-- A real-valued dimension from -1.5 to 1.5 --></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(-1.5, 1.5)"</span> <span class="nt">/></span>
<span class="c"><!-- An integer-valued dimension with the 6 values -2, -1, 0, 1, 2, 3 --></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"j"</span> <span class="na">domain=</span><span class="s">"(-2,3)"</span> <span class="na">type=</span><span class="s">"integer"</span> <span class="nt">/></span>
<span class="c"><!-- A real-valued dimension using the bessel transform for a radial coordinate --></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"r"</span> <span class="na">lattice=</span><span class="s">"64"</span> <span class="na">domain=</span><span class="s">"(0, 5)"</span> <span class="na">transform=</span><span class="s">"bessel"</span> <span class="na">volume_prefactor=</span><span class="s">"2.0*M_PI"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
<div class="section" id="the-dft-transform">
<span id="dft-transform"></span><span id="index-33"></span><h3>The “dft” transform<a class="headerlink" href="#the-dft-transform" title="Permalink to this headline">¶</a></h3>
<p id="index-34">The “dft” transform is performed using the the normal discrete Fourier transform, which means that it enforces periodic boundary conditions on vectors defined on that dimension. Another implication is that it can only be used with complex-valued vectors. The discrete Fourier transform is almost exactly the same as a standard Fourier transform. The standard Fourier transform is</p>
<div class="math">
\[\mathcal{F}\left[f(x)\right](k) = \frac{1}{\sqrt{2\pi}}\int_{x_\text{min}}^{x_\text{max}} f(x) e^{-i k x} dx\]</div>
<p>The discrete Fourier transform has no information about the domain of the lattice, so the XMDS2 transform is equivalent to</p>
<div class="math">
\[\begin{split}\tilde{\mathcal{F}}\left[f(x)\right](k) &= \frac{1}{\sqrt{2\pi}}\int_{x_\text{min}}^{x_\text{max}} f(x) e^{-i k (x+ x_\text{min})} dx \\
&= e^{-i x_\text{min} k} \mathcal{F}\left[f(x)\right](k)\end{split}\]</div>
<p>The standard usage in an XMDS simulation involves moving to Fourier space, applying a transformation, and then moving back. For this purpose, the two transformations are entirely equivalent as the extra phase factor cancels. However, when fields are explicitly defined in Fourier space, care must be taken to include this phase factor explicitly. See section <a class="reference internal" href="advanced_topics.html#convolutions"><em>Convolutions and Fourier transforms</em></a> in the Advanced Topics section.</p>
<p>When a dimension uses the “dft” transform, then the Fourier space variable is defined as the name of the dimension prefixed with a “k”. For example, the dimensions “x”, “y”, “z” and “tau” will be referenced in Fourier space as “kx”,”ky”, “kz” and “ktau”.</p>
<p>Fourier transforms allow easy calculation of derivatives, as the n<sup>th</sup> derivative of a field is proportional to the n<sup>th</sup> moment of the field in Fourier space:</p>
<div class="math">
\[\mathcal{F}\left[\frac{\partial^n f(x)}{\partial x^n}\right](k_x) = \left(i \;k_x\right)^n \mathcal{F}\left[f(x)\right](k_x)\]</div>
<p>This identity can be used to write the differential operator <span class="math">\(\mathcal{L} = \frac{\partial}{\partial x}\)</span> as an <tt class="docutils literal"><span class="pre">IP</span></tt> or <tt class="docutils literal"><span class="pre">EX</span></tt> operator as <tt class="docutils literal"><span class="pre">L</span> <span class="pre">=</span> <span class="pre">i*kx;</span></tt> (see <a class="reference internal" href="#operatorselement"><em>Operators and operator elements</em></a> for more details).</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="c"><!-- transform="dft" is the default, omitting it wouldn't change anything --></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(-1.5, 1.5)"</span> <span class="na">transform=</span><span class="s">"dft"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="the-dct-transform">
<span id="dct-transform"></span><span id="index-35"></span><h3>The “dct” transform<a class="headerlink" href="#the-dct-transform" title="Permalink to this headline">¶</a></h3>
<p id="index-36">The “dct” (discrete cosine transform) is a Fourier-based transform that implies different boundary conditions for associated vectors. XMDS uses the type-II DCT, often called “the DCT”, and its inverse, which is also called the type-III DCT. This transform assumes that any vector using this dimension is both periodic, and also even around a specific point within each period. The grid is therefore only defined across a half period in order to sample each unique point once, and can therefore be of any shape where all the odd derivatives are zero at each boundary. This is a very different boundary condition compared to the DFT, which demands periodic boundary conditions, and is therefore suitable for different simulations. For example, the DCT is a natural choice when implementing zero Neumann boundary conditions.</p>
<p>As the DCT transform can be defined on real data rather only complex data, it can also be superior to DFT-based spectral methods for simulations of real-valued fields where boundary conditions are artificial.</p>
<p>XMDS labels the cosine transform space variables the same as for <a class="reference internal" href="#dft-transform"><em>Fourier transforms</em></a> and all the even derivatives can be calculated the same way. Odd moments of the cosine-space variables are in fact <em>not</em> related to the corresponding odd derivatives by an inverse cosine transform.</p>
<p>Discrete cosine transforms allow easy calculation of even-order derivatives, as the 2n<sup>th</sup> derivative of a field is proportional to the 2n<sup>th</sup> moment of the field in DCT-space:</p>
<div class="math">
\[\mathcal{F}_\text{DCT}\left[\frac{\partial^{2n} f(x)}{\partial x^{2n}}\right](k_x) = (-k_x^2)^{n}\; \mathcal{F}_\text{DCT}\left[f(x)\right](k_x)\]</div>
<p>This identity can be used to write the differential operator <span class="math">\(\mathcal{L} = \frac{\partial^2}{\partial x^2}\)</span> as an <tt class="docutils literal"><span class="pre">IP</span></tt> or <tt class="docutils literal"><span class="pre">EX</span></tt> operator as <tt class="docutils literal"><span class="pre">L</span> <span class="pre">=</span> <span class="pre">-kx*kx;</span></tt> (see <a class="reference internal" href="#operatorselement"><em>Operators and operator elements</em></a> for more details).</p>
<p>For problems where you are defining the simulation domain over only half of the physical domain to take advantage of reflection symmetry, consider using <tt class="docutils literal"><span class="pre">volume_prefactor="2.0"</span></tt> so that all volume integrals are over the entire physical domain, not just the simulation domain. i.e. integrals would be over -1 to 1 instead of 0 to 1 if the domain was specified as <tt class="docutils literal"><span class="pre">domain="(0,1)"</span></tt>.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(-1.5, 1.5)"</span> <span class="na">transform=</span><span class="s">"dct"</span> <span class="nt">/></span>
<span class="c"><!-- Or to cause volume integrals to be multiplied by 2 --></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"y"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(0, 1)"</span> <span class="na">transform=</span><span class="s">"dct"</span> <span class="na">volume_prefactor=</span><span class="s">"2.0"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="the-dst-transform">
<span id="dst-transform"></span><span id="index-37"></span><h3>The “dst” transform<a class="headerlink" href="#the-dst-transform" title="Permalink to this headline">¶</a></h3>
<p>The “dst” (discrete sine transform) is a counterpart to the DCT transform. XMDS uses the type-II DST and its inverse, which is also called the type-III DST. This transform assumes that fields are periodic in this dimension, but also that they are also odd around a specific point within each period. The grid is therefore only defined across a half period in order to sample each unique point once, and can therefore be of any shape where all the even derivatives are zero at each boundary.</p>
<p id="index-38">The DST transform can be defined on real-valued vectors. As odd-valued functions are zero at the boundaries, this is a natural transform to use when implementing zero Dirichlet boundary conditions.</p>
<p>XMDS labels the sine transform space variables the same as for <a class="reference internal" href="#dft-transform"><em>Fourier transforms</em></a> and all the even derivatives can be calculated the same way. Odd moments of the sine-space variables are in fact <em>not</em> related to the corresponding odd derivatives by an inverse sine transform.</p>
<p>Discrete sine transforms allow easy calculation of even-order derivatives, as the 2n<sup>th</sup> derivative of a field is proportional to the 2n<sup>th</sup> moment of the field in DST-space:</p>
<div class="math">
\[\mathcal{F}_\text{DST}\left[\frac{\partial^{2n} f(x)}{\partial x^{2n}}\right](k_x) = (-k_x^2)^{n}\; \mathcal{F}_\text{DST}\left[f(x)\right](k_x)\]</div>
<p>This identity can be used to write the differential operator <span class="math">\(\mathcal{L} = \frac{\partial^2}{\partial x^2}\)</span> as an <tt class="docutils literal"><span class="pre">IP</span></tt> or <tt class="docutils literal"><span class="pre">EX</span></tt> operator as <tt class="docutils literal"><span class="pre">L</span> <span class="pre">=</span> <span class="pre">-kx*kx;</span></tt> (see <a class="reference internal" href="#operatorselement"><em>Operators and operator elements</em></a> for more details).</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(0, 1.5)"</span> <span class="na">transform=</span><span class="s">"dst"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="the-bessel-and-bessel-neumann-transforms">
<span id="besseltransform"></span><span id="index-39"></span><h3>The “bessel” and “bessel-neumann” transforms<a class="headerlink" href="#the-bessel-and-bessel-neumann-transforms" title="Permalink to this headline">¶</a></h3>
<p>Just as the Fourier basis is useful for finding derivatives in Euclidean geometry, the basis of Bessel functions is useful for finding certain common operators in cylindrical co-ordinates. In particular, we use the Bessel functions of the first kind, <span class="math">\(J_m(u)\)</span>. The relevant transform is the Hankel transform:</p>
<div class="math">
\[F_m(k) = \mathcal{H}_m \left[f\right](k) = \int_0^\infty r f(r) J_m(k r) dr\]</div>
<p>which has the inverse transform:</p>
<div class="math">
\[f(r) = \mathcal{H}^{-1}_m \left[F_m\right](r) = \int_0^\infty k F_m(k) J_m(k r) dk\]</div>
<p>This transform pair has the useful property that the Laplacian in cylindrical co-ordinates is diagonal in this basis:</p>
<div class="math">
\[\begin{split}\nabla^2 \left(f(r) e^{i m \theta}\right) &= \left(\frac{\partial^2 f}{\partial r^2} +\frac{1}{r}\frac{\partial f}{\partial r} -\frac{m^2}{r^2} f \right) e^{i m \theta} = \left\{\mathcal{H}^{-1}_m \left[(-k^2) F_m(k)\right](r) \right\} e^{i m \theta}\end{split}\]</div>
<p>XMDS labels the variables in the transformed space with a prefix of ‘k’, just as for <a class="reference internal" href="#dft-transform"><em>Fourier transforms</em></a>. The order <span class="math">\(m\)</span> of the transform is defined by the <tt class="docutils literal"><span class="pre">order</span></tt> attribute in the <tt class="docutils literal"><span class="pre"><dimension></span></tt> element, which must be assigned as a non-negative integer. If the order is not specified, it defaults to zero which corresponds to the solution being independent of the angular coordinate <span class="math">\(\theta\)</span>.</p>
<p id="index-40">The difference between the “bessel” and “bessel-neumann” transforms is that the “bessel” transform enforces Dirichlet boundary conditions at the edge of the computational domain (<span class="math">\(f(R) = 0\)</span>), while “bessel-neumann” enforces Neumann boundary conditions (<span class="math">\(\left.\frac{\partial}{\partial r}f(r) \right|_{r=R} = 0\)</span>).</p>
<p>It can often be useful to have a different sampling in normal space and Hankel space. Reducing the number of modes in either space dramatically speeds simulations. To set the number of lattice points in Hankel space to be different to the number of lattice points for the field in its original space, use the attribute <tt class="docutils literal"><span class="pre">spectral_lattice</span></tt>. The Bessel space lattice is chosen such that the boundary condition at the edge of the domain is zero. This ensures that all of the Bessel modes are orthogonal. The spatial lattice is also chosen in a non-uniform manner so that Gaussian quadrature methods can be usedfor spectrally accurate transforms.</p>
<p>Hankel transforms allow easy calculation of the Laplacian of fields with cylindrical symmetry. Applying the operator <tt class="docutils literal"><span class="pre">L</span> <span class="pre">=</span> <span class="pre">-kr*kr</span></tt> in Hankel space is therefore equivalent to applying the operator</p>
<div class="math">
\[\mathcal{L} = \left(\frac{\partial^2}{\partial r^2} +\frac{1}{r}\frac{\partial}{\partial r} -\frac{m^2}{r^2} \right)\]</div>
<p>in coordinate space.</p>
<p>In non-Euclidean co-ordinates, integrals have non-unit volume elements. For example, in cylindrical co-ordinates with a radial co-ordinate ‘r’, integrals over this dimension have a volume element <span class="math">\(r dr\)</span>. When performing integrals along a dimension specified by the “bessel” transform, the factor of the radius is included implicitly. If you are using a geometry with some symmetry, it is common to have prefactors in your integration. For example, for a two-dimensional volume in cylindrical symmetry, all integrals would have a volume element of <span class="math">\(2\pi r dr\)</span>. This extra factor of <span class="math">\(2 \pi\)</span> can be included for all integrals by specifying the attribute <tt class="docutils literal"><span class="pre">volume_prefactor="2*M_PI"</span></tt>. See the example <tt class="docutils literal"><span class="pre">bessel_cosine_groundstate.xmds</span></tt> for a demonstration.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"r"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(0, 3)"</span> <span class="na">transform=</span><span class="s">"bessel"</span> <span class="na">volume_prefactor=</span><span class="s">"2*M_PI"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="the-spherical-bessel-transform">
<span id="spherical-bessel-transform"></span><span id="index-41"></span><h3>The “spherical-bessel” transform<a class="headerlink" href="#the-spherical-bessel-transform" title="Permalink to this headline">¶</a></h3>
<p>When working in spherical coordinates, it is often useful to use the spherical Bessel functions <span class="math">\(j_l(x)=\sqrt{\frac{\pi}{2x}}J_{l+\frac{1}{2}}(x)\)</span> as a basis. These are eigenfunctions of the radial component of Laplace’s equation in spherical coordinates:</p>
<div class="math">
\[\begin{split}\nabla^2 \left[j_l(k r)\; Y^m_l(\theta, \phi)\right] &= \left[\frac{\partial^2 }{\partial r^2} +\frac{2}{r}\frac{\partial }{\partial r} -\frac{l(l+1)}{r^2}\right] j_l(k r) \; Y^m_l(\theta, \phi) = -k^2 j_l(k r)\; Y^m_l(\theta, \phi)\end{split}\]</div>
<p>Just as the Bessel basis above, the transformed dimensions are prefixed with a ‘k’, and it is possible (and usually wise) to use the <tt class="docutils literal"><span class="pre">spectral_lattice</span></tt> attribute to specify a different lattice size in the transformed space. Also, the spacing of these lattices are again chosen in a non-uniform manner to Gaussian quadrature methods for spectrally accurate transforms. Finally, the <tt class="docutils literal"><span class="pre">order</span></tt> attribute can be used to specify the order <span class="math">\(l\)</span> of the spherical Bessel functions used.</p>
<p>If we denote the transformation to and from this basis by <span class="math">\(\mathcal{SH}\)</span>, then we can write the useful property:</p>
<div class="math">
\[\frac{\partial^2 f}{\partial r^2} +\frac{2}{r}\frac{\partial f}{\partial r} -\frac{l (l+1)}{r^2} = \mathcal{SH}^{-1}_l \left[(-k^2) F_l(k)\right](r)\]</div>
<p>Spherical Bessel transforms allow easy calculation of the Laplacian of fields with spherical symmetry. Applying the operator <tt class="docutils literal"><span class="pre">L</span> <span class="pre">=</span> <span class="pre">-kr*kr</span></tt> in Spherical Bessel space is therefore equivalent to applying the operator</p>
<div class="math">
\[\mathcal{L} = \left( \frac{\partial^2}{\partial r^2} +\frac{2}{r}\frac{\partial}{\partial r} -\frac{l (l+1)}{r^2} \right)\]</div>
<p>in coordinate space.</p>
<p>In non-Euclidean co-ordinates, integrals have non-unit volume elements. For example, in spherical co-ordinates with a radial co-ordinate ‘r’, integrals over this dimension have a volume element <span class="math">\(r^2 dr\)</span>. When performing integrals along a dimension specified by the “spherical-bessel” transform, the factor of the square of the radius is included implicitly. If you are using a geometry with some symmetry, it is common to have prefactors in your integration. For example, for a three-dimensional volume in spherical symmetry, all integrals would have a volume element of <span class="math">\(4\pi r^2 dr\)</span>. This extra factor of <span class="math">\(4 \pi\)</span> can be included for all integrals by specifying the attribute <tt class="docutils literal"><span class="pre">volume_prefactor="4*M_PI"</span></tt>. This is demonstrated in the example bessel_transform.xmds.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"r"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(0, 3)"</span> <span class="na">transform=</span><span class="s">"spherical-bessel"</span> <span class="na">volume_prefactor=</span><span class="s">"4*M_PI"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="the-hermite-gauss-transform">
<span id="hermite-gauss-transform"></span><span id="index-42"></span><h3>The “hermite-gauss” transform<a class="headerlink" href="#the-hermite-gauss-transform" title="Permalink to this headline">¶</a></h3>
<p>The “hermite-gauss” transform allows transformations to and from the basis of Hermite functions <span class="math">\(\psi_n(x)\)</span>:</p>
<div class="math">
\[\psi_n(x) = \left(2^n n! \sigma \sqrt{\pi}\right)^{-1/2} e^{-x^2/2\sigma^2} H_n(\sigma x)\]</div>
<p>where the functions <span class="math">\(H_n(x)\)</span> are the Hermite polynomials:</p>
<div class="math">
\[\begin{split}H_n(x) &= (-1)^n e^{x^2} \frac{d^n}{dx^n} \left(e^{-x^2}\right)\end{split}\]</div>
<p>which are eigenfunctions of the Schroedinger equation for a harmonic oscillator:</p>
<div class="math">
\[- \frac{\hbar^2}{2 m} \frac{\partial^2 \psi_n}{\partial x^2} + \frac{1}{2} m \omega^2 x^2 \psi_n(x) = \hbar \omega\left(n+\frac{1}{2}\right) \psi_n(x),\]</div>
<p>with <span class="math">\(\sigma = \sqrt{\frac{\hbar}{m \omega}}\)</span>.</p>
<p id="index-43">This transform is different to the others in that it requires a <tt class="docutils literal"><span class="pre">length_scale</span></tt> attribute rather than a <tt class="docutils literal"><span class="pre">domain</span></tt> attribute, as the range of the lattice will depend on the number of basis functions used. The <tt class="docutils literal"><span class="pre">length_scale</span></tt> attribute defines the scale of the domain as the standard deviation <span class="math">\(\sigma\)</span> of the lowest order Hermite function <span class="math">\(\psi_0(x)\)</span>:</p>
<div class="math">
\[\psi_0(x) = (\sigma^2 \pi)^{-1/4} e^{-x^2/2 \sigma^2}\]</div>
<p>When a dimension uses the “hermite-gauss” transform, then the variable indexing the basis functions is defined as the name of the dimension prefixed with an “n”. For example, when referencing the basis function indices for the dimensions “x”, “y”, “z” and “tau”, use the variable “nx”, “ny”, “nz” and “ntau”.</p>
<p>Applying the operator <tt class="docutils literal"><span class="pre">L</span> <span class="pre">=</span> <span class="pre">nx</span> <span class="pre">+</span> <span class="pre">0.5</span></tt> in Hermite space is therefore equivalent to applying the operator</p>
<div class="math">
\[\mathcal{L} = \left(- \frac{\sigma^2}{2}\frac{\partial^2}{\partial x^2} + \frac{1}{2 \sigma^2} x^2 \right)\]</div>
<p>in coordinate space.</p>
<p>The Hermite-Gauss transform permits one to work in energy-space for the harmonic oscillator. The normal Fourier transform of “hermite-gauss” dimensions can also be referenced using the dimension name prefixed with a “k”. See the examples <tt class="docutils literal"><span class="pre">hermitegauss_transform.xmds</span></tt> and <tt class="docutils literal"><span class="pre">hermitegauss_groundstate.xmds</span></tt> for examples.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"r"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">length_scale=</span><span class="s">"1.0"</span> <span class="na">transform=</span><span class="s">"hermite-gauss"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="vector-element">
<span id="vectorelement"></span><span id="index-44"></span><h2>Vector Element<a class="headerlink" href="#vector-element" title="Permalink to this headline">¶</a></h2>
<p>Vectors are arrays of data, defined over any subset of the transverse dimensions defined in your <a class="reference internal" href="#geometryelement"><em>Geometry Element</em></a>. These dimensions are listed in the attribute <tt class="docutils literal"><span class="pre">dimensions</span></tt>, which can be an empty string if you wish the vector to not be defined on any dimensions. If you do not include a <tt class="docutils literal"><span class="pre">dimensions</span></tt> attribute then the vector defaults to being a function of all transverse dimensions, not including any aliases. Vectors are used to store static or dynamic variables, but you do not have to specify their purpose when they are defined. They can then be referenced and/or changed by sequence elements, as described below.</p>
<p id="index-45">Each <tt class="docutils literal"><span class="pre"><vector></span></tt> element has a unique name, defined by a <tt class="docutils literal"><span class="pre">name</span></tt> attribute. It is either complex-valued (the default) or real-valued, which can be specified using the <tt class="docutils literal"><span class="pre">type="real"</span></tt> attribute.</p>
<p id="componentselement"><span id="index-46"></span>A vector contains a list of variables, each defined by name in the <tt class="docutils literal"><span class="pre"><components></span></tt> element. The name of each component is the name used to reference it later in the simulation.</p>
<p id="index-47">Vectors are initialised at the beginning of a simulation, either from code or from an input file. The basis choice for this initialisation defaults to the normal space as defined in the <tt class="docutils literal"><span class="pre"><geometry></span></tt> element, but any transverse dimension can be initialised in their transform basis by specifying them in an <tt class="docutils literal"><span class="pre">initial_basis</span></tt> attribute. The <tt class="docutils literal"><span class="pre">initial_basis</span></tt> attribute lists dimensions either by their name as defined by the <tt class="docutils literal"><span class="pre"><geometry></span></tt> element, or by their transformed name. For example, to initialise a two-dimensional vector defined with <tt class="docutils literal"><span class="pre">dimensions="x</span> <span class="pre">y"</span></tt> in Fourier space for the y-dimension, we would include the attribute <tt class="docutils literal"><span class="pre">initial_basis="x</span> <span class="pre">ky"</span></tt>, or just <tt class="docutils literal"><span class="pre">initial_basis="ky"</span></tt>.</p>
<p id="initialisationelement"><span id="index-48"></span>When initialising the vector within the XMDS script, the appropriate code is placed in a ‘CDATA’ block inside an <tt class="docutils literal"><span class="pre"><initialisation></span></tt> element. This code is in standard C-syntax, and should reference the components of the vector by name. XMDS defines a few useful <a class="reference internal" href="#xmdscsyntax"><em>shorthand macros</em></a> for this C-code. If you wish to initialise all the components of the vector as zeros, then it suffices simply to add the attribute <tt class="docutils literal"><span class="pre">kind="zero"</span></tt> or to omit the <tt class="docutils literal"><span class="pre"><initialisation></span></tt> element entirely.</p>
<p id="referencingnonlocal"><span id="index-49"></span>While the default XMDS behaviour is to reference all variables locally, any vector can be referenced non-locally. The notation for referencing the value of a vector ‘phi’ with a dimension ‘j’ at a value of ‘j=jk’ is <tt class="docutils literal"><span class="pre">phi(j</span> <span class="pre">=></span> <span class="pre">jk)</span></tt>. Multiple non-local dimensions are addressed by adding the references in a list, e.g. <tt class="docutils literal"><span class="pre">phi(j</span> <span class="pre">=></span> <span class="pre">jk,</span> <span class="pre">x</span> <span class="pre">=></span> <span class="pre">y)</span></tt>. See <tt class="docutils literal"><span class="pre">2DMultistateSE.xmds</span></tt> for an example.</p>
<p>Dimensions can only be accessed non-locally if one of the following conditions is true:</p>
<ul class="simple">
<li>The dimension is an <tt class="docutils literal"><span class="pre">integer</span></tt> dimension,</li>
<li>The dimension is accessed with an <a class="reference internal" href="advanced_topics.html#dimensionaliases"><em>alias</em></a> of that dimension. For example, <tt class="docutils literal"><span class="pre">phi(x</span> <span class="pre">=></span> <span class="pre">y)</span></tt> if the dimension <tt class="docutils literal"><span class="pre">x</span></tt> has <tt class="docutils literal"><span class="pre">y</span></tt> as an alias, or vice-versa.</li>
<li>The dimension is a Fourier transform dimension (<tt class="docutils literal"><span class="pre">dft</span></tt>), used in the spectral basis (i.e. <tt class="docutils literal"><span class="pre">kx</span></tt> for an <tt class="docutils literal"><span class="pre">x</span></tt> dimension) and it is accessed with the negative of that dimension. For example <tt class="docutils literal"><span class="pre">phi(kx</span> <span class="pre">=></span> <span class="pre">-kx)</span></tt>.</li>
<li>The dimension is uniformly spaced (i.e. corresponds to the spatial basis of a dimension with a transform of <tt class="docutils literal"><span class="pre">dft</span></tt>, <tt class="docutils literal"><span class="pre">dct</span></tt>, <tt class="docutils literal"><span class="pre">dst</span></tt> or <tt class="docutils literal"><span class="pre">none</span></tt>), the dimension is symmetric about zero and it is accessed with the negative of the dimension name. For example <tt class="docutils literal"><span class="pre">phi(x</span> <span class="pre">=></span> <span class="pre">-x)</span></tt> for a dimension with domain of <tt class="docutils literal"><span class="pre">(-1.2,</span> <span class="pre">1.2)</span></tt>.</li>
<li>The dimension is uniformly spaced (i.e. corresponds to the spatial basis of a dimension with a transform of <tt class="docutils literal"><span class="pre">dft</span></tt>, <tt class="docutils literal"><span class="pre">dct</span></tt>, <tt class="docutils literal"><span class="pre">dst</span></tt> or <tt class="docutils literal"><span class="pre">none</span></tt>), and it is accessed with the lower limit of that dimension. For example, <tt class="docutils literal"><span class="pre">phi(x</span> <span class="pre">=></span> <span class="pre">-1.2)</span></tt> for a dimension with a domain of <tt class="docutils literal"><span class="pre">(-1.2,</span> <span class="pre">1.2)</span></tt>. Note that the dimension must be accessed with the exact characters used in the definition of the domain. For the previous example <tt class="docutils literal"><span class="pre">phi(x</span> <span class="pre">=></span> <span class="pre">-1.20)</span></tt> does not satisfy this condition.</li>
<li><strong>Advanced behaviour</strong>: The value of a variable at an arbitrary point can be accessed via the integer index for that dimension. For example <tt class="docutils literal"><span class="pre">phi(x_index</span> <span class="pre">=></span> <span class="pre">3)</span></tt> accesses the value of <tt class="docutils literal"><span class="pre">phi</span></tt> at the grid point with index 3. As <tt class="docutils literal"><span class="pre">x_index</span></tt> is zero-based, this will be the <em>fourth</em> grid point. It is highly recommended that the <a class="reference internal" href="#diagnostics"><em>diagnostics</em></a> feature be used when writing simulations using this feature. Once the simulation has been tested, <tt class="docutils literal"><span class="pre"><diagnostics></span></tt> can be turned off for data-taking runs.</li>
</ul>
<p id="index-50">Note that a dimension cannot be accessed non-locally in <tt class="docutils literal"><span class="pre">distributed-mpi</span></tt> simulations if the simulation is distributed across that dimension.</p>
<span class="target" id="filenameelement"><span id="index-51"></span></span><p id="index-52">If you wish to initialise from a file, then you can choose to initialise from an hdf5 file using <tt class="docutils literal"><span class="pre">kind="hdf5"</span></tt> in the <tt class="docutils literal"><span class="pre"><initialisation></span></tt> element, and then supply the name of the input file with the <tt class="docutils literal"><span class="pre">filename</span></tt> element. This is a standard data format which can be generated from XMDS, or from another program. An example for generating a file in another program for input into XMDS is detailed in the Advanced topic: <a class="reference internal" href="advanced_topics.html#importing"><em>Importing data</em></a>.</p>
<p id="index-53">When initialising from a file, the default is to require the lattice of the transverse dimensions to exactly match the lattice defined by XMDS. There is an option to import data defined on a subset or superset of the lattice points. Obviously, the dimensionality of the imported field still has to be correct. This option is activated by defining the attribute <tt class="docutils literal"><span class="pre">geometry_matching_mode="loose"</span></tt>. The default option is defined as <tt class="docutils literal"><span class="pre">geometry_matching_mode="strict"</span></tt>. A requirement of the initialisation geometry is that the lattice points of the input file are spaced identically to those of the simulation grid. This allows expanding or contracting a domain between simulations. If used in Fourier space, this feature can be used for coarsening or refining a simulation grid. See <a class="reference internal" href="advanced_topics.html#loosegeometrymatchingmode"><em>‘Loose’ geometry_matching_mode</em></a> for details.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(-1, 1)"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="c"><!-- A one-dimensional vector with dimension 'x' --></span>
<span class="nt"><vector</span> <span class="na">name=</span><span class="s">"wavefunction"</span> <span class="na">initial_basis=</span><span class="s">"x"</span> <span class="na">type=</span><span class="s">"complex"</span><span class="nt">></span>
<span class="nt"><components></span> phi <span class="nt"></components></span>
<span class="nt"><initialisation></span>
<span class="cp"><![CDATA[</span>
<span class="c1">// 'cis(x)' is cos(x) + i * sin(x)</span>
<span class="n">phi</span> <span class="o">=</span> <span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">0.5</span> <span class="o">*</span> <span class="n">x</span> <span class="o">*</span> <span class="n">x</span><span class="p">)</span> <span class="o">*</span> <span class="n">cis</span><span class="p">(</span><span class="mi">40</span> <span class="o">*</span> <span class="n">x</span><span class="p">);</span>
<span class="cp">]]></span>
<span class="nt"></initialisation></span>
<span class="nt"></vector></span>
<span class="c"><!-- A zero-dimensional real vector with components u and v --></span>
<span class="nt"><vector</span> <span class="na">name=</span><span class="s">"zero_dim"</span> <span class="na">dimensions=</span><span class="s">""</span> <span class="na">type=</span><span class="s">"real"</span><span class="nt">></span>
<span class="nt"><components></span>
u v
<span class="nt"></components></span>
<span class="nt"><initialisation</span> <span class="na">kind=</span><span class="s">"hdf5"</span><span class="nt">></span>
<span class="nt"><filename></span>data.h5<span class="nt"></filename></span>
<span class="nt"></initialisation></span>
<span class="nt"></vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
<div class="section" id="the-dependencies-element">
<span id="dependencies"></span><span id="index-54"></span><h3>The dependencies element<a class="headerlink" href="#the-dependencies-element" title="Permalink to this headline">¶</a></h3>
<p>Often a vector, computed vector, filter, integration operator or output group will reference the values in one or more other vectors, computed vectors or noise vectors. These dependencies are defined via a <tt class="docutils literal"><span class="pre"><dependencies></span></tt> element, which lists the names of the vectors. The components of those vectors will then be available for use in the ‘CDATA’ block, and can be referenced by their name.</p>
<p id="index-55">For a vector, the basis of the dependent vectors, and therefore the basis of the dimensions available in the ‘CDATA’ block, are defined by the <tt class="docutils literal"><span class="pre">initial_basis</span></tt> of the vector. For a <tt class="docutils literal"><span class="pre"><computed_vector></span></tt>, <tt class="docutils literal"><span class="pre"><filter></span></tt> <tt class="docutils literal"><span class="pre"><integration_vector></span></tt>, or moment group vector, the basis of the dependencies can be specified by a <tt class="docutils literal"><span class="pre">basis</span></tt> attribute in the <tt class="docutils literal"><span class="pre"><dependencies></span></tt> element. For example, <tt class="docutils literal"><span class="pre">basis="x</span> <span class="pre">ny</span> <span class="pre">kz"</span></tt>.</p>
<p>Any transverse dimensions that appear in the <tt class="docutils literal"><span class="pre"><dependencies></span></tt> element that do not appear in the <tt class="docutils literal"><span class="pre">dimensions</span></tt> attribute of the vector are integrated out. For integer dimensions, this is simply an implicit sum over the dimension. For real-valued dimensions, this is an implicit integral over the range of that dimension.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(-1, 1)"</span> <span class="nt">/></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"y"</span> <span class="na">lattice=</span><span class="s">"10"</span> <span class="na">domain=</span><span class="s">"(-3, 2)"</span> <span class="na">transform=</span><span class="s">"dct"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="c"><!-- A one-dimensional vector with dimension 'x' --></span>
<span class="nt"><vector</span> <span class="na">name=</span><span class="s">"wavefunction"</span> <span class="na">dimensions=</span><span class="s">"x"</span> <span class="na">initial_basis=</span><span class="s">"x"</span> <span class="na">type=</span><span class="s">"complex"</span><span class="nt">></span>
<span class="nt"><components></span> phi <span class="nt"></components></span>
<span class="nt"><initialisation></span>
<span class="c"><!--</span>
<span class="c"> The initialisation of the vector 'wavefunction' depends on information</span>
<span class="c"> in the 'two_dim' vector. The vector two_dim is DCT-transformed into the</span>
<span class="c"> (x, ky) basis, and the ky dimension is implicitly integrated over in the</span>
<span class="c"> following initialisation code</span>
<span class="c"> --></span>
<span class="nt"><dependencies</span> <span class="na">basis=</span><span class="s">"x ky"</span><span class="nt">></span>two_dim<span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="c1">// 'cis(x)' is cos(x) + i * sin(x)</span>
<span class="n">phi</span> <span class="o">=</span> <span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">0.5</span> <span class="o">*</span> <span class="n">x</span> <span class="o">*</span> <span class="n">x</span> <span class="o">+</span> <span class="n">v</span><span class="p">)</span> <span class="o">*</span> <span class="n">cis</span><span class="p">(</span><span class="n">u</span> <span class="o">*</span> <span class="n">x</span><span class="p">);</span>
<span class="cp">]]></span>
<span class="nt"></initialisation></span>
<span class="nt"></vector></span>
<span class="c"><!-- A two-dimensional real vector with components u and v --></span>
<span class="nt"><vector</span> <span class="na">name=</span><span class="s">"two_dim"</span> <span class="na">type=</span><span class="s">"real"</span><span class="nt">></span>
<span class="nt"><components></span>
u v
<span class="nt"></components></span>
<span class="nt"><initialisation</span> <span class="na">kind=</span><span class="s">"hdf5"</span><span class="nt">></span>
<span class="nt"><filename></span>data.h5<span class="nt"></filename></span>
<span class="nt"></initialisation></span>
<span class="nt"></vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="computed-vector-element">
<span id="computedvectorelement"></span><span id="index-56"></span><h2>Computed Vector Element<a class="headerlink" href="#computed-vector-element" title="Permalink to this headline">¶</a></h2>
<p id="evaluationelement"><span id="index-57"></span>Computed vectors are arrays of data much like normal <tt class="docutils literal"><span class="pre"><vector></span></tt> elements, but they are always calculated as they are referenced, so they cannot be initialised from file. It is defined with a <tt class="docutils literal"><span class="pre"><computed_vector></span></tt> element, which has a <tt class="docutils literal"><span class="pre">name</span></tt> attribute, optional <tt class="docutils literal"><span class="pre">dimensions</span></tt> and <tt class="docutils literal"><span class="pre">type</span></tt> attributes, and a <tt class="docutils literal"><span class="pre"><components></span></tt> element, just like a <tt class="docutils literal"><span class="pre"><vector></span></tt> element. Instead of an <<a class="reference internal" href="#initialisationelement"><em>initialisation</em></a>> element, it has an <tt class="docutils literal"><span class="pre"><evaluation></span></tt> element that serves the same purpose. The <tt class="docutils literal"><span class="pre"><evaluation></span></tt> element contains a <tt class="docutils literal"><span class="pre"><dependencies></span></tt> element (see <tt class="docutils literal"><span class="pre">above<Dependencies></span></tt>), and a ‘CDATA’ block containing the code that defines it.</p>
<p>As it is not being stored, a <tt class="docutils literal"><span class="pre"><computed_vector></span></tt> does not have or require an <tt class="docutils literal"><span class="pre">initial_basis</span></tt> attribute, as it will be transformed into an appropriate basis for the element that references it. The basis for its evaluation will be determined entirely by the <tt class="docutils literal"><span class="pre">basis</span></tt> attribute of the <tt class="docutils literal"><span class="pre"><dependencies></span></tt> element.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(-1, 1)"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="c"><!-- A one-dimensional vector with dimension 'x' --></span>
<span class="nt"><vector</span> <span class="na">name=</span><span class="s">"wavefunction"</span> <span class="na">type=</span><span class="s">"complex"</span><span class="nt">></span>
<span class="nt"><components></span> phi <span class="nt"></components></span>
<span class="nt"><initialisation></span>
<span class="cp"><![CDATA[</span>
<span class="c1">// 'cis(x)' is cos(x) + i * sin(x)</span>
<span class="n">phi</span> <span class="o">=</span> <span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">0.5</span> <span class="o">*</span> <span class="n">x</span> <span class="o">*</span> <span class="n">x</span><span class="p">)</span> <span class="o">*</span> <span class="n">cis</span><span class="p">(</span><span class="mi">40</span> <span class="o">*</span> <span class="n">x</span><span class="p">);</span>
<span class="cp">]]></span>
<span class="nt"></initialisation></span>
<span class="nt"></vector></span>
<span class="c"><!-- A zero-dimensional real computed vector with components Ncalc --></span>
<span class="nt"><computed_vector</span> <span class="na">name=</span><span class="s">"zero_dim"</span> <span class="na">dimensions=</span><span class="s">""</span> <span class="na">type=</span><span class="s">"real"</span><span class="nt">></span>
<span class="nt"><components></span>
Ncalc
<span class="nt"></components></span>
<span class="nt"><evaluation></span>
<span class="nt"><dependencies></span>wavefunction<span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="c1">// Implicitly integrating over the dimension 'x'</span>
<span class="n">Ncalc</span> <span class="o">=</span> <span class="nf">mod2</span><span class="p">(</span><span class="n">phi</span><span class="p">);</span>
<span class="cp">]]></span>
<span class="nt"></evaluation></span>
<span class="nt"></computed_vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="noise-vector-element">
<span id="noisevectorelement"></span><span id="index-58"></span><h2>Noise Vector Element<a class="headerlink" href="#noise-vector-element" title="Permalink to this headline">¶</a></h2>
<p>Noise vectors are used like computed vectors, but when they are evaluated they generate arrays of random numbers of various kinds. They do not depend on other vectors, and are not initialised by code. They are defined by a <tt class="docutils literal"><span class="pre"><noise_vector></span></tt> element, which has a <tt class="docutils literal"><span class="pre">name</span></tt> attribute, and optional <tt class="docutils literal"><span class="pre">dimensions</span></tt>, <tt class="docutils literal"><span class="pre">initial_basis</span></tt> and <tt class="docutils literal"><span class="pre">type</span></tt> attributes, which work identically as for normal vectors.</p>
<p>The choice of pseudo-random number generator (RNG) can be specified with the <tt class="docutils literal"><span class="pre">method</span></tt> attribute, which has options “posix” (the default), “mkl”, “solirte” and “dsfmt”. It is only possible to use any particular method if that library is available. Although “posix” is the default, it is also the slowest, and produces the lowest quality random numbers (although this is typically not a problem). “mkl” refers to the Intel Math Kernel Library, and is only available if installed. “solirte” and “dsfmt” are fast, hardware-accelerated random number sources that should work on most systems. “mkl”, “solirte” and “dsfmt” have comparable performance.</p>
<p>The random number generators can be provided with a seed using the <tt class="docutils literal"><span class="pre">seed</span></tt> attribute, which should typically consist of a list of three integers. All RNGs require positive integers as seeds. It is possible to use the <a class="reference internal" href="#validation"><em><validation kind=”run-time”/></em></a> feature to use passed variables as seeds. It is advantageous to use fixed seeds rather than timer-based seeds, as the <a class="reference internal" href="#errorcheck"><em><error_check></em></a> element can test for strong convergence if the same seeds are used for both integrations. If the <tt class="docutils literal"><span class="pre">seed</span></tt> attribute is not specified, then seeds will be generated at the time the simulation is run. Different executions of the same simulation will therefore give different results. However, results can be reproduced by examining the <tt class="docutils literal"><span class="pre">.xsil</span></tt> file produced by the simulation which contains the generated seeds. If these seeds are used for the <tt class="docutils literal"><span class="pre">seed</span></tt> attribute, the same results can be reproduced. Unless you need to reproduce particular results, it is unnecessary to specify the <tt class="docutils literal"><span class="pre">seed</span></tt> attribute.</p>
<p>The different types of noise vectors are defined by a mandatory <tt class="docutils literal"><span class="pre">kind</span></tt> attribute, which must take the value of ‘gauss’, ‘gaussian’, ‘wiener’, ‘poissonian’,’jump’ or ‘uniform’.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><geometry></span>
<span class="nt"><propagation_dimension></span> t <span class="nt"></propagation_dimension></span>
<span class="nt"><transverse_dimensions></span>
<span class="nt"><dimension</span> <span class="na">name=</span><span class="s">"x"</span> <span class="na">lattice=</span><span class="s">"128"</span> <span class="na">domain=</span><span class="s">"(-1, 1)"</span> <span class="nt">/></span>
<span class="nt"></transverse_dimensions></span>
<span class="nt"></geometry></span>
<span class="c"><!--</span>
<span class="c"> A one-dimensional complex wiener noise vector.</span>
<span class="c"> This noise is appropriate for using in the complex</span>
<span class="c"> random-walk equation of motion:</span>
<span class="c"> dz_dt = eta;</span>
<span class="c"> --></span>
<span class="nt"><noise_vector</span> <span class="na">name=</span><span class="s">"noise"</span> <span class="na">kind=</span><span class="s">"wiener"</span><span class="nt">></span>
<span class="nt"><components></span>
eta
<span class="nt"></components></span>
<span class="nt"></vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
<div class="section" id="uniform-noise">
<span id="uniformnoise"></span><span id="index-59"></span><h3>Uniform noise<a class="headerlink" href="#uniform-noise" title="Permalink to this headline">¶</a></h3>
<p>Uniform noises defined over any transverse dimensions are simply uniformly distributed random numbers between zero and one. This noise is an example of a “static” noise, i.e. one suitable for initial conditions of a field. If it were included in the equations of motion for a field, then the effect of the noise would depend on the lattice spacing of the propagation dimension. XMDS therefore does not allow this noise type to be used in integration elements.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><noise_vector</span> <span class="na">name=</span><span class="s">"drivingNoise"</span> <span class="na">dimensions=</span><span class="s">"x"</span> <span class="na">kind=</span><span class="s">"uniform"</span> <span class="na">type=</span><span class="s">"complex"</span> <span class="na">method=</span><span class="s">"dsfmt"</span> <span class="na">seed=</span><span class="s">"314 159 276"</span><span class="nt">></span>
<span class="nt"><components></span>Eta<span class="nt"></components></span>
<span class="nt"></noise_vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="gaussian-noise">
<span id="gaussiannoise"></span><span id="index-60"></span><h3>Gaussian noise<a class="headerlink" href="#gaussian-noise" title="Permalink to this headline">¶</a></h3>
<p>Noise generated with the “gaussian” method is gaussian distributed with zero mean. For a real-valued noise vector, the variance at each point is the inverse of the volume element of the transverse dimensions in the vector. This volume element for a single transverse dimension is that used to perform integrals over that dimension. For example, it would include a factor of <span class="math">\(r^2\)</span> for a dimension “r” defined with a <tt class="docutils literal"><span class="pre">spherical-bessel</span></tt> transform. It can be non-uniform for dimensions based on non-Fourier transforms, and will include the product of the <tt class="docutils literal"><span class="pre">volume_prefactor</span></tt> attribute as specified in the <a class="reference internal" href="#geometryelement"><em>Geometry</em></a> element. The volume element for an integer-type dimension is unity (i.e. where the integral is just an unweighted sum). The volume element for a <tt class="docutils literal"><span class="pre">noise_vector</span></tt> with multiple dimensions is simply the product of the volume elements of the individual dimensions.</p>
<p>This lattice-dependent variance is typical in most applications of partial differential equations with stochastic initial conditions, as the physical quantity is the variance of the field over some finite volume, which does not change if the variance at each lattice site varies as described above.</p>
<p>For complex-valued noise vector, the real and imaginary parts of the noise are independent, and each have half the variance of a real-valued noise. This means that the modulus squared of a complex-valued noise vector has the same variance as a real-valued noise vector at each point.</p>
<p>Gaussian noise vectors are an example of a “static” noise, i.e. one suitable for initial conditions of a field. If they were included in the equations of motion for a field, then the effect of the noise would depend on the lattice spacing of the propagation dimension. XMDS therefore does not allow this noise type to be used in integration elements.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><noise_vector</span> <span class="na">name=</span><span class="s">"initialNoise"</span> <span class="na">dimensions=</span><span class="s">"x"</span> <span class="na">kind=</span><span class="s">"gauss"</span> <span class="na">type=</span><span class="s">"real"</span> <span class="na">method=</span><span class="s">"posix"</span> <span class="na">seed=</span><span class="s">"314 159 276"</span><span class="nt">></span>
<span class="nt"><components></span>fuzz<span class="nt"></components></span>
<span class="nt"></noise_vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="wiener-noise">
<span id="wienernoise"></span><span id="index-61"></span><h3>Wiener noise<a class="headerlink" href="#wiener-noise" title="Permalink to this headline">¶</a></h3>
<p>Noise generated with the “wiener” method is gaussian distributed with zero mean and the same variance as the static “gaussian” noise defined above, multiplied by a factor of the lattice step in the propagation dimension. This means that these noise vectors can be used to define Wiener noises for standard stochastic ordinary or partial differential equations. Most integrators in XMDS effectively interpret these noises as Stratonovich increments.</p>
<p>As a dynamic noise, a Wiener process is not well-defined except in an <tt class="docutils literal"><span class="pre">integrate</span></tt> element.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><noise_vector</span> <span class="na">name=</span><span class="s">"diffusion"</span> <span class="na">dimensions=</span><span class="s">"x"</span> <span class="na">kind=</span><span class="s">"wiener"</span> <span class="na">type=</span><span class="s">"real"</span> <span class="na">method=</span><span class="s">"solirte"</span> <span class="na">seed=</span><span class="s">"314 159 276"</span><span class="nt">></span>
<span class="nt"><components></span>dW<span class="nt"></components></span>
<span class="nt"></noise_vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="poissonian-noise">
<span id="poissioniannoise"></span><span id="index-62"></span><h3>Poissonian noise<a class="headerlink" href="#poissonian-noise" title="Permalink to this headline">¶</a></h3>
<p>A noise vector using the “poissonian” method generates a random variable from a Poissonian distribution. While the the Poisson distribution is integer-valued, the variable will be cast as a real number. The rate of the Poissonian distribution is defined by the <tt class="docutils literal"><span class="pre">mean</span></tt> or <tt class="docutils literal"><span class="pre">mean-density</span></tt> attributes. These are are synonyms, and must be defined as positive real numbers. For Poissonian noises defined over real-valued transverse dimensions, the rate is given by the product of this <tt class="docutils literal"><span class="pre">mean-density</span></tt> attribute and the volume element at that point, taking into account all transverse dimensions, including their <tt class="docutils literal"><span class="pre">volume_prefactor</span></tt> attributes. The result is that the integral over each volume in space is a sample from a Poissonian distribution of that rate.</p>
<p>Poissonian noise vectors are an example of a “static” noise, i.e. one suitable for initial conditions of a field. If they were included in the equations of motion for a field, then the effect of the noise would depend on the lattice spacing of the propagation dimension. XMDS therefore does not allow this noise type to be used in integration elements.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><noise_vector</span> <span class="na">name=</span><span class="s">"initialDistribution"</span> <span class="na">dimensions=</span><span class="s">"x"</span> <span class="na">kind=</span><span class="s">"poissonian"</span> <span class="na">type=</span><span class="s">"real"</span> <span class="na">mean-density=</span><span class="s">"2.7"</span> <span class="na">method=</span><span class="s">"solirte"</span> <span class="na">seed=</span><span class="s">"314 159 276"</span><span class="nt">></span>
<span class="nt"><components></span>Pdist<span class="nt"></components></span>
<span class="nt"></noise_vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="jump-noise">
<span id="jumpnoise"></span><span id="index-63"></span><h3>Jump noise<a class="headerlink" href="#jump-noise" title="Permalink to this headline">¶</a></h3>
<p>A noise vector using the “jump” method is the dynamic version of the poissonian noise method, and must have the <tt class="docutils literal"><span class="pre">mean-rate</span></tt> attribute specified as a positive real number. The variable at each point is chosen from a Poissonian distribution with a mean equal to the product of three variables: the <tt class="docutils literal"><span class="pre">mean-rate</span></tt> attribute; the volume of the element as defined by its transverse dimensions (including their <tt class="docutils literal"><span class="pre">volume_prefactor</span></tt> attributes); and the step size in the propagation dimension. Normally defined in the limit where the noise value is zero almost always, with a few occurrences where it is unity, and none of any higher value, this type of noise is commonly used in differential equations with a Poissonian jump process.</p>
<p>It is common to wish to vary the mean rate of a jump process, which means that the <tt class="docutils literal"><span class="pre">mean-rate</span></tt> attribute must be a variable or a piece of code. These cannot be verified to be a positive real number at compile time, so they must be used with the <a class="reference internal" href="#validation"><em><validation></em></a> feature with either the <tt class="docutils literal"><span class="pre">kind="none"</span></tt> or <tt class="docutils literal"><span class="pre">kind="run-time"</span></tt> attributes.</p>
<p>As a dynamic noise, a jump process is not well-defined except in an <tt class="docutils literal"><span class="pre">integrate</span></tt> element. The only algorithm that currently integrates jump noises correctly is the Euler algorithm. This can be implemented by the “SI” method with the option <tt class="docutils literal"><span class="pre">iterations="1"</span></tt>.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><noise_vector</span> <span class="na">name=</span><span class="s">"initialDistribution"</span> <span class="na">dimensions=</span><span class="s">""</span> <span class="na">kind=</span><span class="s">"jump"</span> <span class="na">type=</span><span class="s">"real"</span> <span class="na">mean-rate=</span><span class="s">"2.7"</span> <span class="na">method=</span><span class="s">"solirte"</span> <span class="na">seed=</span><span class="s">"314 159 276"</span><span class="nt">></span>
<span class="nt"><components></span>dN<span class="nt"></components></span>
<span class="nt"></noise_vector></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="sequence-element">
<span id="sequenceelement"></span><span id="index-64"></span><h2>Sequence Element<a class="headerlink" href="#sequence-element" title="Permalink to this headline">¶</a></h2>
<p>All processing of vectors happens in sequence elements. Each simulation must have exactly one main sequence element, but it can then contain any number of nested sequence elements. A sequence element can contain any number of <tt class="docutils literal"><span class="pre"><sequence></span></tt>, <a class="reference internal" href="#filterelement"><em><filter></em></a>, <a class="reference internal" href="#integrateelement"><em><integrate></em></a> and/or <a class="reference internal" href="#breakpointelement"><em><breakpoint></em></a> elements, which are executed in the order they are written. A sequence can be repeated a number of times by using the <tt class="docutils literal"><span class="pre">cycles</span></tt> attribute. For example, <tt class="docutils literal"><span class="pre"><sequence</span> <span class="pre">cycles="10"></span></tt> will execute the elements in that sequence 10 times.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><simulation</span> <span class="na">xmds-version=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><sequence</span> <span class="na">cycles=</span><span class="s">"2"</span><span class="nt">></span>
<span class="nt"><sequence></span> ... <span class="nt"></sequence></span>
<span class="nt"><filter></span> ... <span class="nt"></filter></span>
<span class="nt"><integrate></span> ...<span class="nt"></integrate></span>
<span class="nt"></sequence></span>
<span class="nt"></simulation></span>
</pre></div>
</div>
</div>
<div class="section" id="filter-element">
<span id="filterelement"></span><span id="index-65"></span><h2>Filter element<a class="headerlink" href="#filter-element" title="Permalink to this headline">¶</a></h2>
<p>A <tt class="docutils literal"><span class="pre"><filter></span></tt> element can be placed inside a <tt class="docutils literal"><span class="pre"><sequence></span></tt> element or an <a class="reference internal" href="#integrateelement"><em><integrate></em></a> element. It contains a ‘CDATA’ block and an optional <a class="reference internal" href="#dependencies"><em><dependencies></em></a> element, which may give access to variables in other <tt class="docutils literal"><span class="pre"><vector></span></tt>, <tt class="docutils literal"><span class="pre"><computed_vector></span></tt> or <tt class="docutils literal"><span class="pre"><noise_vector></span></tt> elements. The code inside the ‘CDATA’ block is executed over the combined tensor product space of the dependencies, or simply once if there is no dependencies element. This element therefore allows arbitrary execution of C-code.</p>
<p id="index-66">Sometimes it is desirable to apply a filter conditionally. The most efficient way of doing this is to call the function from the piece of code that contains the conditional statement (likely another <tt class="docutils literal"><span class="pre"><filter></span></tt> element) rather than embed the conditional function in the filter itself, as the latter method can involve the conditional statement being evaluated multiple times over the transverse dimensions. For this reason, it is possible to give a filter a <tt class="docutils literal"><span class="pre">name</span></tt> attribute, and the filter can thenceforth be called in CDATA blocks by that name. For example: <tt class="docutils literal"><span class="pre"><filter</span> <span class="pre">name="filterName"></span></tt> allows the function to be called using the C-function <tt class="docutils literal"><span class="pre">filterName()</span></tt>.</p>
<p>One of the common uses of a filter element is to apply discontinuous changes to the vectors and variables of the simulation.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><sequence></span>
<span class="nt"><filter></span>
<span class="cp"><![CDATA[</span>
<span class="n">printf</span><span class="p">(</span><span class="s">"Hello world from the first filter segment! This filter rather wastefully calls the second one.</span><span class="se">\n</span><span class="s">"</span><span class="p">);</span>
<span class="n">fname</span><span class="p">();</span>
<span class="cp">]]></span>
<span class="nt"></filter></span>
<span class="nt"><filter</span> <span class="na">name=</span><span class="s">"fname"</span><span class="nt">></span>
<span class="nt"><dependencies></span>normalisation wavefunction<span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="n">phi</span> <span class="o">*=</span> <span class="n">sqrt</span><span class="p">(</span><span class="n">Nparticles</span><span class="o">/</span><span class="n">Ncalc</span><span class="p">);</span>
<span class="cp">]]></span>
<span class="nt"></filter></span>
<span class="nt"></sequence></span>
</pre></div>
</div>
</div>
<div class="section" id="integrate-element">
<span id="integrateelement"></span><span id="index-67"></span><h2>Integrate element<a class="headerlink" href="#integrate-element" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre"><integrate></span></tt> element is at the heart of most XMDS simulations. It is used to integrate a set of (potentially stochastic) first-order differential equations for one or more of the vectors defined using the <tt class="docutils literal"><span class="pre"><vector></span></tt> element along the propagation dimension. At the beginning of the simulation, the value of the propagation dimension is set to zero, and the vectors are initialised as defined in the <a class="reference internal" href="#vectorelement"><em><vector></em></a> element. As successive sequence elements change these variables, each integrate element simply integrates onward from the current values.</p>
<p id="index-68">The length of the integration is defined by the <tt class="docutils literal"><span class="pre">interval</span></tt> attribute, which must be a positive real number. An <tt class="docutils literal"><span class="pre"><integrate></span></tt> element must have an <tt class="docutils literal"><span class="pre">algorithm</span></tt> attribute defined, which defines the integration method. Current methods include <a class="reference internal" href="#si"><em>SI</em></a>, <a class="reference internal" href="#si"><em>SIC</em></a>, <a class="reference internal" href="#rk4"><em>RK4</em></a>, <a class="reference internal" href="#rk4"><em>RK9</em></a>, <a class="reference internal" href="#ark45"><em>ARK45</em></a>, and <a class="reference internal" href="#ark45"><em>ARK89</em></a>. Fixed step algorithms require a <tt class="docutils literal"><span class="pre">steps</span></tt> attribute, which must be a positive integer that defines the number of (evenly spaced) integration steps. Adaptive stepsize algorithms require a <tt class="docutils literal"><span class="pre">tolerance</span></tt> attribute that must be a positive real number much smaller than one, which defines the allowable relative error per integration step. If the <tt class="docutils literal"><span class="pre">steps</span></tt> attribute is specified for an adaptive stepsize algorithm, then it is used to generate the initial stepsize estimate.</p>
<p id="sampleselement"><span id="index-69"></span>The optional <tt class="docutils literal"><span class="pre"><samples></span></tt> element is used to track the evolution of one or more vectors or variables during an integration. This element must contain a non-negative integer for each <a class="reference internal" href="#samplinggroupelement"><em><sampling_group></em></a> element defined in the simulation’s <a class="reference internal" href="#outputelement"><em><output></em></a> element. The list of integers then defines the number of times that the moments defined in those groups will be sampled. For a fixed step algorithm, each non-zero number of samples must be a factor of the total number of steps.</p>
<p>The vectors to be integrated and the form of the differential equations are defined in the <a class="reference internal" href="#operatorselement"><em><operators></em></a> element (or elements). Filters to be applied each step can be defined with optional <a class="reference internal" href="#filterselement"><em><filters></em></a> elements.</p>
<p>Computed vectors can be defined with the <tt class="docutils literal"><span class="pre"><computed_vector></span></tt> element. These act exactly like a globally defined <a class="reference internal" href="#computedvectorelement"><em>Computed Vector Element</em></a>, but are only available within the single <tt class="docutils literal"><span class="pre"><integrate></span></tt> element.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><integrate</span> <span class="na">algorithm=</span><span class="s">"ARK89"</span> <span class="na">interval=</span><span class="s">"1e-4"</span> <span class="na">steps=</span><span class="s">"10000"</span> <span class="na">tolerance=</span><span class="s">"1e-8"</span><span class="nt">></span>
<span class="nt"><samples></span>20<span class="nt"></samples></span>
<span class="nt"><filters></span>
<span class="nt"><filter></span>
<span class="nt"><dependencies></span>wavefunction normalisation<span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="n">phi</span> <span class="o">*=</span> <span class="n">sqrt</span><span class="p">(</span><span class="n">Nparticles</span><span class="o">/</span><span class="n">Ncalc</span><span class="p">);</span> <span class="c1">// Correct normalisation of the wavefunction</span>
<span class="cp">]]></span>
<span class="nt"></filter></span>
<span class="nt"></filters></span>
<span class="nt"><operators></span>
<span class="nt"><operator</span> <span class="na">kind=</span><span class="s">"ip"</span><span class="nt">></span>
<span class="nt"><operator_names></span>T<span class="nt"></operator_names></span>
<span class="cp"><![CDATA[</span>
<span class="n">T</span> <span class="o">=</span> <span class="o">-</span><span class="mf">0.5</span><span class="o">*</span><span class="n">hbar</span><span class="o">/</span><span class="n">M</span><span class="o">*</span><span class="n">ky</span><span class="o">*</span><span class="n">ky</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></operator></span>
<span class="nt"><dependencies></span>potential<span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="n">dphi_dt</span> <span class="o">=</span> <span class="n">T</span><span class="p">[</span><span class="n">phi</span><span class="p">]</span> <span class="o">-</span> <span class="p">(</span><span class="n">V1</span> <span class="o">+</span> <span class="n">Uint</span><span class="o">/</span><span class="n">hbar</span><span class="o">*</span><span class="nf">mod2</span><span class="p">(</span><span class="n">phi</span><span class="p">))</span><span class="o">*</span><span class="n">phi</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"><integration_vectors></span>wavefunction<span class="nt"></integration_vectors></span>
<span class="nt"></operators></span>
<span class="nt"></integrate></span>
</pre></div>
</div>
<div class="section" id="operators-and-operator-elements">
<span id="operatorselement"></span><span id="index-70"></span><h3>Operators and operator elements<a class="headerlink" href="#operators-and-operator-elements" title="Permalink to this headline">¶</a></h3>
<p>An <a class="reference internal" href="#integrateelement"><em><integrate></em></a> element must contain one or more <tt class="docutils literal"><span class="pre"><operators></span></tt> elements, which define both which vectors are to be integrated, and their derivative in the propagation dimension. When all vectors to be integrated have the same dimensionality, they can all be defined within a single <tt class="docutils literal"><span class="pre"><operators></span></tt> element, and when vectors with different dimension are to be integrated, each set of vectors with the same dimensionality should be placed in separate <tt class="docutils literal"><span class="pre"><operators></span></tt> elements.</p>
<p id="integrationvectorselement"><span id="index-71"></span>Within each <tt class="docutils literal"><span class="pre"><operators></span></tt> element, the vectors that are to be integrated are listed by name in the <tt class="docutils literal"><span class="pre"><integration_vectors></span></tt> element, and the differential equations are written in a ‘CDATA’ block. The derivative of each component of the integration vectors must be defined along the propagation dimension. For example, if the integration vectors have components ‘phi’ and ‘beta’, and the propagation dimension is labelled ‘tau’, then the ‘CDATA’ block must define the variables ‘dphi_dtau’ and ‘dbeta_dtau’. These derivatives can be any function of the available variables, including any components from other vectors, computed vectors or noise vectors that are listed in the optional <a class="reference internal" href="#dependencies"><em><dependencies></em></a> element. These dependent vectors must be defined on a subset of the dimensions of the integration vectors.</p>
<p>When noise vectors are referenced, equations with Wiener noises should be written as though the equations are in differential form, as described in the worked examples <a class="reference internal" href="worked_examples.html#kubo"><em>Kubo Oscillator</em></a> and <a class="reference internal" href="worked_examples.html#fibre"><em>Fibre Noise</em></a>. Jump-based Poisson noises will also be written in an equivalent form, as modelled by the example <tt class="docutils literal"><span class="pre">photodetector.xmds</span></tt>.</p>
<p id="index-72">By default, the name of each component references the local value of the vector, but <a class="reference internal" href="#referencingnonlocal"><em>nonlocal variables</em></a> can be accessed using the standard syntax. However, typically the most common (and most efficient) method of referencing nonlocal variables is to reference variables that are local in the <a class="reference internal" href="#transforms"><em>transformed space</em></a> for a given transverse dimension. This is done using <tt class="docutils literal"><span class="pre"><operator></span></tt> elements.</p>
<span class="target" id="operatorelement"><span id="index-73"></span></span><p id="index-74">There are three kinds of <tt class="docutils literal"><span class="pre"><operator></span></tt> elements. The first is denoted with a <tt class="docutils literal"><span class="pre">kind="functions"</span></tt> attribute, and contains a ‘CDATA’ block that will be executed in the order that it is defined. This is useful when you wish to calculate functions that do not depend on the transverse dimensions. Defining these along with the main equations of motion causes them to be recalculated separately for each point. The second kind of <tt class="docutils literal"><span class="pre"><operator></span></tt> element is used to define an operation in a transformed space. This is often an efficient method of calculating common nonlocal terms such as derivatives. The third kind is used to define integration of one or more vectors along a transverse dimension.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><operator</span> <span class="na">kind=</span><span class="s">"functions"</span><span class="nt">></span>
<span class="cp"><![CDATA[</span>
<span class="n">f</span> <span class="o">=</span> <span class="n">cos</span><span class="p">(</span><span class="n">t</span><span class="p">);</span>
<span class="cp">]]></span>
<span class="nt"></operator></span>
</pre></div>
</div>
<p id="operatornameselement">The second kind of operator element defines a list of operators in an <tt class="docutils literal"><span class="pre"><operator_names></span></tt> element. The basis of these operators defaults to the transform space unless a different basis is specified using the <tt class="docutils literal"><span class="pre">basis</span></tt> attribute. These operators must then be defined in a ‘CDATA’ block, using any <a class="reference internal" href="#dependencies"><em>dependencies</em></a> as normal. The operators defined in these elements can then be used in the ‘CDATA’ block that defines the equations of motion. The application of operator ‘L’ to vector ‘psi’ is denoted <tt class="docutils literal"><span class="pre">L[psi]</span></tt>. Operators can be applied to functions of vectors using the same notation, such as <tt class="docutils literal"><span class="pre">L[psi*psi]</span></tt>. Aside from the example above, many examples can be found in the examples folder, and the <a class="reference internal" href="worked_examples.html#workedexamples"><em>Worked Examples</em></a> section of the documentation.</p>
<span class="target" id="index-75"></span><p id="index-76">Operators of this second kind have the <tt class="docutils literal"><span class="pre">kind="IP"</span></tt> or <tt class="docutils literal"><span class="pre">kind="EX"</span></tt> attribute, standing for ‘interaction picture’ and ‘explicit’ operators respectively. Explicit operators can be used in all situations, and simply construct and calculate a new vector of the form in the square brackets. IP operators use less memory and can improve speed by allowing larger timesteps, but have two important restrictions. <strong>Use of IP operators without understanding these restrictions can lead to incorrect code</strong>. The first restriction is that IP operators can only be applied to named components of one of the integration vectors, and not functions of those components. The second restriction is that the equations of motion must be written such that the term with the operator is not multiplied by any quantity or used inside a function. (For those interested, the reason for this is that the IP algorithm applies the operator separately to the rest of the evolution, and therefore the actual text of the <tt class="docutils literal"><span class="pre">L[psi]</span></tt> term is replaced by the numeral zero.) If you must break either of those rules, then you need to use the EX algorithm.</p>
<p id="index-77">If the IP or EX operator is constant across the integration, then the attribute <tt class="docutils literal"><span class="pre">constant="yes"</span></tt> may be set to ensure that it is precalculated at the start of integration, otherwise the <tt class="docutils literal"><span class="pre">constant="no"</span></tt> attribute ensures that the operator is recalculated at each step. The <tt class="docutils literal"><span class="pre">constant</span></tt> attribute is optional and a sensible default is chosen if the attribute is omitted. Note that for EX operators the default is <tt class="docutils literal"><span class="pre">constant="no"</span></tt> because the EX operator is typically cheap to calculate and not precomputing it reduces memory bandwidth requirements, usually leading to faster simulations. If your simulation has a computationally expensive EX operator, it may benefit from adding the <tt class="docutils literal"><span class="pre">constant="yes"</span></tt> attribute.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><operator</span> <span class="na">kind=</span><span class="s">"ex"</span> <span class="na">constant=</span><span class="s">"yes"</span><span class="nt">></span>
<span class="nt"><operator_names></span>T<span class="nt"></operator_names></span>
<span class="cp"><![CDATA[</span>
<span class="n">T</span> <span class="o">=</span> <span class="o">-</span><span class="mf">0.5</span><span class="o">*</span><span class="n">hbar</span><span class="o">/</span><span class="n">M</span><span class="o">*</span><span class="n">ky</span><span class="o">*</span><span class="n">ky</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></operator></span>
</pre></div>
</div>
<p id="index-78">The third kind of operator element is used to define an integration along a transverse dimension. This kind of evolution is called “cross-propagation”, and is described briefly in the examples ‘tla.xmds’, ‘tla_sic.xmds’ and ‘sine_cross.xmds’. This class of equations have a subset of vectors that have an initial condition on one side of a transverse dimension, and a differential equation defined in that dimension, and as such, this kind of operator element has much of the structure of an entire <a class="reference internal" href="#integrateelement"><em><integrate></em></a> element.</p>
<p id="index-79">An operator element with the <tt class="docutils literal"><span class="pre">kind="cross_propagation"</span></tt> attribute must specify the transverse dimension along which the integration would proceed with the <tt class="docutils literal"><span class="pre">propagation_dimension</span></tt> attribute. It must also specify its own <a class="reference internal" href="#integrationvectorselement"><em><integration_vectors></em></a> element, its own <tt class="docutils literal"><span class="pre"><operators></span></tt> elements (of the second kind), and may define an optional <a class="reference internal" href="#dependencies"><em><dependencies></em></a> element. The algorithm to be used for the transverse integration is specified by the <tt class="docutils literal"><span class="pre">algorithm</span></tt> attribute, with options being <tt class="docutils literal"><span class="pre">algorithm="SI"</span></tt> and <tt class="docutils literal"><span class="pre">algorithm="RK4"</span></tt>. The derivatives in the cross propagation direction are defined in a ‘CDATA’ block, just as for a normal <tt class="docutils literal"><span class="pre"><integrate></span></tt> element.</p>
<span class="target" id="index-80"></span><p id="boundaryconditionelement"><span id="index-81"></span>The boundary conditions are specified by a <tt class="docutils literal"><span class="pre"><boundary_conditions></span></tt> element, which requires the <tt class="docutils literal"><span class="pre">kind="left"</span></tt> or <tt class="docutils literal"><span class="pre">kind="right"</span></tt> attribute to specify on which side of the grid that the boundary conditions are specified. The boundary conditions for the <tt class="docutils literal"><span class="pre"><integration_vectors></span></tt> are then specified in a ‘CDATA’ block, which may refer to vectors in an optional <a class="reference internal" href="#dependencies"><em><dependencies></em></a> element that can be contained in the <tt class="docutils literal"><span class="pre"><boundary_conditions></span></tt> element.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><operator</span> <span class="na">kind=</span><span class="s">"cross_propagation"</span> <span class="na">algorithm=</span><span class="s">"RK4"</span> <span class="na">propagation_dimension=</span><span class="s">"t"</span><span class="nt">></span>
<span class="nt"><integration_vectors></span>cross<span class="nt"></integration_vectors></span>
<span class="nt"><dependencies></span>constants<span class="nt"></dependencies></span>
<span class="nt"><boundary_condition</span> <span class="na">kind=</span><span class="s">"left"</span><span class="nt">></span>
<span class="cp"><![CDATA[</span>
<span class="n">v</span> <span class="o">=</span> <span class="mf">1.0</span><span class="p">;</span>
<span class="n">w</span> <span class="o">=</span> <span class="mf">1.0</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></boundary_condition></span>
<span class="nt"><operator</span> <span class="na">kind=</span><span class="s">"ip"</span> <span class="na">constant=</span><span class="s">"yes"</span><span class="nt">></span>
<span class="nt"><operator_names></span>L<span class="nt"></operator_names></span>
<span class="cp"><![CDATA[</span>
<span class="n">L</span> <span class="o">=</span> <span class="kc">i</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></operator></span>
<span class="cp"><![CDATA[</span>
<span class="n">dv_dt</span> <span class="o">=</span> <span class="kc">i</span><span class="o">*</span><span class="n">v</span><span class="p">;</span>
<span class="n">dw_dt</span> <span class="o">=</span> <span class="n">L</span><span class="p">[</span><span class="n">w</span><span class="p">];</span>
<span class="cp">]]></span>
<span class="nt"></operator></span>
</pre></div>
</div>
</div>
<div class="section" id="algorithms">
<span id="id8"></span><h3>Algorithms<a class="headerlink" href="#algorithms" title="Permalink to this headline">¶</a></h3>
<p>The stability, efficiency and even convergence of a numerical integration can depend on the method. Due to the varying properties of different sets of equations, it is impossible to define the best method for all equations, so XMDS provides an option to use different algorithms. These include fixed step algorithms, which divide the integration region into equal steps, and adaptive stepsize algorithms, which attempt to estimate the error in the simulation in order to choose an appropriate size for the next step. As a first guess, a good method for a deterministic integration would be <a class="reference internal" href="#ark45"><em>ARK89</em></a>, and a good guess for a stochastic method would be the <a class="reference internal" href="#si"><em>SI and SIC algorithms</em></a>.</p>
<p>For the purposes of the descriptions below, we will assume that we are considering the following set of coupled differential equations for the vector of variables <span class="math">\(\mathbf{x}(t)\)</span>:</p>
<div class="math">
\[\frac{d x_j}{dt} = f_j(\mathbf{x}(t),t)\]</div>
<div class="section" id="si-and-sic-algorithms">
<span id="si"></span><span id="index-82"></span><h4>SI and SIC algorithms<a class="headerlink" href="#si-and-sic-algorithms" title="Permalink to this headline">¶</a></h4>
<p>The SI algorithm is a semi-implicit fixed-step algorithm that finds the increment of the vector by solving</p>
<div class="math">
\[x_j(t+\Delta t) = x_j(t) + f_j\left(\mathbf{x}(t+\frac{\Delta t}{2}),t+\frac{\Delta t}{2}\right) \;\Delta t\]</div>
<p>using a simple iteration to find the values of the vector at the midpoint of the step self-consistently. The number of iterations can be set using the <tt class="docutils literal"><span class="pre">iterations</span></tt> attribute, and it defaults to <tt class="docutils literal"><span class="pre">iterations="3"</span></tt>. The choice of <tt class="docutils literal"><span class="pre">iterations="1"</span></tt> is therefore fully equivalent to the Euler algorithm, where</p>
<div class="math">
\[x_j(t+\Delta t) = x_j(t) + f_j\left(\mathbf{x}(t),t\right) \;\Delta t.\]</div>
<p>The Euler algorithm is the only safe algorithm for direct integration of <a class="reference internal" href="#jumpnoise"><em>jump-based Poisson processes</em></a>. Efficient numerical solution of those types of equations is best done via a process of triggered filters, which will be described in the <a class="reference internal" href="advanced_topics.html#advancedtopics"><em>Advanced Topics</em></a> section. Integrating using the Euler algorithm computes the Ito integral, as opposed to the Stratonovich integral, which all the other algorithms compute.</p>
<p>When SI integration is used in conjunction with SI cross-propagation, a slight variant of the SI algorithm can be employed where the integration in both directions is contained within the iteration process. This is activated by using <tt class="docutils literal"><span class="pre">algorithm="SIC"</span></tt> rather than <tt class="docutils literal"><span class="pre">algorithm="SI"</span></tt>.</p>
<p>The SI algorithm is correct to second order in the step-size for deterministic equations, and first order in the step-size for Stratonovich stochastic equations with Wiener noises. This makes it the highest order stochastic algorithm in XMDS, although there are many sets of equations that integrate more efficiently with lower order algorithms. When called with the <tt class="docutils literal"><span class="pre">iterations="1"</span></tt> option (the Euler algorithm), it is correct to first order in the step-size for deterministic equations, and one-half order in the step-size for Ito stochastic equations with Wiener noises.</p>
</div>
<div class="section" id="runge-kutta-algorithms">
<span id="rk4"></span><span id="index-83"></span><h4>Runge-Kutta algorithms<a class="headerlink" href="#runge-kutta-algorithms" title="Permalink to this headline">¶</a></h4>
<p>Runge-Kutta algorithms are the workhorse of numerical integration, and XMDS employs two fixed step versions: <tt class="docutils literal"><span class="pre">algorithm="RK4"</span></tt>, which is correct to fourth-order in the step size, and <tt class="docutils literal"><span class="pre">algorithm="RK9"</span></tt>, which is correct to ninth order in the step size. It must be strongly noted that a higher order of convergence does not automatically mean a superior algorithm. RK9 requires several times the memory of the RK4 algorithm, and each step requires significantly more computation.</p>
<p>All Runge-Kutta algorithms are convergent for Stratonovich stochastic equations at the order of the square root of the step-size. This ‘half-order’ convergence may seem very weak, but for some classes of stochastic equation this improves up to one half of the deterministic order of convergence. Also, the convergence of some stochastic equations is limited by the ‘deterministic part’, which can be improved dramatically by using a higher order Runge-Kutta method.</p>
</div>
<div class="section" id="adaptive-runge-kutta-algorithms">
<span id="ark45"></span><span id="index-84"></span><h4>Adaptive Runge-Kutta algorithms<a class="headerlink" href="#adaptive-runge-kutta-algorithms" title="Permalink to this headline">¶</a></h4>
<p>Fixed step integrators can encounter two issues. First, as the equations or parameters of a simulation are changed, the minimum number of steps required to integrate it may change. This means that the convergence must be re-tested multiple times for each set of parameters, as overestimating the number of steps required to perform an integration to a specified error tolerance can be very inefficient. Second, even if the minimum acceptable number of steps required is known for a given simulation, it may be that there are regions of integration that are of wildly varying difficulty. For a fixed step integrator, this means that the step-size must be small enough to handle the most difficult region, and is therefore inefficiently small for the easier regions. Adaptive step-size
algorithms get around this problem by testing the convergence during the integration, and adjusting the step-size until it reaches some target tolerance.</p>
<p>XMDS employs two adaptive step-size algorithms based on ‘embedded Runge-Kutta’ methods. These are Runge-Kutta methods that can output multiple variables that have different convergence. The difference between the higher-order and the lower-order solutions gives an estimate of the error in each step, which can then be used to estimate an appropriate size for the next step. We use <tt class="docutils literal"><span class="pre">algorthim="ARK45"</span></tt>, which contains fourth and fifth order solutions, and <tt class="docutils literal"><span class="pre">algorthim=ARK89</span></tt>, which contains eighth and ninth order solutions. Each algorithm converges with the order of the lowest order solution (fourth and eighth order respectively). The overheads involved in estimating the error and step-size make the adaptive algorithms slower than fixed step integration using the same step-size, but overall there is typically a significant performance gain from being able to avoid doing this optimisation manually.</p>
<p>All adaptive stepsize algorithms require a <tt class="docutils literal"><span class="pre">tolerance</span></tt> attribute, which must be a positive real number that defines the allowable error per step. It is also possible to specify a <tt class="docutils literal"><span class="pre">max_iterations</span></tt> attribute, which is a positive integer that stops the integrator from trying too many times to find an acceptable stepsize. The integrator will abort with an error if the number of attempts for a single step exceeds the maximum specified with this attribute.</p>
<p>As all Runge-Kutta solutions have equal order of convergence for stochastic equations, <em>if the step-size is limited by the stochastic term then the step-size estimation is entirely unreliable</em>. Adaptive Runge-Kutta algorithms are therefore not appropriate for stochastic equations.</p>
</div>
<div class="section" id="richardson-extrapolation-algorithms-and-the-bulirsch-stoer-method">
<span id="realgorithm"></span><span id="index-85"></span><h4>Richardson Extrapolation Algorithms and the Bulirsch-Stoer Method<a class="headerlink" href="#richardson-extrapolation-algorithms-and-the-bulirsch-stoer-method" title="Permalink to this headline">¶</a></h4>
<p>The Richardson Extrapolation technique begins with a large initial interval and uses another stepper algorithm to compute the solution for this interval. It does this by subdividing the interval into increasing subintervals (i.e. with smaller and smaller stepsizes) and uses rational extrapolation to produce a higher order result than would be obtained using the other stepper on its own. The number of extrapolations performed is controllable via the <tt class="docutils literal"><span class="pre">extrapolations</span></tt> attribute which is a positive integer (defaults to 4).</p>
<p>Richardson Extrapolation provides the best trade off between computational effort and accuracy when paired with the Modified Midpoint stepper. This stepper is notable as its error scaling function contains only even powers of two. This means that each extrapolation performed in the Richardson technique gains two orders rather than one order as is expected for most other steppers. This combined with the low computational overhead of the Modified Midpoint makes it a powerful tool. The combination of Richardson Extrapolation and the Modified Midpoint stepper is known as the Bulirsch-Stoer method.</p>
<p>A number of combinations of fixed-step, fixed-order Richardson Extrapolation are available in XMDS2. The most notable is the Bulirsch-Stoer method which can be selected using <tt class="docutils literal"><span class="pre">algorithm="BS"</span></tt> or alternatively <tt class="docutils literal"><span class="pre">algorithm="REMM"</span></tt>. Other combinations include ‘RERK4’, ‘RERK9’ and ‘RESI’ (for stochastic equations). Please note that these additional combinations have not been tested as strictly as the the ‘REMM’ combination and so care should be taken to ensure the results are sane. Additionally the Modified Midpoint stepper is available as a standalone stepper under the mnemonic ‘MM’, although this is probably not useful outside of testing.</p>
<p>Richardson Extrapolation in general uses more memory than other integrators as multiple result vectors must be stored at the same time, which is something users should be aware of if the <tt class="docutils literal"><span class="pre">extrapolations</span></tt> attribute is set too high (generally < 10 should be sufficient).</p>
<p>See the section on the <a class="reference internal" href="bulirschStoer.html#mmdetail"><em>Bulirsch-Stoer Algorithm</em></a> for more details.</p>
</div>
</div>
<div class="section" id="filters-element">
<span id="filterselement"></span><span id="index-86"></span><h3>Filters element<a class="headerlink" href="#filters-element" title="Permalink to this headline">¶</a></h3>
<p><a class="reference internal" href="#filterelement"><em>Filter elements</em></a> are used inside <a class="reference internal" href="#sequenceelement"><em>sequence elements</em></a> to execute arbitrary code, or make discontinuous changes in the vectors. Sometimes it is desirable to perform a filter element at the beginning or end of each step in an integration. This can be done by placing <tt class="docutils literal"><span class="pre"><filter></span></tt> elements in a <tt class="docutils literal"><span class="pre"><filters></span></tt> element within the <tt class="docutils literal"><span class="pre"><integrate></span></tt> element. The <tt class="docutils literal"><span class="pre"><filters></span></tt> element specifies whether the filters are to be executed at the end of each step or the beginning of each step with the <tt class="docutils literal"><span class="pre">where="step</span> <span class="pre">end"</span></tt> and <tt class="docutils literal"><span class="pre">where="step</span> <span class="pre">start"</span></tt> attributes respectively. Each filter
is then executed in the order found in the <tt class="docutils literal"><span class="pre"><filters></span></tt> element.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><integrate</span> <span class="na">algorithm=</span><span class="s">"ARK45"</span> <span class="na">interval=</span><span class="s">"100000.0"</span> <span class="na">steps=</span><span class="s">"10000000"</span> <span class="na">tolerance=</span><span class="s">"1e-8"</span><span class="nt">></span>
<span class="nt"><samples></span>5000 100<span class="nt"></samples></span>
<span class="nt"><filters</span> <span class="na">where=</span><span class="s">"step end"</span><span class="nt">></span>
<span class="nt"><filter></span>
<span class="nt"><dependencies></span>vector1 vector2<span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="n">x</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
<span class="n">y</span> <span class="o">*=</span> <span class="n">ynorm</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></filter></span>
<span class="nt"></filters></span>
<span class="nt"><operators></span>
<span class="nt"><integration_vectors></span>vector1<span class="nt"></integration_vectors></span>
<span class="cp"><![CDATA[</span>
<span class="n">dx_dt</span> <span class="o">=</span> <span class="n">alpha</span><span class="p">;</span>
<span class="n">dy_dt</span> <span class="o">=</span> <span class="n">beta</span><span class="o">*</span><span class="n">y</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></operators></span>
<span class="nt"></integrate></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="breakpoint-element">
<span id="breakpointelement"></span><span id="index-87"></span><h2>Breakpoint element<a class="headerlink" href="#breakpoint-element" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre"><breakpoint></span></tt> element is used to output the full state of one or more vectors. Unlike sampled output, it executes immediately rather than at the end of a program, and can therefore be used to examine the current state of an ongoing simulation. The vectors to be output are defined via a <a class="reference internal" href="#dependencies"><em><dependencies></em></a> element, and the basis is chosen by the <tt class="docutils literal"><span class="pre">basis</span></tt> attribute supplied to that <tt class="docutils literal"><span class="pre"><dependencies></span></tt> element, as usual. A single <tt class="docutils literal"><span class="pre"><breakpoint></span></tt> element must only contain vectors of equal dimension. The data format is specified by the <tt class="docutils literal"><span class="pre">format</span></tt> attribute, with current options being “ascii”, “binary” and the recommended: “hdf5”. The filename for the output can be specified by a <tt class="docutils literal"><span class="pre">filename</span></tt> attribute, in which case the same filename will be used each time the element is executed. If the <tt class="docutils literal"><span class="pre">filename</span></tt> attribute is not specified, then the first output will default to “1.xsil”, and subsequent executions of the same breakpoint will increment the number by one.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><breakpoint</span> <span class="na">filename=</span><span class="s">"groundstate_break.xsil"</span> <span class="na">format=</span><span class="s">"hdf5"</span><span class="nt">></span>
<span class="nt"><dependencies</span> <span class="na">basis=</span><span class="s">"ky"</span><span class="nt">></span>wavefunction<span class="nt"></dependencies></span>
<span class="nt"></breakpoint></span>
</pre></div>
</div>
</div>
<div class="section" id="output-element">
<span id="outputelement"></span><span id="index-88"></span><h2>Output element<a class="headerlink" href="#output-element" title="Permalink to this headline">¶</a></h2>
<p id="index-89">The <tt class="docutils literal"><span class="pre"><output></span></tt> element describes the output of the program. It is often inefficient to output the complete state of all vectors at all times during a large simulation, so the purpose of this function is to define subsets of the information required for output. Each different format of information is described in a different <tt class="docutils literal"><span class="pre"><sampling_group></span></tt> element inside the output element. The <tt class="docutils literal"><span class="pre"><output></span></tt> element may contain any number of <tt class="docutils literal"><span class="pre"><sampling_group></span></tt> elements. The format of the output data can be specified by the optional <tt class="docutils literal"><span class="pre">format</span></tt> attribute, which may take values of “ascii”, “binary”, and “hdf5” (the default). The filename can be specified with the optional <tt class="docutils literal"><span class="pre">filename</span></tt> attribute, which otherwise defaults to the simulation name with the ‘.xsil’ suffix.</p>
<p>The <tt class="docutils literal"><span class="pre"><samples></span></tt> inside <tt class="docutils literal"><span class="pre"><integrate></span></tt> elements defines a string of integers, with exactly one for each <tt class="docutils literal"><span class="pre"><sampling_group></span></tt> element. During that integration, the variables described in each <tt class="docutils literal"><span class="pre"><sampling_group></span></tt> element will be sampled and stored that number of times.</p>
<span class="target" id="index-90"></span><div class="section" id="sampling-group-element">
<span id="samplinggroupelement"></span><span id="index-91"></span><h3>Sampling Group Element<a class="headerlink" href="#sampling-group-element" title="Permalink to this headline">¶</a></h3>
<p>A <tt class="docutils literal"><span class="pre"><sampling_group></span></tt> element defines a set of variables that we wish to output, and typically they are functions of some subset of vectors. The names of the desired variables are listed in a <tt class="docutils literal"><span class="pre"><moments></span></tt> element, just like the <tt class="docutils literal"><span class="pre"><components></span></tt> element of a vector. They are defined with a ‘<a class="reference internal" href="#xmdscsyntax"><em>CDATA</em></a>‘ block, accessing any components of vectors and computed vectors that are defined in a <a class="reference internal" href="#dependencies"><em><dependencies></em></a> element, also just like a vector. <a class="reference internal" href="#computedvectorelement"><em>Computed vectors</em></a> and <a class="reference internal" href="#operatorelement"><em><operator></em></a> elements can be defined and used in the definition, just like in an <a class="reference internal" href="#integrateelement"><em><integrate></em></a> element.</p>
<p id="index-92">The basis of the output is specified by the <tt class="docutils literal"><span class="pre">basis</span></tt> attribute. This overrides any basis specification in the <tt class="docutils literal"><span class="pre"><dependencies></span></tt> element. Because we often wish to calculate these vectors on a finer grid than we wish to output, it is possible to specify that the output on a subset of the points defined for any transverse dimension. This is done by adding a number in parentheses after that dimension in the basis string, e.g. <tt class="docutils literal"><span class="pre">basis="x</span> <span class="pre">y(32)</span> <span class="pre">kz(64)"</span></tt>. If the number is zero, then that dimension is integrated out. If that number is one or more, then that dimension will be sampled on a subset of points in that space.</p>
<p>The <tt class="docutils literal"><span class="pre">initial_sample</span></tt> attribute, which must be “yes” or “no”, determines whether the moment group will be sampled before any integration occurs.</p>
<p>Example syntax:</p>
<div class="highlight-xmds2"><div class="highlight"><pre><span class="nt"><output</span> <span class="na">format=</span><span class="s">"hdf5"</span> <span class="na">filename=</span><span class="s">"SimOutput.xsil"</span><span class="nt">></span>
<span class="nt"><sampling_group</span> <span class="na">basis=</span><span class="s">"x y"</span> <span class="na">initial_sample=</span><span class="s">"yes"</span><span class="nt">></span>
<span class="nt"><computed_vector</span> <span class="na">name=</span><span class="s">"filter3"</span> <span class="na">dimensions=</span><span class="s">""</span> <span class="na">type=</span><span class="s">"complex"</span><span class="nt">></span>
<span class="nt"><components></span>sparemomentagain<span class="nt"></components></span>
<span class="nt"><evaluation></span>
<span class="nt"><dependencies</span> <span class="na">basis=</span><span class="s">"kx ky"</span><span class="nt">></span>integrated_u main<span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="n">sparemomentagain</span> <span class="o">=</span> <span class="nf">mod2</span><span class="p">(</span><span class="n">u</span><span class="p">);</span>
<span class="cp">]]></span>
<span class="nt"></evaluation></span>
<span class="nt"></computed_vector></span>
<span class="nt"><operator</span> <span class="na">kind=</span><span class="s">"ex"</span><span class="nt">></span>
<span class="nt"><operator_names></span>L<span class="nt"></operator_names></span>
<span class="cp"><![CDATA[</span>
<span class="n">L</span> <span class="o">=</span> <span class="o">-</span><span class="n">T</span><span class="o">*</span><span class="n">kx</span><span class="o">*</span><span class="n">kx</span><span class="o">/</span><span class="n">mu</span><span class="p">;</span>
<span class="cp">]]></span>
<span class="nt"></operator></span>
<span class="nt"><moments></span>amp ke<span class="nt"></moments></span>
<span class="nt"><dependencies></span>main filter1<span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="n">amp</span> <span class="o">=</span> <span class="nf">mod2</span><span class="p">(</span><span class="n">u</span> <span class="o">+</span> <span class="n">moment</span><span class="p">);</span>
<span class="n">ke</span> <span class="o">=</span> <span class="nf">mod2</span><span class="p">(</span><span class="n">L</span><span class="p">[</span><span class="n">u</span><span class="p">]);</span>
<span class="cp">]]></span>
<span class="nt"></sampling_group></span>
<span class="nt"><sampling_group</span> <span class="na">basis=</span><span class="s">"kx(0) ky(64)"</span> <span class="na">initial_sample=</span><span class="s">"yes"</span><span class="nt">></span>
<span class="nt"><moments></span>Dens_P <span class="nt"></moments></span>
<span class="nt"><dependencies></span>fields <span class="nt"></dependencies></span>
<span class="cp"><![CDATA[</span>
<span class="n">Dens_P</span> <span class="o">=</span> <span class="nf">mod2</span><span class="p">(</span><span class="n">psi</span><span class="p">);</span>
<span class="cp">]]></span>
<span class="nt"></sampling_group></span>
<span class="nt"></output></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="xmds-specific-c-syntax">
<span id="xmdscsyntax"></span><h2>XMDS-specific C syntax<a class="headerlink" href="#xmds-specific-c-syntax" title="Permalink to this headline">¶</a></h2>
<p>Sampling complex numbers can be written more efficiently using:</p>
<div class="highlight-xpdeint"><div class="highlight"><pre><span class="cp"><![CDATA[</span>
<span class="n">_SAMPLE_COMPLEX</span><span class="p">(</span><span class="n">W</span><span class="p">);</span>
<span class="cp">]]></span>
</pre></div>
</div>
<p>which is short for</p>
<div class="highlight-xpdeint"><div class="highlight"><pre><span class="cp"><![CDATA[</span>
<span class="n">WR</span> <span class="o">=</span> <span class="n">W</span><span class="p">.</span><span class="n">Re</span><span class="p">();</span>
<span class="n">WI</span> <span class="o">=</span> <span class="n">W</span><span class="p">.</span><span class="n">Im</span><span class="p">();</span>
<span class="cp">]]></span>
</pre></div>
</div>
<p>Various properties of dimensions are available. For example, for a dimension called <tt class="docutils literal"><span class="pre">x</span></tt>:</p>
<ul class="simple" id="index-93">
<li>The number of points is accessible with the variable <tt class="docutils literal"><span class="pre">_lattice_x</span></tt>,</li>
<li>The minimum range of that dimension is <tt class="docutils literal"><span class="pre">_min_x</span></tt>,</li>
<li>The maximum range of that dimension is <tt class="docutils literal"><span class="pre">_max_x</span></tt>,</li>
<li>The step size of a dimension is <tt class="docutils literal"><span class="pre">dx</span></tt>, and if it is constant, also available using <tt class="docutils literal"><span class="pre">_dx</span></tt>, but note that the latter does not include the effect of any <tt class="docutils literal"><span class="pre">volumePrefix</span></tt> you may have set!</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/xmds_logo.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">XMDS2 script elements</a><ul>
<li><a class="reference internal" href="#simulation-element">Simulation element</a></li>
<li><a class="reference internal" href="#name-element">Name element</a></li>
<li><a class="reference internal" href="#author-element">Author element</a></li>
<li><a class="reference internal" href="#description-element">Description element</a></li>
<li><a class="reference internal" href="#features-elements">Features Elements</a><ul>
<li><a class="reference internal" href="#arguments-element">Arguments Element</a><ul>
<li><a class="reference internal" href="#argument-element">Argument element</a></li>
</ul>
</li>
<li><a class="reference internal" href="#auto-vectorise-element">Auto_vectorise element</a></li>
<li><a class="reference internal" href="#benchmark">Benchmark</a></li>
<li><a class="reference internal" href="#bing">Bing</a></li>
<li><a class="reference internal" href="#c-flags">C Flags</a></li>
<li><a class="reference internal" href="#chunked-output">Chunked Output</a></li>
<li><a class="reference internal" href="#diagnostics">Diagnostics</a></li>
<li><a class="reference internal" href="#error-check">Error Check</a></li>
<li><a class="reference internal" href="#halt-non-finite">Halt_Non_Finite</a></li>
<li><a class="reference internal" href="#fftw-element">fftw element</a></li>
<li><a class="reference internal" href="#globals">Globals</a></li>
<li><a class="reference internal" href="#openmp">OpenMP</a></li>
<li><a class="reference internal" href="#precision">Precision</a></li>
<li><a class="reference internal" href="#validation">Validation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#driver-element">Driver Element</a></li>
<li><a class="reference internal" href="#geometry-element">Geometry Element</a><ul>
<li><a class="reference internal" href="#the-dft-transform">The “dft” transform</a></li>
<li><a class="reference internal" href="#the-dct-transform">The “dct” transform</a></li>
<li><a class="reference internal" href="#the-dst-transform">The “dst” transform</a></li>
<li><a class="reference internal" href="#the-bessel-and-bessel-neumann-transforms">The “bessel” and “bessel-neumann” transforms</a></li>
<li><a class="reference internal" href="#the-spherical-bessel-transform">The “spherical-bessel” transform</a></li>
<li><a class="reference internal" href="#the-hermite-gauss-transform">The “hermite-gauss” transform</a></li>
</ul>
</li>
<li><a class="reference internal" href="#vector-element">Vector Element</a><ul>
<li><a class="reference internal" href="#the-dependencies-element">The dependencies element</a></li>
</ul>
</li>
<li><a class="reference internal" href="#computed-vector-element">Computed Vector Element</a></li>
<li><a class="reference internal" href="#noise-vector-element">Noise Vector Element</a><ul>
<li><a class="reference internal" href="#uniform-noise">Uniform noise</a></li>
<li><a class="reference internal" href="#gaussian-noise">Gaussian noise</a></li>
<li><a class="reference internal" href="#wiener-noise">Wiener noise</a></li>
<li><a class="reference internal" href="#poissonian-noise">Poissonian noise</a></li>
<li><a class="reference internal" href="#jump-noise">Jump noise</a></li>
</ul>
</li>
<li><a class="reference internal" href="#sequence-element">Sequence Element</a></li>
<li><a class="reference internal" href="#filter-element">Filter element</a></li>
<li><a class="reference internal" href="#integrate-element">Integrate element</a><ul>
<li><a class="reference internal" href="#operators-and-operator-elements">Operators and operator elements</a></li>
<li><a class="reference internal" href="#algorithms">Algorithms</a><ul>
<li><a class="reference internal" href="#si-and-sic-algorithms">SI and SIC algorithms</a></li>
<li><a class="reference internal" href="#runge-kutta-algorithms">Runge-Kutta algorithms</a></li>
<li><a class="reference internal" href="#adaptive-runge-kutta-algorithms">Adaptive Runge-Kutta algorithms</a></li>
<li><a class="reference internal" href="#richardson-extrapolation-algorithms-and-the-bulirsch-stoer-method">Richardson Extrapolation Algorithms and the Bulirsch-Stoer Method</a></li>
</ul>
</li>
<li><a class="reference internal" href="#filters-element">Filters element</a></li>
</ul>
</li>
<li><a class="reference internal" href="#breakpoint-element">Breakpoint element</a></li>
<li><a class="reference internal" href="#output-element">Output element</a><ul>
<li><a class="reference internal" href="#sampling-group-element">Sampling Group Element</a></li>
</ul>
</li>
<li><a class="reference internal" href="#xmds-specific-c-syntax">XMDS-specific C syntax</a></li>
</ul>
</li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="bulirschStoer.html" title="Modified Midpoint Method"
>next</a> |</li>
<li class="right" >
<a href="reference_schema.html" title="XMDS2 XML Schema"
>previous</a> |</li>
<li><a href="index.html">XMDS2 2.2.2 documentation</a> »</li>
<li><a href="reference_index.html" >Reference section</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008-2014, Graham Dennis, Joe Hope and Mattias Johnsson. Licensed under the GNU FDL.
Last updated on Oct 14, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
</div>
</body>
</html>
|
