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
|
@shBang #!/usr/bin/env python3
@*
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/>.
*@
@extends xpdeint.Segments.Integrators._Integrator
@from xpdeint.CallOnceGuards import callOncePerInstanceGuard
@def description: segment $segmentNumber ($stepper.name Integrator)
@def globals
@#
@super
@#
@for $vector in $integrationVectors
@# Loop over the variables that need to be created
@for $arrayName in $extraIntegrationArrayNames
${vector.type}* _${name}_${arrayName}_${vector.id};
@end for
@end for
@#
@end def
@def deltaAFunctionBody($function)
@#
@# First evaluate any computed vector that any of our operators may depend on
${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($intraStepOperatorContainers), static = False)}@slurp
@#
@# 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 $intraStepOperatorContainers
${operatorContainer.evaluatePreDeltaAOperators(parentFunction = function)}@slurp
@end for
@#
@# 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 $intraStepOperatorContainersInFieldDescendingOrder
@# Blank line for formatting
${operatorContainer.evaluateDeltaAOperator(parentFunction = function)}@slurp
@end for
@#
@# 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 $intraStepOperatorContainers
@# Blank line for formatting
${operatorContainer.evaluatePostDeltaAOperators(parentFunction = function)}@slurp
@end for
@#
@end def
@def preSingleStep
@#
${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($stepStartOperatorContainers))}@slurp
@#
@for $operatorContainer in $stepStartOperatorContainers
${operatorContainer.evaluateOperators(_step = '_step')}@slurp
@end for
@#
@end def
@def postSingleStep
@#
@set $featureOrdering = ['HaltNonFinite']
@#
${insertCodeForFeatures('postSingleStep', featureOrdering)}@slurp
@#
${evaluateComputedVectors($dynamicVectorsNeedingPrecalculationForOperatorContainers($stepEndOperatorContainers))}@slurp
@#
@for $operatorContainer in $stepEndOperatorContainers
${operatorContainer.evaluateOperators(_step = '_step')}@slurp
@end for
@#
@end def
@@callOncePerInstanceGuard
@def allocate
@*doc:
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).
*@
@#
@super
@#
@# Loop over the vectors creating the arrays
@for $vector in $integrationVectors
@# Loop over the variables that need to be created
@for $arrayName in $extraIntegrationArrayNames
_${name}_${arrayName}_${vector.id} = @slurp
(${vector.type}*) xmds_malloc(sizeof(${vector.type}) * MAX(${vector.allocSize},1));
@end for
@end for
@#
@end def
@@callOncePerInstanceGuard
@def free
@#
@super
@#
@for $vector in $integrationVectors
@for $arrayName in $extraIntegrationArrayNames
xmds_free(_${name}_${arrayName}_${vector.id});
@end for
@end for
@#
@end def
@def localInitialise
@*doc:
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.
*@
@#
@for $vector in $integrationVectors
@# Loop over the variables that need to be created
@for $arrayName in $extraIntegrationArrayNames
${vector.type}* _${arrayName}_${vector.id} = _${name}_${arrayName}_${vector.id};
@end for
@end for
${stepper.localInitialise}@slurp
@#
@end def
@def localFinalise
@*doc:
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.
*@
@#
_SEGMENT${segmentNumber}_END:;
${stepper.localFinalise}@slurp
@#
@end def
@def earlyTerminationCode
@*doc:
This method writes code that should be executed if the integrator needs
to be terminated early
*@
@#
@for mg, sampleCount in zip($momentGroups, $samples)
@if not $sampleCount
@continue
@end if
@#
@for dim in filter(lambda x: not x.transverse, mg.outputField.dimensions)
@set $dimRep = dim.inBasis(mg.outputBasis)
if (${dimRep.prefix}_index_${dimRep.name} < ${dimRep.globalLattice})
_${mg.name}_sample();
@end for
@end for
goto _SEGMENT${segmentNumber}_END;
@#
@end def
|
