glow package

GLOW (Geometry Layout Oriented Workflow) is a Python package providing 2D unstructured geometries to the DRAGON5 lattice transport computer code.

Subpackages

Submodules

glow.main module

class TdtSetup(geom_type: GeometryType = GeometryType.TECHNOLOGICAL, property_types: PropertyType | List[PropertyType] = PropertyType.MATERIAL, albedo: float | None = None, type_geo: LayoutGeometryType = LayoutGeometryType.ISOTROPIC, symmetry_type: SymmetryType = SymmetryType.FULL)[source]

Bases: object

Dataclass holding the settings for configuring how to export the TDT file for the current geometry layout.

Notes

The albedo attribute can have values between 0.0 and 1.0, with the latter case indicating the ALBE 1.0 BC used in DRAGON5 with a uniform tracking (i.e. LayoutGeometryType.ISOTROPIC). If None, the value that corresponds to the type of geometry of the layout is used, i.e. 0.0 for values of LayoutGeometryType greater than zero, 1.0 otherwise.

albedo: float | None = None: Identifying the value for the albedo applied to the layout’s BCs.

geom_type: GeometryType = 0: Identifying the type of geometry layout.

layout_type: LayoutType: Identifying the type of the layout.

property_types: PropertyType | List[PropertyType] = 0: Identifying the type(s) of property associated to the layout’s regions.

symmetry_type: SymmetryType = 0: Identifying the value for the symmetry type applied to the layout.

type_geo: LayoutGeometryType = 0: Identifying the value for the typgeo index used by the SALT module of DRAGON5.

export_layout_to_tdt(layout: Fillable, filename: str, tdt_setup: TdtSetup = TdtSetup(GeometryType.TECHNOLOGICAL, PropertyType.MATERIAL, None), compound_to_export: Any | None = None) → None[source]

Function that analyses the given layout, as instance of the Fillable class, to extract information about the characteristics of its geometry and the properties associated to its regions. A TDT file, whose name is provided as second parameter, is generated, collecting all this information.

By properly configuring the TdtSetup instance, provided as third parameter, users can indicate which information about the geometry needs to be extracted from the layout and the tracking setup. In particular, the available options are:

the geometry type of the layout (either the technological or the refined geometry);
the type(s) of property associated to the regions of the layout;
the value for the albedo applied to the BCs of the layout. If None, a default value that corresponds to the geometry type of the layout is adopted;
the value for the type_geo attribute which drives the type of tracking (either TISO or TSPC) to adopt accordingly with what requested by the SALT: module of DRAGON5;
the type of symmetry applied to the layout.

When specifying values for the type of symmetry which differ from the one currently applied to the layout, and specified in the the state attribute of the given Fillable object, the indicated symmetry is applied, if the corresponding shape of symmetry has already been built by calling the apply_symmetry method.

If the compound_to_export parameter is provided, it will be the one to be analysed and exported, according to the property information stored in the layout. The indicated compound object must be a portion of the entire layout, otherwise the successive steps of the analysis will fail.

Parameters:

layout (Fillable) – The layout, as instance of the Fillable subclasses, storing the information about the geometry and the assigned properties.
filename (str) – The name of the output TDT file.
tdt_setup (TdtSetup) – Dataclass providing the settings for exporting the TDT representation of the geometry layout.
compound_to_export (Any | None = None) – The compound object (as portion of the layout) to analyse and export to TDT, if provided.

Raises:

RuntimeError – In case of inconsistencies in the values of the TdTSetup settings. If the analysis fails due to the compound not being part of the layout, no properties being found for any region of the layout, or the layout borders being impossible to obtain.

Notes

Users should note that:

The configuration values provided in the TdtSetup instance are considered regardless of what set in the given Fillable object.
The configuration values provided in the TdtSetup instance must match with the indicated compound object. If values that do not match with the shape of the compound are provided, the validity of the results in DRAGON cannot be assured.