Skip to content

Computer

Computer

Bases: ABC

particle_interaction abstractmethod staticmethod

Perform particle interaction calculations on the GPU.

Parameters:

Name Type Description Default
lmax int

Maximum angular momentum quantum number.

 required
particle_number int

Number of particles.

 required
idx ndarray

Array containing particle indices.

 required
x ndarray

Array of particle positions.

 required
wx_real ndarray

Array to store the real part of the result.

 required
wx_imag ndarray

Array to store the imaginary part of the result.

 required
translation_table ndarray

Array containing translation table.

 required
plm ndarray

Array containing associated Legendre polynomials.

 required
sph_h ndarray

Array containing spherical harmonics.

 required
e_j_dm_phi ndarray

Additional parameter for the calculation.

 required
Todo

Implement data batching for GPUs with smaller memory

Source code in yasfpy/computers/computer.py 
 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
@abstractmethod
@staticmethod
def particle_interaction(
    lmax: int,
    particle_number: int,
    idx: np.ndarray,
    x: np.ndarray,
    wx_real: np.ndarray,
    wx_imag: np.ndarray,
    translation_table: np.ndarray,
    plm: np.ndarray,
    sph_h: np.ndarray,
    e_j_dm_phi,
):
    """
    Perform particle interaction calculations on the GPU.

    Args:
        lmax (int): Maximum angular momentum quantum number.
        particle_number (int): Number of particles.
        idx (np.ndarray): Array containing particle indices.
        x (np.ndarray): Array of particle positions.
        wx_real (np.ndarray): Array to store the real part of the result.
        wx_imag (np.ndarray): Array to store the imaginary part of the result.
        translation_table (np.ndarray): Array containing translation table.
        plm (np.ndarray): Array containing associated Legendre polynomials.
        sph_h (np.ndarray): Array containing spherical harmonics.
        e_j_dm_phi (np.ndarray): Additional parameter for the calculation.

    Todo:
        Implement data batching for GPUs with smaller memory
    """
    return

compute_scattering_cross_section abstractmethod staticmethod

Compute the scattering cross section on the GPU using CUDA.

Parameters:

Name Type Description Default
lmax int

The maximum degree of the spherical harmonics expansion.

 required
particle_number int

The number of particles.

 required
idx ndarray

The index array.

 required
sfc ndarray

The scattering form factor array.

 required
translation_table ndarray

The translation table array.

 required
plm ndarray

The associated Legendre polynomials array.

 required
sph_h ndarray

The spherical harmonics array.

 required
e_j_dm_phi ndarray

The phase factor array.

 required
c_sca_real ndarray

The real part of the scattering cross section array.

 required
c_sca_imag ndarray

The imaginary part of the scattering cross section array.

 required
Source code in yasfpy/computers/computer.py 
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
@abstractmethod
@staticmethod
def compute_scattering_cross_section(
    lmax: int,
    particle_number: int,
    idx: np.ndarray,
    sfc: np.ndarray,
    translation_table: np.ndarray,
    plm: np.ndarray,
    sph_h: np.ndarray,
    e_j_dm_phi: np.ndarray,
    c_sca_real: np.ndarray,
    c_sca_imag: np.ndarray,
):
    """
    Compute the scattering cross section on the GPU using CUDA.

    Args:
        lmax (int): The maximum degree of the spherical harmonics expansion.
        particle_number (int): The number of particles.
        idx (np.ndarray): The index array.
        sfc (np.ndarray): The scattering form factor array.
        translation_table (np.ndarray): The translation table array.
        plm (np.ndarray): The associated Legendre polynomials array.
        sph_h (np.ndarray): The spherical harmonics array.
        e_j_dm_phi (np.ndarray): The phase factor array.
        c_sca_real (np.ndarray): The real part of the scattering cross section array.
        c_sca_imag (np.ndarray): The imaginary part of the scattering cross section array.
    """
    return

compute_radial_independent_scattered_field abstractmethod staticmethod

Compute the radial independent scattered field using GPU acceleration.

Parameters:

Name Type Description Default
lmax int

The maximum degree of the spherical harmonics expansion.

 required
particles_position ndarray

Array of particle positions.

 required
idx ndarray

Array of indices for particle properties.

 required
sfc ndarray

Array of scattering form factors.

 required
k_medium ndarray

Array of wave numbers in the medium.

 required
azimuthal_angles ndarray

Array of azimuthal angles.

 required
e_r ndarray

Array of radial electric field components.

 required
e_phi ndarray

Array of azimuthal electric field components.

 required
e_theta ndarray

Array of polar electric field components.

 required
pilm ndarray

Array of associated Legendre polynomials.

 required
taulm ndarray

Array of tau coefficients.

 required
e_1_sca_real ndarray

Array of real parts of the scattered electric field.

 required
e_1_sca_imag ndarray

Array of imaginary parts of the scattered electric field.

 required
Source code in yasfpy/computers/computer.py 
 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
@abstractmethod
@staticmethod
def compute_radial_independent_scattered_field(
    lmax: int,
    particles_position: np.ndarray,
    idx: np.ndarray,
    sfc: np.ndarray,
    k_medium: np.ndarray,
    azimuthal_angles: np.ndarray,
    e_r: np.ndarray,
    e_phi: np.ndarray,
    e_theta: np.ndarray,
    pilm: np.ndarray,
    taulm: np.ndarray,
    e_1_sca_real: np.ndarray,
    e_1_sca_imag: np.ndarray,
):
    """
    Compute the radial independent scattered field using GPU acceleration.

    Args:
        lmax (int): The maximum degree of the spherical harmonics expansion.
        particles_position (np.ndarray): Array of particle positions.
        idx (np.ndarray): Array of indices for particle properties.
        sfc (np.ndarray): Array of scattering form factors.
        k_medium (np.ndarray): Array of wave numbers in the medium.
        azimuthal_angles (np.ndarray): Array of azimuthal angles.
        e_r (np.ndarray): Array of radial electric field components.
        e_phi (np.ndarray): Array of azimuthal electric field components.
        e_theta (np.ndarray): Array of polar electric field components.
        pilm (np.ndarray): Array of associated Legendre polynomials.
        taulm (np.ndarray): Array of tau coefficients.
        e_1_sca_real (np.ndarray): Array of real parts of the scattered electric field.
        e_1_sca_imag (np.ndarray): Array of imaginary parts of the scattered electric field.
    """
    return

compute_electric_field_angle_components abstractmethod staticmethod

Compute the electric field angle components on the GPU.

Parameters:

Name Type Description Default
lmax int

The maximum angular momentum quantum number.

 required
particles_position ndarray

Array of particle positions.

 required
idx ndarray

Array of indices.

 required
sfc ndarray

Array of scattering form factors.

 required
k_medium ndarray

Array of medium wavevectors.

 required
azimuthal_angles ndarray

Array of azimuthal angles.

 required
e_r ndarray

Array of radial unit vectors.

 required
pilm ndarray

Array of associated Legendre polynomials.

 required
taulm ndarray

Array of tau coefficients.

 required
e_field_theta_real ndarray

Array of real parts of electric field theta component.

 required
e_field_theta_imag ndarray

Array of imaginary parts of electric field theta component.

 required
e_field_phi_real ndarray

Array of real parts of electric field phi component.

 required
e_field_phi_imag ndarray

Array of imaginary parts of electric field phi component.

 required
Source code in yasfpy/computers/computer.py 
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
@abstractmethod
@staticmethod
def compute_electric_field_angle_components(
    lmax: int,
    particles_position: np.ndarray,
    idx: np.ndarray,
    sfc: np.ndarray,
    k_medium: np.ndarray,
    azimuthal_angles: np.ndarray,
    e_r: np.ndarray,
    pilm: np.ndarray,
    taulm: np.ndarray,
    e_field_theta_real: np.ndarray,
    e_field_theta_imag: np.ndarray,
    e_field_phi_real: np.ndarray,
    e_field_phi_imag: np.ndarray,
):
    """
    Compute the electric field angle components on the GPU.

    Args:
        lmax (int): The maximum angular momentum quantum number.
        particles_position (np.ndarray): Array of particle positions.
        idx (np.ndarray): Array of indices.
        sfc (np.ndarray): Array of scattering form factors.
        k_medium (np.ndarray): Array of medium wavevectors.
        azimuthal_angles (np.ndarray): Array of azimuthal angles.
        e_r (np.ndarray): Array of radial unit vectors.
        pilm (np.ndarray): Array of associated Legendre polynomials.
        taulm (np.ndarray): Array of tau coefficients.
        e_field_theta_real (np.ndarray): Array of real parts of electric field theta component.
        e_field_theta_imag (np.ndarray): Array of imaginary parts of electric field theta component.
        e_field_phi_real (np.ndarray): Array of real parts of electric field phi component.
        e_field_phi_imag (np.ndarray): Array of imaginary parts of electric field phi component.
    """
    return

compute_polarization_components abstractmethod staticmethod

Compute the polarization components using GPU acceleration.

Parameters:

Name Type Description Default
number_of_wavelengths int

Number of wavelengths.

 required
number_of_angles int

Number of angles.

 required
e_field_theta_real ndarray

Real part of the electric field in the theta direction.

 required
e_field_theta_imag ndarray

Imaginary part of the electric field in the theta direction.

 required
e_field_phi_real ndarray

Real part of the electric field in the phi direction.

 required
e_field_phi_imag ndarray

Imaginary part of the electric field in the phi direction.

 required
intensity ndarray

Array to store the intensity component.

 required
degree_of_polarization ndarray

Array to store the degree of polarization component.

 required
degree_of_linear_polarization ndarray

Array to store the degree of linear polarization component.

 required
degree_of_linear_polarization_q ndarray

Array to store the degree of linear polarization (Q) component.

 required
degree_of_linear_polarization_u ndarray

Array to store the degree of linear polarization (U) component.

 required
degree_of_circular_polarization ndarray

Array to store the degree of circular polarization component.

 required
Source code in yasfpy/computers/computer.py 
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
@abstractmethod
@staticmethod
def compute_polarization_components(
    number_of_wavelengths: int,
    number_of_angles: int,
    e_field_theta_real: np.ndarray,
    e_field_theta_imag: np.ndarray,
    e_field_phi_real: np.ndarray,
    e_field_phi_imag: np.ndarray,
    intensity: np.ndarray,
    degree_of_polarization: np.ndarray,
    degree_of_linear_polarization: np.ndarray,
    degree_of_linear_polarization_q: np.ndarray,
    degree_of_linear_polarization_u: np.ndarray,
    degree_of_circular_polarization: np.ndarray,
):
    """
    Compute the polarization components using GPU acceleration.

    Args:
        number_of_wavelengths (int): Number of wavelengths.
        number_of_angles (int): Number of angles.
        e_field_theta_real (np.ndarray): Real part of the electric field in the theta direction.
        e_field_theta_imag (np.ndarray): Imaginary part of the electric field in the theta direction.
        e_field_phi_real (np.ndarray): Real part of the electric field in the phi direction.
        e_field_phi_imag (np.ndarray): Imaginary part of the electric field in the phi direction.
        intensity (np.ndarray): Array to store the intensity component.
        degree_of_polarization (np.ndarray): Array to store the degree of polarization component.
        degree_of_linear_polarization (np.ndarray): Array to store the degree of linear polarization component.
        degree_of_linear_polarization_q (np.ndarray): Array to store the degree of linear polarization (Q) component.
        degree_of_linear_polarization_u (np.ndarray): Array to store the degree of linear polarization (U) component.
        degree_of_circular_polarization (np.ndarray): Array to store the degree of circular polarization component.
    """
    return

compute_field abstractmethod staticmethod

Compute the field on the GPU using CUDA.

Parameters:

Name Type Description Default
lmax int

Maximum degree of the spherical harmonics.

 required
idx ndarray

Array of indices.

 required
size_parameter ndarray

Array of size parameters.

 required
sph_h ndarray

Array of spherical harmonics.

 required
derivative ndarray

Array of derivatives.

 required
e_j_dm_phi ndarray

Array of phi-dependent terms.

 required
p_lm ndarray

Array of Legendre polynomials.

 required
pi_lm ndarray

Array of pi-dependent terms.

 required
tau_lm ndarray

Array of tau-dependent terms.

 required
e_r ndarray

Array of r-dependent terms.

 required
e_theta ndarray

Array of theta-dependent terms.

 required
e_phi ndarray

Array of phi-dependent terms.

 required
scattered_field_coefficients ndarray

Array of scattered field coefficients.

 required
field_real ndarray

Array to store the real part of the field.

 required
field_imag ndarray

Array to store the imaginary part of the field.

 required
Source code in yasfpy/computers/computer.py 
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
@abstractmethod
@staticmethod
def compute_field(
    lmax: int,
    idx: np.ndarray,
    size_parameter: np.ndarray,
    sph_h: np.ndarray,
    derivative: np.ndarray,
    e_j_dm_phi: np.ndarray,
    p_lm: np.ndarray,
    pi_lm: np.ndarray,
    tau_lm: np.ndarray,
    e_r: np.ndarray,
    e_theta: np.ndarray,
    e_phi: np.ndarray,
    scattered_field_coefficients: np.ndarray,
    field_real: np.ndarray,
    field_imag: np.ndarray,
):  # , initial_field_coefficients: np.ndarray, scatter_to_internal: np.ndarray):
    """
    Compute the field on the GPU using CUDA.

    Args:
        lmax (int): Maximum degree of the spherical harmonics.
        idx (np.ndarray): Array of indices.
        size_parameter (np.ndarray): Array of size parameters.
        sph_h (np.ndarray): Array of spherical harmonics.
        derivative (np.ndarray): Array of derivatives.
        e_j_dm_phi (np.ndarray): Array of phi-dependent terms.
        p_lm (np.ndarray): Array of Legendre polynomials.
        pi_lm (np.ndarray): Array of pi-dependent terms.
        tau_lm (np.ndarray): Array of tau-dependent terms.
        e_r (np.ndarray): Array of r-dependent terms.
        e_theta (np.ndarray): Array of theta-dependent terms.
        e_phi (np.ndarray): Array of phi-dependent terms.
        scattered_field_coefficients (np.ndarray): Array of scattered field coefficients.
        field_real (np.ndarray): Array to store the real part of the field.
        field_imag (np.ndarray): Array to store the imaginary part of the field.
    """
    return

Comments