substrate – Substrate geometry

class penelopetools.api.input.pengeom.usergeometry.substrate.PhotonDetectorsHook(takeoffangle, energy_low=0.0, energy_high=1000000.0)

Bases: penelopetools.api.input.penelope.hook.Hook

Creates default photon detectors for a Substrate geometry. Hemispherical detectors with an opening of 2 to 20 degrees are created from a specified take-off angle.

Parameters:

• takeoffangle – take off angle (deg)
• energy_low – lower limit of the energy window (eV)
• energy_high – upper limit of the energy window (eV)

pre_build(options)

class penelopetools.api.input.pengeom.usergeometry.substrate.Substrate(substrate_material_id=0, title='Substrate', filename='substrate.geo', surfaces=None, modules=None)

Bases: penelopetools.api.input.pengeom.usergeometry._UserGeometry

Creates a new Substrate geometry. A Substrate is defined by only one material in a cylinder. The surfaces and modules of the geometry are automatically generated when the build is called. The surfaces and modules arguments are therefore optional.

The depth and diameter are 3.0 cm. By default, no rotation and no shift is imposed on the geometry.

Parameters:

• substrate_material_id – id of the material for the substrate
• title – title of the geometry
• filename – filename of the GEO file

ATTR_SUBSTRATE_MATERIAL_ID = 'substrateMaterialId'

DEPTH = (3.000000000000 +- 0.000000000000) cm

DIAMETER = (3.000000000000 +- 0.000000000000) cm

build(options)

Builds the surfaces and modules of the geometry according to the information stored.

classmethod from_xml(element)

Creates a Substrate from a XML element.

Parameters:element – XML element

substrate_material_id

Id of the material for the substrate. The id shall correspond to the id of the material in Materials. The id must be positive.

to_html(header_level=1)

Returns a HTML representation of this option.

to_xml()

Returns a XML representation of this geometry.

validate()