Description#

The entity material loss block is designed to simulate loss, and optionally partial simultaneous replacement, of entities that enter the block. By default, the block removes a fraction of the entities entering the block during the specified interval. This behavior can be modified via the loss species override table wherein fractions can be set for individual elements or isotopes. A replacement table is available to specify replace lost material with a specified element or isotope with a certain fraction.

Example:

Removal Fraction: 0.25

In this example, a removal fraction of 0.25 is specified, so 25% of all material entering the block will be removed for the specified interval. However, the loss species override is used, so h³ will have only 10% removed, but c¹² will have 100% removed. Additionally, the mass of material removed will be replaced at a 1:1 ratio (as the fraction in the replacement material table sums to 1) with 25% being fe⁵⁶ and 75% h² by mass.

Mask dialog options#

Start time (hr) : float

The time to start the specified loss in hours. Expects a positive, non-zero value.

End time (hr) : float

The time to end the specified loss in hours. Expects a positive, non-zero value that is greater than Start time.

Removal fraction: float

The percentage of material to remove during the specified interval. This value should be $\in [0,1]$.

Loss species override table : string, float

Species, if any, that should have a different removal fraction from that specified in the removal fraction option. The species should be entered as elemental or isotopic, with no hyphenation or spaces (e.g., h or h2). Fractions for each species should be $\in [0,1]$.

Replacement material table: string, float

Species to replace removed material. The species should be entered as elemental or isotopic, with no hyphenation or spaces (e.g., h or h2). Fractions for each species should be $\in [0,\mathrm{\infty })$. Can be left empty with the replacement material checkbox unchecked.

Ports#

In(D) : signal

Signal to modify. Expects an entity with attributes:

• isovec (signal): Has shape [1677, 1] that represents the different isotopes tracked by F3M

• auxparam (scalar): Function varies based on user implementation

Outputs#

Res(D) : entity

The modified entity after the loss and replacement fractions have been applied. Has the same attributes as In(D).

Rmvd(D) : entity

The entity that represents the component that has been removed. Satisfies the relationship In(D) = Res(D) + Rmvd(D). Has the same attributes as In(D).

Add(D) : entity

The component that was added as specified by the replacement material. Has the same attributes as In(D). This signal is zero if no components are specified in the replacement material table.