File: Integrator.py

package info (click to toggle)
xmds2 3.0.0%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 52,068 kB
  • sloc: python: 63,652; javascript: 9,230; cpp: 3,929; ansic: 1,463; makefile: 121; sh: 54
file content (649 lines) | stat: -rw-r--r-- 28,593 bytes parent folder | download
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
#!/usr/bin/env python3




##################################################
## DEPENDENCIES
import sys
import os
import os.path
try:
    import builtins as builtin
except ImportError:
    import __builtin__ as builtin
from os.path import getmtime, exists
import time
import types
from Cheetah.Version import MinCompatibleVersion as RequiredCheetahVersion
from Cheetah.Version import MinCompatibleVersionTuple as RequiredCheetahVersionTuple
from Cheetah.Template import Template
from Cheetah.DummyTransaction import *
from Cheetah.NameMapper import NotFound, valueForName, valueFromSearchList, valueFromFrameOrSearchList
from Cheetah.CacheRegion import CacheRegion
import Cheetah.Filters as Filters
import Cheetah.ErrorCatchers as ErrorCatchers
from Cheetah.compat import unicode
from xpdeint.Segments.Integrators._Integrator import _Integrator
from xpdeint.CallOnceGuards import callOncePerInstanceGuard

##################################################
## MODULE CONSTANTS
VFFSL=valueFromFrameOrSearchList
VFSL=valueFromSearchList
VFN=valueForName
currentTime=time.time
__CHEETAH_version__ = '3.2.3'
__CHEETAH_versionTuple__ = (3, 2, 3, 'final', 0)
__CHEETAH_genTime__ = 1558054970.1045353
__CHEETAH_genTimestamp__ = 'Fri May 17 11:02:50 2019'
__CHEETAH_src__ = '/home/mattias/xmds-2.2.3/admin/staging/xmds-3.0.0/xpdeint/Segments/Integrators/Integrator.tmpl'
__CHEETAH_srcLastModified__ = 'Thu Apr  4 16:29:24 2019'
__CHEETAH_docstring__ = 'Autogenerated by Cheetah: The Python-Powered Template Engine'

if __CHEETAH_versionTuple__ < RequiredCheetahVersionTuple:
    raise AssertionError(
      'This template was compiled with Cheetah version'
      ' %s. Templates compiled before version %s must be recompiled.'%(
         __CHEETAH_version__, RequiredCheetahVersion))

##################################################
## CLASSES

class Integrator(_Integrator):

    ##################################################
    ## CHEETAH GENERATED METHODS


    def __init__(self, *args, **KWs):

        super(Integrator, self).__init__(*args, **KWs)
        if not self._CHEETAH__instanceInitialized:
            cheetahKWArgs = {}
            allowedKWs = 'searchList namespaces filter filtersLib errorCatcher'.split()
            for k,v in KWs.items():
                if k in allowedKWs: cheetahKWArgs[k] = v
            self._initCheetahInstance(**cheetahKWArgs)
        

    def description(self, **KWS):



        ## Generated from @def description: segment $segmentNumber ($stepper.name Integrator) at line 27, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        write('''segment ''')
        _v = VFFSL(SL,"segmentNumber",True) # '$segmentNumber' on line 27, col 27
        if _v is not None: write(_filter(_v, rawExpr='$segmentNumber')) # from line 27, col 27.
        write(''' (''')
        _v = VFFSL(SL,"stepper.name",True) # '$stepper.name' on line 27, col 43
        if _v is not None: write(_filter(_v, rawExpr='$stepper.name')) # from line 27, col 43.
        write(''' Integrator)''')
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    def globals(self, **KWS):



        ## CHEETAH: generated from @def globals at line 29, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        _v = super(Integrator, self).globals()
        if _v is not None: write(_filter(_v))
        # 
        for vector in VFFSL(SL,"integrationVectors",True): # generated from line 33, col 3
            #  Loop over the variables that need to be created
            for arrayName in VFFSL(SL,"extraIntegrationArrayNames",True): # generated from line 35, col 5
                _v = VFFSL(SL,"vector.type",True) # '${vector.type}' on line 36, col 1
                if _v is not None: write(_filter(_v, rawExpr='${vector.type}')) # from line 36, col 1.
                write('''* _''')
                _v = VFFSL(SL,"name",True) # '${name}' on line 36, col 18
                if _v is not None: write(_filter(_v, rawExpr='${name}')) # from line 36, col 18.
                write('''_''')
                _v = VFFSL(SL,"arrayName",True) # '${arrayName}' on line 36, col 26
                if _v is not None: write(_filter(_v, rawExpr='${arrayName}')) # from line 36, col 26.
                write('''_''')
                _v = VFFSL(SL,"vector.id",True) # '${vector.id}' on line 36, col 39
                if _v is not None: write(_filter(_v, rawExpr='${vector.id}')) # from line 36, col 39.
                write(''';
''')
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    def deltaAFunctionBody(self, function, **KWS):



        ## CHEETAH: generated from @def deltaAFunctionBody($function) at line 42, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        #  First evaluate any computed vector that any of our operators may depend on
        _v = VFFSL(SL,"evaluateComputedVectors",False)(VFFSL(SL,"dynamicVectorsNeedingPrecalculationForOperatorContainers",False)(VFFSL(SL,"intraStepOperatorContainers",True)), static = False) # '${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($intraStepOperatorContainers), static = False)}' on line 45, col 1
        if _v is not None: write(_filter(_v, rawExpr='${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($intraStepOperatorContainers), static = False)}')) # from line 45, col 1.
        # 
        #  Then loop over operators that come before the delta A operators in the order in which
        #  they appear in the xmds script.
        # 
        for operatorContainer in VFFSL(SL,"intraStepOperatorContainers",True): # generated from line 50, col 3
            write('''
''')
            _v = VFN(VFFSL(SL,"operatorContainer",True),"evaluatePreDeltaAOperators",False)(parentFunction = function) # '${operatorContainer.evaluatePreDeltaAOperators(parentFunction = function)}' on line 52, col 1
            if _v is not None: write(_filter(_v, rawExpr='${operatorContainer.evaluatePreDeltaAOperators(parentFunction = function)}')) # from line 52, col 1.
        # 
        #  Now loop over delta A operators
        #  See the comment in _Integrator about why this needs to be done in
        #  this particular order
        for operatorContainer in VFFSL(SL,"intraStepOperatorContainersInFieldDescendingOrder",True): # generated from line 58, col 3
            #  Blank line for formatting
            write('''
''')
            _v = VFN(VFFSL(SL,"operatorContainer",True),"evaluateDeltaAOperator",False)(parentFunction = function) # '${operatorContainer.evaluateDeltaAOperator(parentFunction = function)}' on line 61, col 1
            if _v is not None: write(_filter(_v, rawExpr='${operatorContainer.evaluateDeltaAOperator(parentFunction = function)}')) # from line 61, col 1.
        # 
        #  Lastly, loop over the operators that come after the delta a operators in the order in
        #  which they appear in the xmds script.
        # 
        for operatorContainer in VFFSL(SL,"intraStepOperatorContainers",True): # generated from line 67, col 3
            #  Blank line for formatting
            write('''
''')
            _v = VFN(VFFSL(SL,"operatorContainer",True),"evaluatePostDeltaAOperators",False)(parentFunction = function) # '${operatorContainer.evaluatePostDeltaAOperators(parentFunction = function)}' on line 70, col 1
            if _v is not None: write(_filter(_v, rawExpr='${operatorContainer.evaluatePostDeltaAOperators(parentFunction = function)}')) # from line 70, col 1.
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    def preSingleStep(self, **KWS):



        ## CHEETAH: generated from @def preSingleStep at line 75, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        _v = VFFSL(SL,"evaluateComputedVectors",False)(VFFSL(SL,"dynamicVectorsNeedingPrecalculationForOperatorContainers",False)(VFFSL(SL,"stepStartOperatorContainers",True))) # '${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($stepStartOperatorContainers))}' on line 77, col 1
        if _v is not None: write(_filter(_v, rawExpr='${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($stepStartOperatorContainers))}')) # from line 77, col 1.
        # 
        for operatorContainer in VFFSL(SL,"stepStartOperatorContainers",True): # generated from line 79, col 3
            write('''
''')
            _v = VFN(VFFSL(SL,"operatorContainer",True),"evaluateOperators",False)(_step = '_step') # "${operatorContainer.evaluateOperators(_step = '_step')}" on line 81, col 1
            if _v is not None: write(_filter(_v, rawExpr="${operatorContainer.evaluateOperators(_step = '_step')}")) # from line 81, col 1.
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    def postSingleStep(self, **KWS):



        ## CHEETAH: generated from @def postSingleStep at line 86, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        featureOrdering = ['HaltNonFinite']
        # 
        _v = VFFSL(SL,"insertCodeForFeatures",False)('postSingleStep', featureOrdering) # "${insertCodeForFeatures('postSingleStep', featureOrdering)}" on line 90, col 1
        if _v is not None: write(_filter(_v, rawExpr="${insertCodeForFeatures('postSingleStep', featureOrdering)}")) # from line 90, col 1.
        # 
        _v = VFFSL(SL,"evaluateComputedVectors",False)(VFFSL(SL,"dynamicVectorsNeedingPrecalculationForOperatorContainers",False)(VFFSL(SL,"stepEndOperatorContainers",True))) # '${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($stepEndOperatorContainers))}' on line 92, col 1
        if _v is not None: write(_filter(_v, rawExpr='${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($stepEndOperatorContainers))}')) # from line 92, col 1.
        # 
        for operatorContainer in VFFSL(SL,"stepEndOperatorContainers",True): # generated from line 94, col 3
            write('''
''')
            _v = VFN(VFFSL(SL,"operatorContainer",True),"evaluateOperators",False)(_step = '_step') # "${operatorContainer.evaluateOperators(_step = '_step')}" on line 96, col 1
            if _v is not None: write(_filter(_v, rawExpr="${operatorContainer.evaluateOperators(_step = '_step')}")) # from line 96, col 1.
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    @callOncePerInstanceGuard
    def allocate(self, **KWS):


        """
        Allocate additional arrays needed for the integrator
        
        This is a call once-per-instance function because we may want to do the initialisation
        (and clean-up) for this segment in a parent segment for efficiency reasons (if, for
        example we are looping over this segment, or we are running multiple paths).
        """

        ## CHEETAH: generated from @def allocate at line 102, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        _v = super(Integrator, self).allocate()
        if _v is not None: write(_filter(_v))
        # 
        #  Loop over the vectors creating the arrays
        for vector in VFFSL(SL,"integrationVectors",True): # generated from line 114, col 3
            #  Loop over the variables that need to be created
            for arrayName in VFFSL(SL,"extraIntegrationArrayNames",True): # generated from line 116, col 5
                write('''_''')
                _v = VFFSL(SL,"name",True) # '${name}' on line 117, col 2
                if _v is not None: write(_filter(_v, rawExpr='${name}')) # from line 117, col 2.
                write('''_''')
                _v = VFFSL(SL,"arrayName",True) # '${arrayName}' on line 117, col 10
                if _v is not None: write(_filter(_v, rawExpr='${arrayName}')) # from line 117, col 10.
                write('''_''')
                _v = VFFSL(SL,"vector.id",True) # '${vector.id}' on line 117, col 23
                if _v is not None: write(_filter(_v, rawExpr='${vector.id}')) # from line 117, col 23.
                write(''' = ''')
                write('''(''')
                _v = VFFSL(SL,"vector.type",True) # '${vector.type}' on line 118, col 2
                if _v is not None: write(_filter(_v, rawExpr='${vector.type}')) # from line 118, col 2.
                write('''*) xmds_malloc(sizeof(''')
                _v = VFFSL(SL,"vector.type",True) # '${vector.type}' on line 118, col 38
                if _v is not None: write(_filter(_v, rawExpr='${vector.type}')) # from line 118, col 38.
                write(''') * MAX(''')
                _v = VFFSL(SL,"vector.allocSize",True) # '${vector.allocSize}' on line 118, col 60
                if _v is not None: write(_filter(_v, rawExpr='${vector.allocSize}')) # from line 118, col 60.
                write(''',1));
''')
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    @callOncePerInstanceGuard
    def free(self, **KWS):



        ## CHEETAH: generated from @def free at line 125, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        _v = super(Integrator, self).free()
        if _v is not None: write(_filter(_v))
        # 
        for vector in VFFSL(SL,"integrationVectors",True): # generated from line 129, col 3
            for arrayName in VFFSL(SL,"extraIntegrationArrayNames",True): # generated from line 130, col 5
                write('''xmds_free(_''')
                _v = VFFSL(SL,"name",True) # '${name}' on line 131, col 12
                if _v is not None: write(_filter(_v, rawExpr='${name}')) # from line 131, col 12.
                write('''_''')
                _v = VFFSL(SL,"arrayName",True) # '${arrayName}' on line 131, col 20
                if _v is not None: write(_filter(_v, rawExpr='${arrayName}')) # from line 131, col 20.
                write('''_''')
                _v = VFFSL(SL,"vector.id",True) # '${vector.id}' on line 131, col 33
                if _v is not None: write(_filter(_v, rawExpr='${vector.id}')) # from line 131, col 33.
                write(''');
''')
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    def localInitialise(self, **KWS):


        """
        Because the initialisation for the integrator could be in a different function,
        we need to set up pointers in the integrator to the appropriate arrays.
        """

        ## CHEETAH: generated from @def localInitialise at line 137, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        for vector in VFFSL(SL,"integrationVectors",True): # generated from line 143, col 3
            #  Loop over the variables that need to be created
            for arrayName in VFFSL(SL,"extraIntegrationArrayNames",True): # generated from line 145, col 5
                _v = VFFSL(SL,"vector.type",True) # '${vector.type}' on line 146, col 1
                if _v is not None: write(_filter(_v, rawExpr='${vector.type}')) # from line 146, col 1.
                write('''* _''')
                _v = VFFSL(SL,"arrayName",True) # '${arrayName}' on line 146, col 18
                if _v is not None: write(_filter(_v, rawExpr='${arrayName}')) # from line 146, col 18.
                write('''_''')
                _v = VFFSL(SL,"vector.id",True) # '${vector.id}' on line 146, col 31
                if _v is not None: write(_filter(_v, rawExpr='${vector.id}')) # from line 146, col 31.
                write(''' = _''')
                _v = VFFSL(SL,"name",True) # '${name}' on line 146, col 47
                if _v is not None: write(_filter(_v, rawExpr='${name}')) # from line 146, col 47.
                write('''_''')
                _v = VFFSL(SL,"arrayName",True) # '${arrayName}' on line 146, col 55
                if _v is not None: write(_filter(_v, rawExpr='${arrayName}')) # from line 146, col 55.
                write('''_''')
                _v = VFFSL(SL,"vector.id",True) # '${vector.id}' on line 146, col 68
                if _v is not None: write(_filter(_v, rawExpr='${vector.id}')) # from line 146, col 68.
                write(''';
''')
        write('''
''')
        _v = VFFSL(SL,"stepper.localInitialise",True) # '${stepper.localInitialise}' on line 150, col 1
        if _v is not None: write(_filter(_v, rawExpr='${stepper.localInitialise}')) # from line 150, col 1.
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    def localFinalise(self, **KWS):


        """
        Because the finalisation for the integrator could be in a different function,
        we need to be able to insert code at the end of the integrator as well.
        """

        ## CHEETAH: generated from @def localFinalise at line 154, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        write('''_SEGMENT''')
        _v = VFFSL(SL,"segmentNumber",True) # '${segmentNumber}' on line 160, col 9
        if _v is not None: write(_filter(_v, rawExpr='${segmentNumber}')) # from line 160, col 9.
        write('''_END:;
''')
        _v = VFFSL(SL,"stepper.localFinalise",True) # '${stepper.localFinalise}' on line 161, col 1
        if _v is not None: write(_filter(_v, rawExpr='${stepper.localFinalise}')) # from line 161, col 1.
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    def earlyTerminationCode(self, **KWS):


        """
        This method writes code that should be executed if the integrator needs
        to be terminated early
        """

        ## CHEETAH: generated from @def earlyTerminationCode at line 165, col 1.
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        # 
        for mg, sampleCount in zip(VFFSL(SL,"momentGroups",True), VFFSL(SL,"samples",True)): # generated from line 171, col 3
            if not VFFSL(SL,"sampleCount",True): # generated from line 172, col 5
                continue
            # 
            for dim in filter(lambda x: not x.transverse, mg.outputField.dimensions): # generated from line 176, col 5
                dimRep = dim.inBasis(mg.outputBasis)
                write('''if (''')
                _v = VFFSL(SL,"dimRep.prefix",True) # '${dimRep.prefix}' on line 178, col 5
                if _v is not None: write(_filter(_v, rawExpr='${dimRep.prefix}')) # from line 178, col 5.
                write('''_index_''')
                _v = VFFSL(SL,"dimRep.name",True) # '${dimRep.name}' on line 178, col 28
                if _v is not None: write(_filter(_v, rawExpr='${dimRep.name}')) # from line 178, col 28.
                write(''' < ''')
                _v = VFFSL(SL,"dimRep.globalLattice",True) # '${dimRep.globalLattice}' on line 178, col 45
                if _v is not None: write(_filter(_v, rawExpr='${dimRep.globalLattice}')) # from line 178, col 45.
                write(''')
  _''')
                _v = VFFSL(SL,"mg.name",True) # '${mg.name}' on line 179, col 4
                if _v is not None: write(_filter(_v, rawExpr='${mg.name}')) # from line 179, col 4.
                write('''_sample();
''')
        write('''
goto _SEGMENT''')
        _v = VFFSL(SL,"segmentNumber",True) # '${segmentNumber}' on line 183, col 14
        if _v is not None: write(_filter(_v, rawExpr='${segmentNumber}')) # from line 183, col 14.
        write('''_END;
''')
        # 
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        

    def writeBody(self, **KWS):



        ## CHEETAH: main method generated for this template
        trans = KWS.get("trans")
        if (not trans and not self._CHEETAH__isBuffering and not callable(self.transaction)):
            trans = self.transaction # is None unless self.awake() was called
        if not trans:
            trans = DummyTransaction()
            _dummyTrans = True
        else: _dummyTrans = False
        write = trans.response().write
        SL = self._CHEETAH__searchList
        _filter = self._CHEETAH__currentFilter
        
        ########################################
        ## START - generated method body
        
        write('''
''')
        # 
        # Integrator.tmpl
        # 
        # Created by Graham Dennis on 2007-10-20.
        # 
        # Copyright (c) 2007-2012, Graham Dennis
        # 
        # This program is free software: you can redistribute it and/or modify
        # it under the terms of the GNU General Public License as published by
        # the Free Software Foundation, either version 2 of the License, or
        # (at your option) any later version.
        # 
        # This program is distributed in the hope that it will be useful,
        # but WITHOUT ANY WARRANTY; without even the implied warranty of
        # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        # GNU General Public License for more details.
        # 
        # You should have received a copy of the GNU General Public License
        # along with this program.  If not, see <http://www.gnu.org/licenses/>.
        # 
        write('''









''')
        
        ########################################
        ## END - generated method body
        
        return _dummyTrans and trans.response().getvalue() or ""
        
    ##################################################
    ## CHEETAH GENERATED ATTRIBUTES


    _CHEETAH__instanceInitialized = False

    _CHEETAH_version = __CHEETAH_version__

    _CHEETAH_versionTuple = __CHEETAH_versionTuple__

    _CHEETAH_genTime = __CHEETAH_genTime__

    _CHEETAH_genTimestamp = __CHEETAH_genTimestamp__

    _CHEETAH_src = __CHEETAH_src__

    _CHEETAH_srcLastModified = __CHEETAH_srcLastModified__

    _mainCheetahMethod_for_Integrator = 'writeBody'

## END CLASS DEFINITION

if not hasattr(Integrator, '_initCheetahAttributes'):
    templateAPIClass = getattr(Integrator,
                               '_CHEETAH_templateClass',
                               Template)
    templateAPIClass._addCheetahPlumbingCodeToClass(Integrator)


# CHEETAH was developed by Tavis Rudd and Mike Orr
# with code, advice and input from many other volunteers.
# For more information visit https://cheetahtemplate.org/

##################################################
## if run from command line:
if __name__ == '__main__':
    from Cheetah.TemplateCmdLineIface import CmdLineIface
    CmdLineIface(templateObj=Integrator()).run()