epicf/ParticleSourceTube.py at master · dumbman/epicf · GitHub

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
from math import sqrt, copysign
import numpy as np

from Vec3d import Vec3d
from ParticleSource import ParticleSource

# Tube source

class ParticleSourceTube(ParticleSource):

    def __init__(self):
        super().__init__()
        self.axis_start_x = None
        self.axis_start_y = None
        self.axis_start_z = None
        self.axis_end_x = None
        self.axis_end_y = None
        self.axis_end_z = None
        self.inner_radius = None
        self.outer_radius = None


    @classmethod
    def init_from_config(cls, conf, this_source_config_part, sec_name):
        new_obj = cls()
        new_obj.read_particles_and_source_pars_from_config(
            conf, this_source_config_part, sec_name)
        new_obj.geometry_type = "tube"
        new_obj.check_correctness_of_tube_config_fields(
            conf, this_source_config_part)
        new_obj.set_tube_parameters_from_config(this_source_config_part)
        new_obj.generate_initial_particles()
        return new_obj


    @classmethod
    def init_from_h5(cls, h5group):
        new_obj = cls()
        new_obj.read_particles_and_source_pars_from_h5(h5group)
        new_obj.geometry_type = "tube"
        new_obj.read_hdf5_tube_parameters(h5group)
        return new_obj


    def check_correctness_of_tube_config_fields(self, conf, this_source_config_part):
        # todo:
        self.inner_radius_gt_zero(conf, this_source_config_part)
        self.outer_radius_gt_inner_radius(conf, this_source_config_part)
        self.axis_start_x_min_rad_ge_zero(conf, this_source_config_part)
        self.axis_start_x_plus_rad_le_grid_x_size(conf, this_source_config_part)
        self.axis_start_y_min_rad_ge_zero(conf, this_source_config_part)
        self.axis_start_y_plus_rad_le_grid_y_size(conf, this_source_config_part)
        self.axis_start_z_min_rad_ge_zero(conf, this_source_config_part)
        self.axis_start_z_plus_rad_le_grid_z_size(conf, this_source_config_part)
        self.axis_end_x_min_rad_ge_zero(conf, this_source_config_part)
        self.axis_end_x_plus_rad_le_grid_x_size(conf, this_source_config_part)
        self.axis_end_y_min_rad_ge_zero(conf, this_source_config_part)
        self.axis_end_y_plus_rad_le_grid_y_size(conf, this_source_config_part)
        self.axis_end_z_min_rad_ge_zero(conf, this_source_config_part)
        self.axis_end_z_plus_rad_le_grid_z_size(conf, this_source_config_part)


    def set_tube_parameters_from_config(self, this_source_config_part):
        self.axis_start_x = this_source_config_part.getfloat("tube_axis_start_x")
        self.axis_start_y = this_source_config_part.getfloat("tube_axis_start_y")
        self.axis_start_z = this_source_config_part.getfloat("tube_axis_start_z")
        self.axis_end_x = this_source_config_part.getfloat("tube_axis_end_x")
        self.axis_end_y = this_source_config_part.getfloat("tube_axis_end_y")
        self.axis_end_z = this_source_config_part.getfloat("tube_axis_end_z")
        self.inner_radius = this_source_config_part.getfloat("tube_inner_radius")
        self.outer_radius = this_source_config_part.getfloat("tube_outer_radius")


    def read_hdf5_tube_parameters(self, this_source_h5_group):
        self.axis_start_x = this_source_h5_group.attrs["tube_axis_start_x"]
        self.axis_start_y = this_source_h5_group.attrs["tube_axis_start_y"]
        self.axis_start_z = this_source_h5_group.attrs["tube_axis_start_z"]
        self.axis_end_x = this_source_h5_group.attrs["tube_axis_end_x"]
        self.axis_end_y = this_source_h5_group.attrs["tube_axis_end_y"]
        self.axis_end_z = this_source_h5_group.attrs["tube_axis_end_z"]
        self.inner_radius = this_source_h5_group.attrs["tube_inner_radius"]
        self.outer_radius = this_source_h5_group.attrs["tube_outer_radius"]


    def inner_radius_gt_zero(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_inner_radius") <= 0:
            raise ValueError("inner_radius = {};"
                             "Expect tube_inner_radius > 0".format(self.inner_radius))


    def outer_radius_gt_inner_radius(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_outer_radius") <= \
           this_source_config_part.getfloat("tube_inner_radius"):
            raise ValueError("inner_radius = {}; outer_radius = {};"
                             "Expect outer_radius > inner_radius".format(
                                 self.inner_radius, self.outer_radius))


    def axis_start_x_min_rad_ge_zero(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_start_x") - \
           this_source_config_part.getfloat("tube_outer_radius") < 0:
            raise ValueError("tube_axis_start_x - tube_outer_radius < 0")


    def axis_start_x_plus_rad_le_grid_x_size(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_start_x") + \
           this_source_config_part.getfloat("tube_outer_radius") > \
           conf["SpatialMesh"].getfloat("grid_x_size"):
            raise ValueError("tube_axis_start_x + tube_outer_radius > grid_x_size")


    def axis_start_y_min_rad_ge_zero(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_start_y") - \
           this_source_config_part.getfloat("tube_outer_radius") < 0:
            raise ValueError("tube_axis_start_y - tube_outer_radius < 0")


    def axis_start_y_plus_rad_le_grid_y_size(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_start_y") + \
           this_source_config_part.getfloat("tube_outer_radius") > \
           conf["SpatialMesh"].getfloat("grid_y_size"):
            raise ValueError("tube_axis_start_y + tube_outer_radius > grid_y_size")


    def axis_start_z_min_rad_ge_zero(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_start_z") - \
           this_source_config_part.getfloat("tube_outer_radius") < 0:
            raise ValueError("tube_axis_start_z - tube_outer_radius < 0")


    def axis_start_z_plus_rad_le_grid_z_size(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_start_z") + \
           this_source_config_part.getfloat("tube_outer_radius") > \
           conf["SpatialMesh"].getfloat("grid_z_size"):
            raise ValueError("tube_axis_start_z + tube_outer_radius > grid_z_size")


    def axis_end_x_min_rad_ge_zero(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_end_x") - \
           this_source_config_part.getfloat("tube_outer_radius") < 0:
            raise ValueError("tube_axis_end_x - tube_outer_radius < 0")


    def axis_end_x_plus_rad_le_grid_x_size(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_end_x") + \
           this_source_config_part.getfloat("tube_outer_radius") >\
           conf["SpatialMesh"].getfloat("grid_x_size"):
            raise ValueError ("tube_axis_end_x + tube_outer_radius > grid_x_size")


    def axis_end_y_min_rad_ge_zero(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_end_y") - \
           this_source_config_part.getfloat("tube_outer_radius") < 0:
            raise ValueError("tube_axis_end_y - tube_outer_radius < 0")


    def axis_end_y_plus_rad_le_grid_y_size(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_end_y") + \
           this_source_config_part.getfloat("tube_outer_radius") > \
           conf["SpatialMesh"].getfloat("grid_y_size"):
            raise ValueError("tube_axis_end_y + tube_outer_radius > grid_y_size")


    def axis_end_z_min_rad_ge_zero(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_end_z") - \
           this_source_config_part.getfloat("tube_outer_radius") < 0:
            raise ValueError("tube_axis_end_z - tube_outer_radius < 0")


    def axis_end_z_plus_rad_le_grid_z_size(self, conf, this_source_config_part):
        if this_source_config_part.getfloat("tube_axis_end_z") + \
           this_source_config_part.getfloat("tube_outer_radius") > \
           conf["SpatialMesh"].getfloat("grid_z_size"):
            raise ValueError("tube_axis_end_z + tube_outer_radius > grid_z_size")


    def write_hdf5_source_parameters(self, this_source_h5_group):
        super().write_hdf5_source_parameters(this_source_h5_group)
        this_source_h5_group.attrs.create("tube_axis_start_x", self.axis_start_x)
        this_source_h5_group.attrs.create("tube_axis_start_y", self.axis_start_y)
        this_source_h5_group.attrs.create("tube_axis_start_z", self.axis_start_z)
        this_source_h5_group.attrs.create("tube_axis_end_x", self.axis_end_x)
        this_source_h5_group.attrs.create("tube_axis_end_y", self.axis_end_y)
        this_source_h5_group.attrs.create("tube_axis_end_z", self.axis_end_z)
        this_source_h5_group.attrs.create("tube_inner_radius", self.inner_radius)
        this_source_h5_group.attrs.create("tube_outer_radius", self.outer_radius)


    def uniform_position_in_source(self):
        return self.uniform_position_in_tube()


    def uniform_position_in_tube(self):
        # random point in tube along z
        cyl_axis = Vec3d((self.axis_end_x - self.axis_start_x),
                         (self.axis_end_y - self.axis_start_y),
                         (self.axis_end_z - self.axis_start_z))
        cyl_axis_length = cyl_axis.length()
        r = sqrt(self.random_in_range(self.inner_radius / self.outer_radius, 1.0)) \
            * self.outer_radius
        phi = self.random_in_range(0.0, 2.0 * np.pi)
        z = self.random_in_range(0.0, cyl_axis_length)
        #
        x = r * np.cos(phi)
        y = r * np.sin(phi)
        z = z
        random_pnt_in_cyl_along_z = Vec3d(x, y, z)
        # rotate:
        # see "https://en.wikipedia.org/wiki/Rodrigues'_rotation_formula"
        # todo: Too complicated. Try rejection sampling.
        unit_cyl_axis = cyl_axis.normalized()
        unit_along_z = Vec3d(0, 0, 1.0)
        rotation_axis = unit_along_z.cross_product(unit_cyl_axis)
        rotation_axis_length = rotation_axis.length()
        if rotation_axis_length == 0:
            if copysign(1.0, unit_cyl_axis.z) >= 0:
                random_pnt_in_rotated_cyl = random_pnt_in_cyl_along_z
            else:
                random_pnt_in_rotated_cyl = random_pnt_in_cyl_along_z.negate()
        else:
            unit_rotation_axis = rotation_axis.normalized()
            rot_cos = unit_cyl_axis.dot_product(unit_along_z)
            rot_sin = rotation_axis_length
            random_pnt_in_rotated_cyl = \
                random_pnt_in_cyl_along_z.times_scalar(rot_cos) + \
                unit_rotation_axis.cross_product(random_pnt_in_cyl_along_z) * rot_sin + \
                unit_rotation_axis.times_scalar(\
                    (1 - rot_cos) * \
                    unit_rotation_axis.dot_product(random_pnt_in_cyl_along_z))
        # shift:
        shifted = random_pnt_in_rotated_cyl.add(
            Vec3d(self.axis_start_x,
                  self.axis_start_y,
                  self.axis_start_z))
        return shifted


    @classmethod
    def is_tube_source(cls, conf_sec_name):
        return 'ParticleSourceTube' in conf_sec_name