TransportSettings 

This class collects settings related to Monte Carlo transport. These settings can be accessed as mutable attributes, which are described below.

Constructor

class TransportSettings

Generates a fresh set of configuration parameters for Monte Carlo transport. The set will be initialised with the default values listed below.

absorption	`"Discrete"`
mode	`"Forward"`
rayleigh	`True`
volume_sources	`True`

Attributes

TransportSettings.absorption: str | None

This attribute controls the simulation mode for absorption processes. Below are the possible values.

`"Continuous"`	Absorption is considered a continuous process by weighting Monte Carlo trajectories.
`"Discrete"`	Absorption is modelled as a discrete interaction process, resulting in the random termination of Monte Carlo trajectories.
`None`	Absorption is not considered.

TransportSettings.boundary: BoxShape | int | None | SphereShape

This attribute represents an inner geometry boundary for Monte Carlo transport. It can be defined as an integer sector index, for example, in an ExternalGeometry. The Monte Carlo transport stops whenever a trajectory enters the corresponding sector.

Alternatively, a boundary can be defined as a box or sphere shape, which may or may not overlap with the Monte Carlo geometry.

Tip

When setting the boundary attribute from a TransportEngine, a description string can be provided instead of an integer sector index. For instance

>>> engine.boundary = "Detector"

TransportSettings.compton_method: str: This attribute determines the sampling method for Compton collisions. Refer to the ComptonProcess.method section for a list of available values.

TransportSettings.compton_mode: str | None: This attribute determines the simulation mode for Compton collisions. Refer to the ComptonProcess.mode section for a list of available values.

TransportSettings.compton_model: str: This attribute determines the physics model for Compton collisions. Refer to the ComptonProcess.model section for a list of available values.

TransportSettings.energy_max: float | None: This attribute specifies the maximum energy of transported photons, if not None.

TransportSettings.energy_min: float | None: This attribute specifies the minimum energy of transported photons, if not None.

TransportSettings.length_max: float | None: This attribute specifies the maximum path length of transported photons, if not None.

TransportSettings.mode: str

This flag controls the direction of flow for Monte Carlo transport. Switching this flag between "Backward" and "Forward" results in a default set of settings being selected. Use the compton_mode attribute instead if thinner control is needed.

`"Backward"`	Backward Monte Carlo transport.
`"Forward"`	Conventional (forward) Monte Carlo transport.

TransportSettings.rayleigh: bool: Enable (true) or disable (false) Rayleigh collisions during the Monte Carlo transport.

TransportSettings.volume_sources: bool: This flag controls whether the backward Monte Carlo transport considers volume sources with discrete energies or not.