ParticleFilter#

class montepy.data_inputs.tally.ParticleFilter(particles: ParticleNode | list[Particle] | set[Particle])#

Bases: Filter

Filters a tally to the particle types in its classifier (e.g. :n,p).

A thin wrapper around the underlying ParticleNode, mirroring Mode’s design: particle membership is what matters, not order. Two filters with the same particles compare equal no matter what order they were written in (:n,p == :p,n); order is only ever meaningful when the underlying node formats itself back to MCNP text.

Added in version 1.6.0b2.

Parameters:

particles (ParticleNode | list[Particle] | set[Particle]) – The parsed node backing this filter’s particles, or a plain collection of particles to build one from.

Attributes:

particles

The particles this tally is restricted to.

property particles: set[Particle]#

The particles this tally is restricted to.