pygeomtools.materials package

Subpackage to provide a baseline for implementing materials in geometries.

Usage of this module’s contents is optional for geometry development with legend-pygeom-tools, it is completely equivalent to manual construction and registration of materials.

Submodules

pygeomtools.materials.base module

class pygeomtools.materials.base.BaseMaterialRegistry(g4_registry)

Bases: ABC

Parameters:

g4_registry (g4.Registry)

_add_element(name, symbol, z, a)

Lazily define an element on the current registry.

Parameters:
Return type:

None

_define_elements()

Lazily define commonly used elements.

Return type:

None

get_element(symbol)
Parameters:

symbol (str)

Return type:

Element

pygeomtools.materials.base.cached_property(material)
Parameters:

material (Callable)

pygeomtools.materials.legend module

Subpackage to provide all materials used in LEGEND and their (optical) material properties.

class pygeomtools.materials.legend.LegendMaterialRegistry(g4_registry, enable_optical=True)

Bases: BaseMaterialRegistry

Create the LEGEND material registry.

Parameters:

  • g4_registry (g4.Registry) – The Geant4 registry to register materials in.

  • enable_optical (bool | list[str]) – True (default) enables optical properties for all materials. False disables them everywhere. A list[str] enables optical properties only for the named materials (use the Python property name, e.g. "liquidargon"). Note: "Water" is the Geant4 name for the water property — pass "water" in the list.

_tpb(name, **wls_opts)
Parameters:

name (str)

Return type:

Material

property acryl: Material

Material for the acryl cap of the PMT encapsulation.

property air: Material

Air material with refractive index.

property borosilicate: Material

Material for the borosilicate glass of the PMT.

property epoxy: Material

Material for the potted base of the PMT.

property gaseousargon: Material

LEGEND gaseous argon.

property liquidargon: Material

LEGEND liquid argon.

property metal_copper: Material

Copper structures.

Warning

For full optics support, a reflective surface is needed, see surfaces.OpticalSurfaceRegistry.to_copper().

property metal_phosphor_bronze: Material

Copper structures.

property metal_silicon: Material

Silicon.

property metal_steel: Material

Fallback stainless steel material, based on GERDA croystat steel

property metal_steel_304L: Material

Stainless steel of the L1000 water tank (1.4307 (DIN), 304L (AISI)) according to TDR.

property metal_steel_316L: Material

Stainless steel of the L1000 cryostat (1.4404 (DIN), 316L (AISI)) according to TDR.

property metal_steel_316Ti: Material

Stainless steel of the GERDA cryostat (1.4571 (DIN), 316Ti (AISI)) according to 10.1088/1748-0221/17/02/P02038.

property metal_tantalum: Material

Tantalum.

property nylon: Material

Nylon (from Borexino).

property peek: Material

PEEK for the SIS absorber holder.

property pen: Material

PEN wavelength-shifter and scintillator.

property pmma: Material

PMMA for the inner fiber cladding layer.

property pmma_out: Material

PMMA for the outer fiber cladding layer.

property pmt_air: Material

Material for the air in between Acryl cap and PMT.

property ps_fibers: Material

Polystyrene for the fiber core.

property rock: Material

Rock for the LNGS cavern.

property silica: Material

Silica for the LMFE.

property teflon: Material

Teflon for the weldment and du holder.

property tetratex: Material

Tetratex diffuse reflector.

Warning

For full optics support, a reflective surface is needed, see surfaces.OpticalSurfaceRegistry.wlsr_tpb_to_tetratex().

property tpb_on_fibers: Material

Tetraphenyl-butadiene wavelength shifter (evaporated on fibers).

property tpb_on_nylon: Material

Tetraphenyl-butadiene wavelength shifter (in nylon matrix).

property tpb_on_tetratex: Material

Tetraphenyl-butadiene wavelength shifter (evaporated on Tetratex).

property tyvek: Material

Tyvek material.

property ultem: Material

Ultem for the receptacles and insulators.

property vacuum: Material

Vacuum material with refractive index.

property vm2000: Material

Material for the reflective foil VM2000 based on nylon (e.g. MaGe).

property water: Material

High purity water of the watertank.

class pygeomtools.materials.legend._AllMaterials

Bases: object

Sentinel meaning all materials have optical properties enabled.

Using this as enable_optical avoids enumerating material names at construction time (cached properties are not yet instantiated then).