TransportOptions Class

An object implementing the Transport Options in Charge Domain.

Inheritance Hierarchy

SystemObject
ema3d.Api.V26.Charging.DomainTransportOptions

Namespace: ema3d.Api.V26.Charging.Domain
Assembly: ema3d.Api.V26 (in ema3d.Api.V26.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class TransportOptions

Public NotInheritable Class TransportOptions

public ref class TransportOptions sealed

[<SealedAttribute>]
type TransportOptions = class end

The TransportOptions type exposes the following members.

Properties

	Name	Description
	FluxBins	User specified values describing flux bins to use during particle transport.
	FluxSourceOn	Enable the use of a flux source for coupled simulations.
	FluxThreshold	Threshold for flux source for coupled simulations in MeV.
	Geant4PhysicsPackage	The Geant4 physics package to be used during particle transport.
	MaxTreeDepth	Depth of Octree for mapping G4 particles in Charge Plus.
	ParallelTransportProcesses	Number of parallel processes to be used during particle transport.
	TransportFieldCouplingOn	Enable the coupling of fields between Geant4 and Charge Plus.
	TransportQuantities	Enables transport quantities per body.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

This does not directly wrap the various solver and flux classes, but instead implements some of the wrapped properties of these classes to be used in Charge Domain. Corresponds to the Transport Options displayed in the UI.

Example

Python

Copy

from ema3d.Api.V26.Charging.Domain import ChargeDomain as ChargeDomain
from ema3d.Api.V26.Charging.Domain import ChargingEnvironment as ChargingEnvironment
from ema3d.Api.V26.Charging.Domain import ChargeSolverPackage as ChargeSolverPackage

_cd = ChargeDomain.GetInstance(Window.ActiveWindow.Document)
_cd.SwitchChargingOptions.SimulationType = ChargingEnvironment.Internal

flux_tracking_bins = [0.5, 0.8, 1.0, 1.1] # MeV
_cd.TransportOptions.FluxBins = List[float](flux_tracking_bins)

_cd.TransportOptions.Geant4PhysicsPackage = ChargeSolverPackage.empenelope
_cd.TransportOptions.MaxTreeDepth = 4
_cd.TransportOptions.ParallelTransportProcesses = 4
_cd.TransportOptions.FluxSourceOn = True
_cd.TransportOptions.FluxThreshold = 5.5 # MeV
_cd.TransportOptions.TransportFieldCouplingOn = True

Reference

ema3d.Api.V26.Charging.Domain Namespace