Struct ChargeReport 

pub struct ChargeReport {
    pub incident: u64,
    pub total: ChargeCounts,
    pub per_layer: ChargeCells,
    pub escaped_front: EscapedCharge,
    pub escaped_back: EscapedCharge,
    pub escaped_side: EscapedCharge,
    pub imbalance: i64,
    pub cartesian: Option<CartesianCharge>,
    pub cylindrical: Option<CylindricalCharge>,
}

Where the electrons of a run came to rest and where holes were left, as integer counts, and the balance against the incident electrons.

Charge is counted in units of the electron’s, per electron number:

• every electron that ends inside the target counts +1 where it ends: every terminal fate except escape (stopped below the layer’s threshold, trapped without an interaction, absorbed at the back face, polaron trapped, cut off by the collision cap);
• every liberated electron (a secondary-model event with liberated = true) counts -1 at the event, the hole it leaves, whether or not the electron is followed. A liberated electron below the stopping threshold is not followed, it is dropped and counted +1 where it was created, so its -1 and +1 cancel;
• an electron leaving through a face carries its charge out and is counted in escaped_front / escaped_back.

The balance is exact in integers: incident + created = stopped + escaped, so imbalance is zero on every run and the net electron number deposited in the target, stopped - created, equals incident - escaped. Generation: primary is the incident electron, secondary every electron created by the secondary model. A secondary below the cutoff is not followed and is therefore counted where it is dropped (see ElectronTallyMetadata::cutoff_ev).

Fields

incident: u64

Incident electrons (primary histories).

total: ChargeCounts

Totals over the target.

per_layer: ChargeCells

Per layer.

escaped_front: EscapedCharge

Electrons that left through the front face.

escaped_back: EscapedCharge

Electrons that left through the back face.

escaped_side: EscapedCharge

Electrons that left through the lateral boundary of a non-slab geometry.

imbalance: i64

incident + created - stopped - escaped; zero if every electron was counted exactly once.

cartesian: Option<CartesianCharge>

The Cartesian grid, if the run has one.

cylindrical: Option<CylindricalCharge>

The cylindrical grid, if the run has one.

Trait Implementations

impl Clone for ChargeReport

fn clone(&self) -> ChargeReport

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChargeReport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ChargeReport

fn default() -> ChargeReport

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChargeReport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChargeReport

fn eq(&self, other: &ChargeReport) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ChargeReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChargeReport