GeometrySector

This class represents a sector of a Monte Carlo geometry. A sector is characterised by a uniform atomic composition, specified by a MaterialDefinition. However, the material density might vary continuously within a sector, for example following a DensityGradient.

Note

GeometrySector objects provide immutable representations of a sector of the geometry. That is, all attributes below are read-only.

Constructor

class GeometrySector(material, density, description=None)

The material argument must be consistent with a MaterialDefinition. The density can be an instance of a float, in which case a uniform density is assumed (in g/cm3), or a DensityGradient. Optionaly, a description can be provided as a str. For instance,

>>> sector = goupil.GeometrySector("H2O", 1.0, "Water")

Attributes

GeometrySector.density: DensityGradient | float

The density model of the geometry sector. A float value indicates a uniform density, expressed in g/cm3.

GeometrySector.description: None | str

A textual description of the geometry sector.

GeometrySector.material: MaterialDefinition

The uniform atomic composition of the geometry sector.