VOLT
Plugins

Elastic Strain

Compute crystal-referenced elastic strain by mapping local environments to an ideal lattice.

Requires an upstream structure-identification step: the plugin consumes the cluster tables (clusters_table and clusters_transitions) produced by the referenced structure-analysis plugin, and fails if those inputs are absent.

Parameters

ParameterTypeDefaultDescription
structure_analysis_pluginpluginReferenceRequired. Upstream structure-identification algorithm that produces the cluster tables. Accepts polyhedral-template-matching or adaptive-common-neighbor-analysis.
lattice_constantfloat3.615Lattice constant a₀. Required by the binary.
crystal_structurestringFCCReference crystal structure. Plugin UI options: FCC, BCC, HCP. (The underlying binary CLI additionally accepts SC, CUBIC_DIAMOND, HEX_DIAMOND.)
ca_ratiofloat1.0c/a ratio for HCP and hexagonal crystals.
push_forwardboolfalsePush strain to the spatial frame (Euler strain).
calc_deformation_gradientbooltrueCompute deformation gradient F.
calc_strain_tensorsbooltrueCompute strain tensors.

Output

{outputBase}_elastic_strain.parquet

type StrainTensor = [float, float, float, float, float, float];
type DeformationGradient = [float, float, float, float, float, float, float, float, float];

interface PerAtomProperties {
    id: int;
    volumetric_strain: float;
    strain_tensor?: StrainTensor;
    deformation_gradient?: DeformationGradient;
}

interface ElasticStrainOutput {
    main_listing: {
        average_volumetric_strain: float;
    };
    "per-atom-properties": PerAtomProperties[];
}

{outputBase}_atoms.parquet

Per-atom atomistic export consumed by the Elastic Strain Model exposure and exported as a GLB via AtomisticExporter. The envelope contains:

  • main_listing — aggregate counts: total_atoms, structure_count, clustered_atoms, unclustered_atoms.
  • sub_listings.structures — array of { structure_id, structure_name, atom_count } for each occupied structure type.
  • export.AtomisticExporter — atoms keyed by structure name. Each atom carries id, pos, structure_id, structure_type, structure_name, cluster_id, optional topology_name, and the strain quantities (volumetric_strain, strain_tensor, deformation_gradient) when computed.

See Also

On this page