-
Notifications
You must be signed in to change notification settings - Fork 11
/
buildup_simulation.py
547 lines (469 loc) · 19.9 KB
/
buildup_simulation.py
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
#!/afs/cern.ch/project/uslarp/opt/lxplus64/Python-2.7.2/bin/python
# -Begin-preamble-------------------------------------------------------
#
# CERN
#
# European Organization for Nuclear Research
#
#
# This file is part of the code:
#
# PyECLOUD Version 8.7.1
#
#
# Main author: Giovanni IADAROLA
# BE-ABP Group
# CERN
# CH-1211 GENEVA 23
# SWITZERLAND
#
# Contributors: Eleonora Belli
# Philipp Dijkstal
# Lorenzo Giacomel
# Lotta Mether
# Annalisa Romano
# Giovanni Rumolo
# Eric Wulff
#
#
# Copyright CERN, Geneva 2011 - Copyright and any other
# appropriate legal protection of this computer program and
# associated documentation reserved in all countries of the
# world.
#
# Organizations collaborating with CERN may receive this program
# and documentation freely and without charge.
#
# CERN undertakes no obligation for the maintenance of this
# program, nor responsibility for its correctness, and accepts
# no liability whatsoever resulting from its use.
#
# Program and documentation are provided solely for the use of
# the organization to which they are distributed.
#
# This program may not be copied or otherwise distributed
# without permission. This message must be retained on this and
# any other authorized copies.
#
# The material cannot be sold. CERN should be given credit in
# all references.
#
# -End-preamble---------------------------------------------------------
from . import init as init
import pickle
import numpy as np
import os
class BuildupSimulation(object):
def __init__(
self,
pyecl_input_folder="./",
skip_beam=False,
skip_spacech_ele=False,
skip_pyeclsaver=False,
ignore_kwargs=[],
spacech_ele=None,
**kwargs
):
print("PyECLOUD Version 8.7.1")
(
beamtim,
spacech_ele,
t_sc_ON,
flag_presence_sec_beams,
sec_beams_list,
config_dict,
flag_multiple_clouds,
cloud_list,
checkpoint_folder,
cross_ion,
flag_reinterp_fields_at_substeps,
) = init.read_input_files_and_init_components(
pyecl_input_folder=pyecl_input_folder,
skip_beam=skip_beam,
skip_pyeclsaver=skip_pyeclsaver,
skip_spacech_ele=skip_spacech_ele,
spacech_ele=spacech_ele,
ignore_kwargs=ignore_kwargs,
**kwargs
)
self.config_dict = config_dict
self.beamtim = beamtim
self.spacech_ele = spacech_ele
self.t_sc_ON = t_sc_ON
self.flag_presence_sec_beams = flag_presence_sec_beams
self.sec_beams_list = sec_beams_list
self.flag_multiple_clouds = flag_multiple_clouds
self.cloud_list = cloud_list
self.chamb = cloud_list[0].impact_man.chamb
self.checkpoint_folder = checkpoint_folder
self.flag_em_tracking = spacech_ele.flag_em_tracking
self.cross_ion = cross_ion
self.flag_reinterp_fields_at_substeps = flag_reinterp_fields_at_substeps
print(f"Reinterp fields at substeps: {self.flag_reinterp_fields_at_substeps}")
# Checking if there are saved checkpoints
if self.checkpoint_folder is not None:
if os.path.isdir(self.checkpoint_folder):
if len(os.listdir(self.checkpoint_folder)) == 1:
print("Loading from checkpoint...")
# Selecting latest checkpoint
checkpoint = os.listdir(self.checkpoint_folder)[0]
self.load_checkpoint(
filename_simulation_checkpoint=checkpoint,
load_from_folder=self.checkpoint_folder,
)
elif len(os.listdir(self.checkpoint_folder)) == 0:
print("No checkpoint found, starting new simulation...")
else:
raise ValueError(
"More than one checkpoint found in %s" % self.checkpoint_folder
)
def run(self, t_end_sim=None):
beamtim = self.beamtim
flag_presence_sec_beams = self.flag_presence_sec_beams
sec_beams_list = self.sec_beams_list
print("Start timestep iter")
## simulation
while not beamtim.end_simulation():
if t_end_sim is not None and beamtim.tt_curr is not None:
if beamtim.tt_curr >= t_end_sim:
print("Reached user defined t_end_sim --> Ending simulation")
break
beamtim.next_time_step()
if flag_presence_sec_beams:
for sec_beam in sec_beams_list:
sec_beam.next_time_step()
self.sim_time_step()
if beamtim.flag_new_bunch_pass:
print(
"**** Done pass_numb = %d/%d\n"
% (beamtim.pass_numb, beamtim.N_pass_tot)
)
def sim_time_step(
self,
beamtim_obj=None,
Dt_substep_custom=None,
N_sub_steps_custom=None,
kick_mode_for_beam_field=False,
force_recompute_space_charge=False,
force_reinterp_fields_at_substeps=False,
skip_MP_cleaning=False,
skip_MP_regen=False,
):
if beamtim_obj is not None:
beamtim = beamtim_obj
else:
beamtim = self.beamtim
flag_recompute_space_charge = self.spacech_ele.check_for_recomputation(
t_curr=beamtim.tt_curr
)
# Loop over clouds: gather fields, move, generate new MPs
for i_cloud, cloud in enumerate(self.cloud_list):
## Save position before motion step
old_pos = cloud.MP_e.get_positions()
## Motion
## (external B field, beam and cloud fields are taken
## into account)
self._cloud_motion(
cloud,
beamtim,
Dt_substep_custom,
N_sub_steps_custom,
kick_mode_for_beam_field,
force_reinterp_fields_at_substeps,
)
## Impacts: backtracking and secondary emission
cloud.MP_e = cloud.impact_man.backtrack_and_second_emiss(
old_pos, cloud.MP_e, beamtim.tt_curr
)
## Evolve SEY module (e.g. charge decay for insulators
cloud.impact_man.sey_mod.SEY_model_evol(Dt=beamtim.Dt_curr)
## Beam-gas ionization and photoemission
self._primary_generation(cloud, beamtim)
## Cross_ionization
if self.cross_ion is not None:
self.cross_ion.generate(Dt=beamtim.Dt_curr, cloud_list=self.cloud_list)
## Compute space charge field (PIC: scatter and solve)
self._recompute_cloud_spacecharge(
beamtim, flag_recompute_space_charge, force_recompute_space_charge
)
## Saving output
self._save_output_data(beamtim)
## Cleaning and regeneration
self._MP_cleaning_and_regenerations(beamtim, skip_MP_cleaning, skip_MP_regen)
def _get_field_from_beams_at_particles(self, MP_e, beamtim):
Ex_n_beam, Ey_n_beam = beamtim.get_beam_eletric_field(MP_e)
if self.flag_presence_sec_beams:
for sec_beam in self.sec_beams_list:
Ex_n_secbeam, Ey_n_secbeam = sec_beam.get_beam_eletric_field(MP_e)
Ex_n_beam += Ex_n_secbeam
Ey_n_beam += Ey_n_secbeam
return Ex_n_beam, Ey_n_beam
def _get_field_from_clouds_at_particles(self, MP_e):
## Either compute electromagnetic or electrostatic fields
if self.flag_em_tracking:
(
Ex_sc_n,
Ey_sc_n,
Bx_sc_n,
By_sc_n,
Bz_sc_n,
) = self.spacech_ele.get_sc_em_field(MP_e)
else:
## Compute electron space charge electric field
Ex_sc_n, Ey_sc_n = self.spacech_ele.get_sc_eletric_field(MP_e)
Bx_sc_n = np.asarray([0.0])
By_sc_n = np.asarray([0.0])
Bz_sc_n = np.asarray([0.0])
return Ex_sc_n, Ey_sc_n, Bx_sc_n, By_sc_n, Bz_sc_n
def _apply_instantaneous_kick(self, MP_e, Ex_n_kick, Ey_n_kick, Dt_kick):
MP_e.vx_mp[: MP_e.N_mp] += Ex_n_kick * Dt_kick * MP_e.charge / MP_e.mass
MP_e.vy_mp[: MP_e.N_mp] += Ey_n_kick * Dt_kick * MP_e.charge / MP_e.mass
def _recompute_cloud_spacecharge(
self, beamtim, flag_recompute_space_charge, force_recompute_space_charge
):
for i_cloud, cloud in enumerate(self.cloud_list):
if (
(beamtim.tt_curr > self.t_sc_ON) and flag_recompute_space_charge
) or force_recompute_space_charge:
flag_reset = (
cloud is self.cloud_list[0]
) # The first cloud resets the distribution
flag_solve = (
cloud is self.cloud_list[-1]
) # The last cloud computes the fields
## Either compute electromagnetic field or electrostatic
if self.flag_em_tracking:
self.spacech_ele.recompute_spchg_emfield(
cloud.MP_e, flag_solve=flag_solve, flag_reset=flag_reset
)
else:
self.spacech_ele.recompute_spchg_efield(
cloud.MP_e, flag_solve=flag_solve, flag_reset=flag_reset
)
# Copy rho to cloud
cloud.rho = self.spacech_ele.rho - sum(
[cl.rho for cl in self.cloud_list[:i_cloud]]
)
def _cloud_motion(
self,
cloud,
beamtim,
Dt_substep_custom,
N_sub_steps_custom,
kick_mode_for_beam_field,
force_reinterp_fields_at_substeps,
):
flag_substeps = False
N_substeps_curr = 1
Dt_substep_curr = None
## Determine mode
if N_sub_steps_custom is not None:
if self.config_dict["track_method"] not in ["Boris", "BorisMultipole"]:
raise ValueError(
"""track_method should be 'Boris' or 'BorisMultipole' to use custom substeps!"""
)
# Substepping specified as an argument of sim_time_step
flag_substeps = True
N_substeps_curr = N_sub_steps_custom
Dt_substep_curr = Dt_substep_custom
elif not beamtim.flag_unif_Dt:
if self.config_dict["track_method"] not in ["Boris", "BorisMultipole"]:
raise ValueError(
"""track_method should be 'Boris' or 'BorisMultipole' to use non-uniform timestep!"""
)
# Non-uniform beam-profile
flag_substeps = True
Dt_substep_target = cloud.dynamics.Dt / cloud.dynamics.N_sub_steps
N_substeps_curr = int(np.round(beamtim.Dt_curr / Dt_substep_target))
Dt_substep_curr = beamtim.Dt_curr / N_substeps_curr
elif hasattr(cloud.dynamics, "N_sub_steps"):
# Non-unif time step is specified in the dynamics object
if cloud.dynamics.N_sub_steps is not None:
flag_substeps = True
N_substeps_curr = cloud.dynamics.N_sub_steps
Dt_substep_curr = cloud.dynamics.Dt / N_substeps_curr
# Beam kick applided here if kick-mode (mainly used in fast-ion mode)
if kick_mode_for_beam_field:
if N_sub_steps_custom is None:
raise ValueError(
"""Kick mode can be used only with custom time steps!"""
)
Ex_n_beam, Ey_n_beam = self._get_field_from_beams_at_particles(
cloud.MP_e, beamtim
)
self._apply_instantaneous_kick(
cloud.MP_e,
Ex_n_beam,
Ey_n_beam,
Dt_kick=Dt_substep_custom * N_sub_steps_custom,
)
# Decide number of substeps internal and external
if self.flag_reinterp_fields_at_substeps or force_reinterp_fields_at_substeps:
if not flag_substeps:
raise ValueError("No substeps set!")
N_substeps_external = N_substeps_curr
N_substeps_internal = 1
else:
N_substeps_external = 1
N_substeps_internal = N_substeps_curr
# print(f'external {N_substeps_external}')
# print(f'internal {N_substeps_internal}')
for i_substep in range(N_substeps_external):
## Interpolate fields from clouds at particles
(Ex_n, Ey_n, Bx_n, By_n, Bz_n,) = self._get_field_from_clouds_at_particles(
cloud.MP_e
)
## Interpolate field from beam
if not kick_mode_for_beam_field:
Ex_n_beam, Ey_n_beam = self._get_field_from_beams_at_particles(
cloud.MP_e, beamtim
)
Ex_n += Ex_n_beam
Ey_n += Ey_n_beam
if not flag_substeps:
# Standard simulation mode
cloud.MP_e = cloud.dynamics.step(
cloud.MP_e, Ex_n, Ey_n, Ez_n=0, Bx_n=Bx_n, By_n=By_n, Bz_n=Bz_n,
)
else:
# Substep mode
cloud.MP_e = cloud.dynamics.stepcustomDt(
cloud.MP_e,
Ex_n,
Ey_n,
Ez_n=0,
Bx_n=Bx_n,
By_n=By_n,
Bz_n=Bz_n,
Dt_substep=Dt_substep_curr,
N_sub_steps=N_substeps_internal,
)
def _primary_generation(self, cloud, beamtim):
## Gas ionization (main and secondary beams)
if beamtim.tt_curr < cloud.t_ion and cloud.gas_ion_flag == 1:
cloud.MP_e = cloud.resgasion.generate(
cloud.MP_e,
beamtim.lam_t_curr,
beamtim.Dt_curr,
beamtim.sigmax,
beamtim.sigmay,
x_beam_pos=beamtim.x_beam_pos,
y_beam_pos=beamtim.y_beam_pos,
)
if self.flag_presence_sec_beams:
for sec_beam in self.sec_beams_list:
cloud.MP_e = cloud.resgasion.generate(
cloud.MP_e,
sec_beam.lam_t_curr,
sec_beam.Dt_curr,
sec_beam.sigmax,
sec_beam.sigmay,
x_beam_pos=sec_beam.x_beam_pos,
y_beam_pos=sec_beam.y_beam_pos,
)
## Photoemission (main and secondary beams)
if cloud.photoem_flag != 0:
lam_curr_phem = beamtim.lam_t_curr
if self.flag_presence_sec_beams:
for sec_beam in self.sec_beams_list:
lam_curr_phem += sec_beam.lam_t_curr
cloud.phemiss.generate(cloud.MP_e, lam_curr_phem, beamtim.Dt_curr)
def _save_output_data(self, beamtim):
# We want to save and clean MP only after iteration on all clouds is completed
# (e.g. to have consistent space charge state)
for cloud in self.cloud_list:
if cloud.pyeclsaver is not None:
# if Dt_substep_custom is not None or N_sub_steps_custom is not None:
# raise ValueError('Saving with custom steps not implemented!')
cloud.impact_man = cloud.pyeclsaver.witness(
cloud.MP_e,
beamtim,
self.spacech_ele,
cloud.impact_man,
cloud.dynamics,
cloud.gas_ion_flag,
cloud.resgasion,
cloud.t_ion,
self.t_sc_ON,
cloud.photoem_flag,
cloud.phemiss,
self.flag_presence_sec_beams,
self.sec_beams_list,
self.cloud_list,
buildup_sim=self,
cross_ion=self.cross_ion,
rho_cloud=cloud.rho,
)
def _MP_cleaning_and_regenerations(self, beamtim, skip_MP_cleaning, skip_MP_regen):
for cloud in self.cloud_list:
## Every bunch passage
if beamtim.flag_new_bunch_pass:
## Clean
if not skip_MP_cleaning:
cloud.MP_e.clean_small_MPs()
if not skip_MP_regen:
## Regeneration
cloud.MP_e.check_for_regeneration()
## Soft regeneration
cloud.MP_e.check_for_soft_regeneration()
cloud.MP_e.check_for_async_regeneration()
def load_state(
self,
filename_simulation_state,
force_disable_save_simulation_state=True,
filen_main_outp="Pyecltest_restarted",
load_from_folder="./",
): # , reset_pyeclsaver = True):
with open(load_from_folder + filename_simulation_state, "rb") as fid:
dict_state = pickle.load(fid)
self.beamtim = dict_state["beamtim"]
self.spacech_ele = dict_state["spacech_ele"]
self.t_sc_ON = dict_state["t_sc_ON"]
self.flag_presence_sec_beams = dict_state["flag_presence_sec_beams"]
self.sec_beams_list = dict_state["sec_beams_list"]
self.flag_multiple_clouds = dict_state["flag_multiple_clouds"]
for i_cloud, new_cloud in enumerate(self.cloud_list):
new_pyeclsaver = new_cloud.pyeclsaver
self.cloud_list[i_cloud] = dict_state["cloud_list"][
i_cloud
] # Replace new_cloud with saved cloud
cloud = self.cloud_list[i_cloud]
# if reset_pyeclsaver or cloud.pyeclsaver is None:
cloud.pyeclsaver = new_pyeclsaver
if force_disable_save_simulation_state:
cloud.pyeclsaver.flag_save_simulation_state = False
if filen_main_outp is not None:
filen_outp_ext = filen_main_outp.split("Pyecltest")[-1]
filen_outp_root = cloud.pyeclsaver.filen_main_outp.split(".mat")[0]
cloud.pyeclsaver.filen_main_outp = (
filen_outp_root + filen_outp_ext + ".mat"
)
print("Restoring PyPIC LU object...")
self.spacech_ele.PyPICobj.build_sparse_solver()
if self.spacech_ele.flag_em_tracking:
print("Restoring PyPIC Ax, Ay and As state objects...")
self.spacech_ele.state_Ax = self.spacech_ele.PyPICobj.get_state_object()
self.spacech_ele.state_Ay = self.spacech_ele.PyPICobj.get_state_object()
self.spacech_ele.state_As = self.spacech_ele.PyPICobj.get_state_object()
print("Done reload.")
return dict_state
def load_checkpoint(self, filename_simulation_checkpoint, load_from_folder="./"):
print(
(
"Reloading from checkpoint: %s..."
% (load_from_folder + filename_simulation_checkpoint)
)
)
i_checkp = int(filename_simulation_checkpoint.split(".pkl")[0].split("_")[-1])
dict_state = self.load_state(
filename_simulation_checkpoint,
force_disable_save_simulation_state=False,
filen_main_outp=None,
load_from_folder=load_from_folder,
)
for cloud in self.cloud_list:
cloud.pyeclsaver.load_from_output(last_t=self.beamtim.tt_curr)
cloud.pyeclsaver.i_checkp = i_checkp + 1
cloud.pyeclsaver.t_last_checkp = self.beamtim.tt_curr
cloud.pyeclsaver.t_last_En_hist = dict_state["t_last_En_hist"]