Particle

class Particle(h5group, mesh, XS)

The Particle class stores particle-specific data.

Print an object of this class to view all available attributes.

Parameters:

h5group (h5py.Group) – The HDF5 group corresponding to the particle.
mesh (Mesh) – The mesh used in the solve.
XS (CrossSections) – The cross sections of the given particle

h5

The HDF5 group from which this object is built.

Type:: h5py.Group

name

The name of the particle according to the HDF5 file.

Type:: str

XS

The cross sections of the given particle.

Type:: CrossSections

angular

The angular discretization of the given particle.

Type:: AngularSpace

energy

The energy discretization of the given particle.

Type:: EnergyGrid

<DATASET>

Any non-standard datasets found within this particle’s HDF5 group will be accessible. HDF5 attributes will be ignored however and must be accessed manually by the user.

Type:: arbitrary type, rank

angular_fluence(energies='all', angles='all')

Fetches (if present) the angular fluence.

Parameters:

energies (list(int) or int, optional) – The set of energy indices for which you want to get the angular fluence. By default, all are provided.
angles (list(int) or int, optional) – The set of angular indices for which you want to get the angular fluence. By default, all are provided.

Returns:

angfl – The angular fluence. If multiple energies are requested, then this is a list of SpaceAngleVector objects. Otherwise it is a single SpaceAngleVector. If the HDF5 file does not contain angular fluences, None is returned.

Return type:

list(SpaceAngleVector) or SpaceAngleVector or None

fluence(energies='all')

Calculates or fetches (if present) the fluence.

Parameters:: energies (list(int) or int, optional) – The set of energy indices for which you want to get the angular fluence. By default, all are provided.
Returns:: fl – The fluence. If multiple energies are requested, then this is a list of rank-one np.float64 arrays (indexed by spatial d.o.f.). Otherwise it is a single np.float64 array. If the HDF5 file does not contain fluences nor the angular fluences, None is returned.
Return type:: list(np.float64 [:]) or np.float64 or None

uncollided_angular_fluence(energies='all', angles='all', cache=False, lazy=False)

Fetches (if present) the uncollided angular fluence.

Parameters:

energies (list(int) or int, optional) – The set of energy indices for which you want to get the angular fluence. By default, all are provided.
angles (list(int) or int, optional) – The set of angular indices for which you want to get the angular fluence. By default, all are provided.

Returns:

angfl – The uncollided angular fluence. If multiple energies are requested, then this is a list of SpaceAngleVector objects. Otherwise it is a single SpaceAngleVector. If the HDF5 file does not contain uncollided angular fluences, None is returned.

Return type:

list(SpaceAngleVector) or SpaceAngleVector or None

uncollided_fluence(energies='all')

Calculates or fetches (if present) the uncollided fluence.

Parameters:: energies (list(int) or int, optional) – The set of energy indices for which you want to get the angular fluence. By default, all are provided.
Returns:: fl – The uncollided fluence. If multiple energies are requested, then this is a list of rank-one np.float64 arrays (indexed by spatial d.o.f.). Otherwise it is a single np.float64 array. If the HDF5 file does not contain fluences nor the angular fluences, None is returned.
Return type:: list(np.float64 [:]) or np.float64 or None