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
|
/////////////////////////////////////////////////////////////
// //
// Copyright (c) 2003-2017 by The University of Queensland //
// Centre for Geoscience Computing //
// http://earth.uq.edu.au/centre-geoscience-computing //
// //
// Primary Business: Brisbane, Queensland, Australia //
// Licensed under the Open Software License version 3.0 //
// http://www.apache.org/licenses/LICENSE-2.0 //
// //
/////////////////////////////////////////////////////////////
#include <boost/version.hpp>
#include <boost/python.hpp>
#include "Python/esys/lsm/ParticleFieldSaverPrmsPy.h"
namespace esys
{
namespace lsm
{
ParticleFieldSaverPrmsPy::ParticleFieldSaverPrmsPy(
const std::string &fieldName,
const std::string &fileName,
const std::string &fileFormat,
int beginTimeStep,
int endTimeStep,
int timeStepIncr
) :
FieldSaverPrmsPy(
fieldName,
fileName,
fileFormat,
beginTimeStep,
endTimeStep,
timeStepIncr
)
{
}
ParticleScalarFieldSaverPrmsPy::ParticleScalarFieldSaverPrmsPy(
const std::string &fieldName,
const std::string &fileName,
const std::string &fileFormat,
int beginTimeStep,
int endTimeStep,
int timeStepIncr
) :
ParticleFieldSaverPrmsPy(
fieldName,
fileName,
fileFormat,
beginTimeStep,
endTimeStep,
timeStepIncr
)
{
}
ParticleVectorFieldSaverPrmsPy::ParticleVectorFieldSaverPrmsPy(
const std::string &fieldName,
const std::string &fileName,
const std::string &fileFormat,
int beginTimeStep,
int endTimeStep,
int timeStepIncr
) :
ParticleFieldSaverPrmsPy(
fieldName,
fileName,
fileFormat,
beginTimeStep,
endTimeStep,
timeStepIncr
)
{
}
TaggedParticleScalarFieldSaverPrmsPy::TaggedParticleScalarFieldSaverPrmsPy(
const std::string &fieldName,
const std::string &fileName,
const std::string &fileFormat,
int beginTimeStep,
int endTimeStep,
int timeStepIncr,
int tag,
int mask
) : ParticleScalarFieldSaverPrmsPy (fieldName,
fileName,
fileFormat,
beginTimeStep,
endTimeStep,
timeStepIncr)
{
m_tag=tag;
m_mask=mask;
}
TaggedParticleVectorFieldSaverPrmsPy::TaggedParticleVectorFieldSaverPrmsPy(
const std::string &fieldName,
const std::string &fileName,
const std::string &fileFormat,
int beginTimeStep,
int endTimeStep,
int timeStepIncr,
int tag,
int mask
) : ParticleVectorFieldSaverPrmsPy (fieldName,
fileName,
fileFormat,
beginTimeStep,
endTimeStep,
timeStepIncr)
{
m_tag=tag;
m_mask=mask;
}
using boost::python::arg;
void exportParticleFieldSaverPrms()
{
// Disable autogeneration of C++ signatures (Boost 1.34.0 and higher)
// for Epydoc which stumbles over indentation in the automatically generated strings.
boost::python::docstring_options no_autogen(true,false);
boost::python::class_<
ParticleFieldSaverPrmsPy,
boost::python::bases<FieldSaverPrmsPy>
>(
"ParticleFieldSaverPrms",
"Base class describing parameters for saving particle-data to file.",
boost::python::init<
const std::string &,
const std::string &,
const std::string &,
int,
int,
int
>(
(
arg("fieldName"),
arg("fileName"),
arg("fileFormat"),
arg("beginTimeStep"),
arg("endTimeStep"),
arg("timeStepIncr")
),
"Base class for particle field savers\n"
"@type fieldName: string\n"
"@kwarg fieldName: Name of the data field\n"
"@type fileName: string\n"
"@kwarg fileName: Name of the file where data are saved\n"
"@type fileFormat: string\n"
"@kwarg fileFormat: Format of the data\n"
"@type beginTimeStep: int\n"
"@kwarg beginTimeStep: start saving data at this time step\n"
"@type endTimeStep: int\n"
"@kwarg endTimeStep: finish saving data at this time step\n"
"@type timeStepIncr: int\n"
"@kwarg timeStepIncr: save data every timeStepIncr time steps\n"
)
)
;
boost::python::class_<
ParticleScalarFieldSaverPrmsPy,
boost::python::bases<ParticleFieldSaverPrmsPy>
>(
"ParticleScalarFieldSaverPrms",
"Parameters for saving scalar particle-data to file.",
boost::python::init<
const std::string &,
const std::string &,
const std::string &,
int,
int,
int
>(
(
arg("fieldName"),
arg("fileName"),
arg("fileFormat"),
arg("beginTimeStep"),
arg("endTimeStep"),
arg("timeStepIncr")
),
"Defines particle scalar field saver parameters\n"
"@type fieldName: string\n"
"@kwarg fieldName: Name of the data field, e.g. 'e_kin'\n"
"@type fileName: string\n"
"@kwarg fileName: Name of the file where data is saved\n"
"@type fileFormat: string\n"
"@kwarg fileFormat: Format of the data, e.g. 'SUM' or 'MAX'\n"
"@type beginTimeStep: int\n"
"@kwarg beginTimeStep: start saving data at this time step\n"
"@type endTimeStep: int\n"
"@kwarg endTimeStep: finish saving data at this time step\n"
"@type timeStepIncr: int\n"
"@kwarg timeStepIncr: save data every timeStepIncr time steps\n"
)
)
;
boost::python::class_<
ParticleVectorFieldSaverPrmsPy,
boost::python::bases<ParticleFieldSaverPrmsPy>
>(
"ParticleVectorFieldSaverPrms",
"Parameters for saving vector particle-data to file.",
boost::python::init<
const std::string &,
const std::string &,
const std::string &,
int,
int,
int
>(
(
arg("fieldName"),
arg("fileName"),
arg("fileFormat"),
arg("beginTimeStep"),
arg("endTimeStep"),
arg("timeStepIncr")
),
"Defines particle vector field saver parameters\n"
"@type fieldName: string\n"
"@kwarg fieldName: Name of the data field, e.g. 'force'\n"
"@type fileName: string\n"
"@kwarg fileName: Name of the file where data is saved\n"
"@type fileFormat: string\n"
"@kwarg fileFormat: Format of the data, e.g. 'SUM' or 'MAX'\n"
"@type beginTimeStep: int\n"
"@kwarg beginTimeStep: start saving data at this time step\n"
"@type endTimeStep: int\n"
"@kwarg endTimeStep: finish saving data at this time step\n"
"@type timeStepIncr: int\n"
"@kwarg timeStepIncr: save data every timeStepIncr time steps\n"
)
);
boost::python::class_<
TaggedParticleScalarFieldSaverPrmsPy,
boost::python::bases<ParticleScalarFieldSaverPrmsPy>
>(
"TaggedParticleScalarFieldSaverPrms",
"Parameters for saving scalar data of tagged particles to file.",
boost::python::init<
const std::string &,
const std::string &,
const std::string &,
int,
int,
int,
int,
int
>(
(
arg("fieldName"),
arg("fileName"),
arg("fileFormat"),
arg("beginTimeStep"),
arg("endTimeStep"),
arg("timeStepIncr"),
arg("tag"),
arg("mask")
),
"Defines tagged particle scalar field saver parameters\n"
"@type fieldName: string\n"
"@kwarg fieldName: Name of the data field, e.g. 'e_kin'\n"
"@type fileName: string\n"
"@kwarg fileName: Name of the file where data is saved\n"
"@type fileFormat: string\n"
"@kwarg fileFormat: Format of the data, e.g. 'SUM' or 'MAX'\n"
"@type beginTimeStep: int\n"
"@kwarg beginTimeStep: start saving data at this time step\n"
"@type endTimeStep: int\n"
"@kwarg endTimeStep: finish saving data at this time step\n"
"@type timeStepIncr: int\n"
"@kwarg timeStepIncr: save data every timeStepIncr time steps\n"
"@type tag: int\n"
"@kwarg tag: the tag of the particles\n"
"@type mask: int\n"
"@kwarg mask: the tag mask\n"
)
)
;
boost::python::class_<
TaggedParticleVectorFieldSaverPrmsPy,
boost::python::bases<ParticleVectorFieldSaverPrmsPy>
>(
"TaggedParticleVectorFieldSaverPrms",
"Parameters for saving vector data of tagged particles to file.",
boost::python::init<
const std::string &,
const std::string &,
const std::string &,
int,
int,
int,
int,
int
>(
(
arg("fieldName"),
arg("fileName"),
arg("fileFormat"),
arg("beginTimeStep"),
arg("endTimeStep"),
arg("timeStepIncr"),
arg("tag"),
arg("mask")
),
"Defines tagged particle vector field saver parameters\n"
"@type fieldName: string\n"
"@kwarg fieldName: Name of the data field, e.g. 'force'\n"
"@type fileName: string\n"
"@kwarg fileName: Name of the file where data is saved\n"
"@type fileFormat: string\n"
"@kwarg fileFormat: Format of the data, e.g. 'SUM' or 'MAX'\n"
"@type beginTimeStep: int\n"
"@kwarg beginTimeStep: start saving data at this time step\n"
"@type endTimeStep: int\n"
"@kwarg endTimeStep: finish saving data at this time step\n"
"@type timeStepIncr: int\n"
"@kwarg timeStepIncr: save data every timeStepIncr time steps\n"
"@type tag: int\n"
"@kwarg tag: the tag of the particles\n"
"@type mask: int\n"
"@kwarg mask: the tag mask\n"
)
);
}
}
}
|
