-
Notifications
You must be signed in to change notification settings - Fork 306
/
particle_collections.py
562 lines (459 loc) · 17.8 KB
/
particle_collections.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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
"""Collections of particle objects."""
__all__ = ["ParticleList", "ParticleListLike"]
import astropy.units as u
import collections
import contextlib
import numpy as np
from collections.abc import Iterable, Sequence
from typing import Callable, Optional, Union
from plasmapy.particles.exceptions import InvalidParticleError
from plasmapy.particles.particle_class import (
CustomParticle,
DimensionlessParticle,
Particle,
ParticleLike,
)
class ParticleList(collections.UserList):
"""
A `list` like collection of |Particle| and |CustomParticle| objects.
Parameters
----------
particles : iterable of |particle-like|, optional
An iterable that provides a sequence of |particle-like| objects.
Objects that are not a |Particle| or |CustomParticle| will be
cast into a |Particle| or |CustomParticle|. If not provided, an
empty |ParticleList| will be created.
Raises
------
`~plasmapy.particles.exceptions.InvalidParticleError`
If an object supplied to |ParticleList| is not |particle-like|.
TypeError
If a `~plasmapy.particles.particle_class.DimensionlessParticle`
is provided.
See Also
--------
~plasmapy.particles.particle_class.CustomParticle
~plasmapy.particles.particle_class.Particle
Examples
--------
A |ParticleList| can be created by calling it with an iterable like
a `list` or `tuple` that provides |particle-like| objects.
>>> from plasmapy.particles import ParticleList
>>> particle_list = ParticleList(["e-", "e+"])
>>> particle_list[0]
Particle("e-")
Attributes such as
`~plasmapy.particles.particle_collections.ParticleList.mass`
and `~plasmapy.particles.particle_collections.ParticleList.charge`
will return a `~astropy.units.Quantity` array containing the values
of the corresponding attribute for each particle in the
|ParticleList|.
>>> particle_list.mass
<Quantity [9.1093...e-31, 9.1093...e-31] kg>
>>> particle_list.charge
<Quantity [-1.60217663e-19, 1.60217663e-19] C>
>>> particle_list.symbols
['e-', 'e+']
|ParticleList| instances can also be created through addition and
multiplication with |Particle|, |CustomParticle|, and |ParticleList|
instances.
>>> from plasmapy.particles import Particle, CustomParticle
>>> import astropy.units as u
>>> proton = Particle("p+")
>>> custom_particle = CustomParticle(mass=1e-26*u.kg, charge=6e-19*u.C)
>>> 2 * proton + custom_particle
ParticleList(['p+', 'p+', 'CustomParticle(mass=1e-26 kg, charge=6e-19 C)'])
These operations may also be performed using |particle-like| objects.
>>> particle_list + "deuteron"
ParticleList(['e-', 'e+', 'D 1+'])
Normal `list` methods may also be used on |ParticleList| objects.
When a |particle-like| object is appended to a |ParticleList|, that
object will be cast into a |Particle| or |CustomParticle|.
>>> noble_gases = ParticleList(["He", "Ar", "Kr", "Xe", "Rn"])
>>> noble_gases.append("Og")
>>> noble_gases[-1]
Particle("Og")
The ``>`` operator may be used with |Particle| and |ParticleList|
instances to access the nuclear reaction energy.
>>> reactants = ParticleList(["deuterium", "tritium"])
>>> products = ParticleList(["alpha", "neutron"])
>>> energy = reactants > products
>>> energy.to("MeV")
<Quantity 17.58925... MeV>
"""
@staticmethod
def _list_of_particles_and_custom_particles(
particles: Optional[Iterable[ParticleLike]],
) -> list[Union[Particle, CustomParticle]]:
"""
Convert an iterable that provides |particle-like| objects into a
`list` containing |Particle| and |CustomParticle| instances.
"""
if isinstance(particles, str):
raise TypeError(
"ParticleList does not accept strings, but does accept "
"lists and tuples containing strings. Did you mean to "
f"do `ParticleList([{particles!r}])` instead?"
)
new_particles = []
if particles is None:
return new_particles
for obj in particles:
if isinstance(obj, (Particle, CustomParticle)):
new_particles.append(obj)
elif isinstance(obj, DimensionlessParticle):
raise TypeError(
"ParticleList instances cannot include dimensionless particles."
)
else:
try:
new_particles.append(Particle(obj))
except (TypeError, InvalidParticleError) as exc:
raise InvalidParticleError(
f"The object {obj} supplied to ParticleList is not a "
f"particle-like object."
) from exc
return new_particles
def __init__(self, particles: Optional[Iterable] = None):
self._data = self._list_of_particles_and_custom_particles(particles)
@staticmethod
def _cast_other_as_particle_list(other):
if isinstance(other, ParticleList):
return other
with contextlib.suppress(TypeError, InvalidParticleError):
return ParticleList(other)
try:
return ParticleList([other])
except (InvalidParticleError, TypeError) as ex:
raise InvalidParticleError(
f"Cannot cast {other} into a ParticleList"
) from ex
def __add__(self, other):
try:
other_as_particle_list = self._cast_other_as_particle_list(other)
except (TypeError, InvalidParticleError) as exc:
raise InvalidParticleError(
f"Cannot add {other!r} to a ParticleList."
) from exc
return ParticleList(self.data + other_as_particle_list.data)
def __radd__(self, other):
other_as_particle_list = self._cast_other_as_particle_list(other)
return other_as_particle_list.__add__(self)
def __repr__(self):
return f"ParticleList({self.symbols!r})"
def __gt__(self, other):
from plasmapy.particles.nuclear import nuclear_reaction_energy
other_as_particle_list = self._cast_other_as_particle_list(other)
return nuclear_reaction_energy(
reactants=self.symbols, products=other_as_particle_list.symbols
)
def __str__(self):
return self.__repr__()
def _get_particle_attribute(self, attr, unit=None, default=None):
"""
Get the values of a particular attribute from all of the particles.
If a ``unit`` is provided, then this function will return a
`~astropy.units.Quantity` array with that unit.
"""
values = [getattr(particle, attr, default) for particle in self.data]
if unit:
values = u.Quantity(values)
return values
def append(self, particle: ParticleLike):
"""Append a particle to the end of the |ParticleList|."""
# TODO: use particle_input when it works with CustomParticle and ParticleLike
if not isinstance(particle, (Particle, CustomParticle)):
particle = Particle(particle)
self.data.append(particle)
@property
def charge(self) -> u.C:
"""
The electric charges of the particles.
Returns
-------
`~astropy.units.Quantity`
"""
return self._get_particle_attribute("charge", unit=u.C, default=np.nan * u.C)
@property
def data(self) -> list[Union[Particle, CustomParticle]]:
"""
A `list` containing the particles contained in the
|ParticleList| instance.
.. important::
This attribute should not be modified directly.
Returns
-------
`list` of |Particle| or |CustomParticle|
"""
return self._data
def extend(self, iterable: Iterable[ParticleLike]):
"""
Extend the sequence by appending |particle-like| elements from
``iterable``.
See Also
--------
list.extend
"""
if isinstance(iterable, ParticleList):
self.data.extend(iterable)
else:
for obj in iterable:
self.append(obj)
@property
def half_life(self) -> u.s:
"""
The half-lives of the particles.
Returns
-------
`~astropy.units.Quantity`
"""
return self._get_particle_attribute("half_life", unit=u.s, default=np.nan * u.s)
def insert(self, index, particle: ParticleLike):
"""Insert a particle before an index."""
# TODO: use particle_input when it works with CustomParticle and ParticleLike
if not isinstance(particle, (Particle, CustomParticle)):
particle = Particle(particle)
self.data.insert(index, particle)
def is_category(
self,
*category_tuple,
require: Union[str, Iterable[str]] = None,
any_of: Union[str, Iterable[str]] = None,
exclude: Union[str, Iterable[str]] = None,
) -> list[bool]:
"""
Determine element-wise if the particles in the |ParticleList|
meet categorization criteria.
Return a `list` in which each element will be `True` if the
corresponding particle is consistent with the categorization
criteria, and `False` otherwise.
Please refer to the documentation of
`~plasmapy.particles.particle_class.Particle.is_category`
for information on the parameters and categories, as well as
more extensive examples.
Returns
-------
`list` of `bool`
Examples
--------
>>> particles = ParticleList(["proton", "electron", "tau neutrino"])
>>> particles.is_category("lepton")
[False, True, True]
>>> particles.is_category(require="lepton", exclude="neutrino")
[False, True, False]
>>> particles.is_category(any_of=["lepton", "charged"])
[True, True, True]
"""
return [
particle.is_category(
*category_tuple,
require=require,
any_of=any_of,
exclude=exclude,
)
for particle in self
]
@property
def charge_number(self) -> np.array:
"""
The charges of the particles in units of the elementary
charge.
Returns
-------
|ndarray|
"""
return np.array(self._get_particle_attribute("charge_number", default=np.nan))
@property
def mass(self) -> u.kg:
"""
The masses of the particles.
Returns
-------
`~astropy.units.Quantity`
"""
return self._get_particle_attribute("mass", unit=u.kg, default=np.nan * u.J)
@property
def mass_energy(self) -> u.J:
"""
The mass energies of the particles.
If the particle is an isotope or nuclide, return the mass energy
of the nucleus only.
Returns
-------
`~astropy.units.Quantity`
"""
return self._get_particle_attribute(
"mass_energy",
unit=u.J,
default=np.nan * u.J,
)
def sort(self, key: Callable = None, reverse: bool = False):
"""
Sort the |ParticleList| in-place.
Parameters
----------
key : callable
A function that accepts one argument that is used to extract
a comparison key for each item in the |ParticleList|.
reverse : `bool`, default: `False`
If `True`, the items in the |ParticleList| are sorted as if
each comparison were reversed.
Raises
------
TypeError
If ``key`` is not provided.
See Also
--------
list.sort
sorted
Examples
--------
To sort a |ParticleList| by atomic number, set ``key`` to
|atomic_number|.
>>> from plasmapy.particles import ParticleList, atomic_number
>>> elements = ParticleList(["Li", "H", "He"])
>>> elements.sort(key=atomic_number)
>>> print(elements)
ParticleList(['H', 'He', 'Li'])
We can also create a function to pass to ``key``. In this
example, we sort first by atomic number and second by mass
number using different attributes of |Particle|.
>>> def sort_key(isotope):
... return isotope.atomic_number, isotope.mass_number
>>> isotopes = ParticleList(["He-3", "T", "H-1", "He-4", "D"])
>>> isotopes.sort(key=sort_key)
>>> print(isotopes)
ParticleList(['H-1', 'D', 'T', 'He-3', 'He-4'])
"""
if key is None:
raise TypeError("Unable to sort a ParticleList without a key.")
super().sort(key=key, reverse=reverse)
@property
def symbols(self) -> list[str]:
"""
A `list` of the symbols of the particles.
Returns
-------
`list` of `str`
"""
return self._get_particle_attribute("symbol")
def average_particle(
self,
abundances=None,
*,
use_rms_charge: bool = False,
use_rms_mass: bool = False,
) -> Union[CustomParticle, Particle]:
"""
Return a particle with the average mass and charge.
By default, the mean will be used as the average. If the
``abundances`` are provided, then this method will return the
weighted mean. If ``use_rms_charge`` or ``use_rms_mass`` is
`True`, then this method will return the root-mean-square of the
charge or mass, respectively. If all items in the |ParticleList|
are equal to each other, then this method will return the first
item in the |ParticleList|.
Parameters
----------
abundances : |array_like|, optional
Real numbers representing relative abundances of the
particles in the |ParticleList|. Must have the same number
of elements as the |ParticleList|. This parameter gets
passed to `numpy.average` via that function's ``weights``
parameter. If not provided, the particles contained in the
|ParticleList| are assumed to be equally abundant.
use_rms_charge : `bool`, optional, |keyword-only|, default: `False`
If `True`, use the root-mean-square charge instead of the
mean charge.
use_rms_mass : `bool`, optional, |keyword-only|, default: `False`
If `True`, use the root-mean-square mass instead of the mean
mass.
Returns
-------
|Particle| or |CustomParticle|
Examples
--------
>>> reactants = ParticleList(["electron", "positron"])
>>> reactants.average_particle()
CustomParticle(mass=9.109383...e-31 kg, charge=0.0 C)
>>> reactants.average_particle(abundances=[1, 0.5])
CustomParticle(mass=9.109383...e-31 kg, charge=-5.34058...e-20 C)
>>> reactants.average_particle(use_rms_charge=True)
CustomParticle(mass=9.109383...e-31 kg, charge=1.6021766...-19 C)
>>> protons = ParticleList(["p+", "p+", "p+"])
>>> protons.average_particle()
Particle("p+")
"""
# If all items in the ParticleList are the same, return that item.
if len(set(self)) == 1:
return self[0]
def _average(array, weights, use_rms):
if use_rms:
return np.sqrt(np.average(array**2, weights=weights))
return np.average(array, weights=weights)
new_mass = _average(self.mass, weights=abundances, use_rms=use_rms_mass)
new_charge = _average(self.charge, weights=abundances, use_rms=use_rms_charge)
return CustomParticle(mass=new_mass, charge=new_charge)
# Override the docstrings for the parent class
ParticleList.clear.__doc__ = """Remove all items from the |ParticleList|."""
ParticleList.copy.__doc__ = """Return a shallow copy of the |ParticleList|."""
ParticleList.count.__doc__ = """
Return the number of occurrences of ``item``. Here, ``item`` must be
|particle-like|.
"""
ParticleList.extend.__doc__ = """
Extend |ParticleList| by casting |particle-like| items from
``iterable`` into particle objects.
"""
ParticleList.index.__doc__ = """
Return first index of a |particle-like| value.
Raises
------
`ValueError`
If the value is not present.
"""
ParticleList.pop.__doc__ = """
Remove and return item at index (default last).
Raises
------
`IndexError`
If the |ParticleList| is empty or the index is out of range.
"""
ParticleList.remove.__doc__ = """
Remove the first occurrence of a |particle-like| item.
Raises
------
`ValueError`
If the value is not present.
"""
ParticleList.reverse.__doc__ = """Reverse the |ParticleList| in place."""
ParticleListLike = Union[ParticleList, Sequence[ParticleLike]]
ParticleListLike.__doc__ = r"""
An `object` is |particle-list-like| if it can be identified as a
|ParticleList| or cast into one.
When used as a type hint annotation, |ParticleListLike| indicates that
the corresponding argument should represent a sequence of physical
particles. Each item in a |ParticleListLike| object must be
|particle-like|.
Notes
-----
`~plasmapy.particles.particle_class.DimensionlessParticle` instances do
not uniquely represent a physical particle, and are thus not
|ParticleLike| and cannot be contained in a |ParticleListLike| object.
See Also
--------
~plasmapy.particles.particle_collections.ParticleList
~plasmapy.particles.particle_class.ParticleLike
~plasmapy.particles.decorators.particle_input
Examples
--------
Using |ParticleListLike| as a type hint annotation indicates that an
argument or variable should represent a sequence of |ParticleLike|
objects.
>>> from plasmapy.particles import ParticleList, ParticleListLike
>>> def contains_only_leptons(particles: ParticleListLike):
... particle_list = ParticleList(particles)
... return all(particle_list.is_category("lepton"))
>>> contains_only_leptons(["electron", "muon"])
True
"""