Struct Input 

pub struct Input {
    pub beam: BeamSpec,
    pub materials: BTreeMap<String, MaterialSpec>,
    pub target: TargetSpec,
    pub physics: PhysicsSpec,
    pub stopping: StoppingSpec,
    pub run: RunSpec,
    pub tally: TallySpec,
    pub dynamic: Option<DynamicSpec>,
    pub crystal: Vec<CrystalSpec>,
}

The whole run description.

Fields

beam: BeamSpec

The incident beam.

materials: BTreeMap<String, MaterialSpec>

Named materials, referenced by name from the target layers.

target: TargetSpec

The layered target.

physics: PhysicsSpec

Physics model choices and cutoffs.

stopping: StoppingSpec

User-supplied electronic stopping tables (optional).

run: RunSpec

Run size, seed and threads.

tally: TallySpec

What the run records.

dynamic: Option<DynamicSpec>

Fluence-dependent target (optional). Absent: the static run.

crystal: Vec<CrystalSpec>

Cubic crystal assignments to stack layers (optional). Absent: every layer is amorphous.

Implementations

impl Input

pub fn resolve(&self) -> Result<Resolved, InputError>

Validate everything and build the engine’s inputs. Errors name the offending key.

pub fn resolve_in(&self, base_dir: &Path) -> Result<Resolved, InputError>

Like Input::resolve, with relative [stopping] table paths taken relative to base_dir (the directory of the input file).

pub fn resolve_with_sets( &self, base_dir: &Path, sets: &[TuningSet], ) -> Result<Resolved, InputError>

Input::resolve_in against an explicit registry of tuning sets (tests use synthetic sets; production uses TUNING_SETS).

impl Input

pub fn from_toml_str(text: &str) -> Result<Self, InputError>

Parse a TOML document. Schema errors (unknown or missing keys, wrong types) are reported with the key and line; values are checked by Input::resolve.

pub fn to_toml_string(&self) -> Result<String, InputError>

The input as a TOML document in the same schema Input::from_toml_str reads: parsing the text gives back an equal Input.

pub fn echo(&self) -> Input

The input as echoed into output metadata: defaults filled in, and run.threads removed (it does not affect results).

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Input

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Input

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Input

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 Input