Struct RietveldPhase 

pub struct RietveldPhase { /* private fields */ }

One owned monochromatic structural phase and its sample-physics inputs.

Implementations

impl RietveldPhase

pub fn new( phase_id: RecordId, name: impl Into<String>, definition: StructuralPhaseDefinition, contributions: OwnedCwContributions, ) -> Result<Self, RietveldError>

Validate and own one built-in structural phase.

Errors

Returns RietveldError for an empty name, invalid definition, or a contribution batch with the wrong reflection count.

pub fn new_with_site_ids( phase_id: RecordId, name: impl Into<String>, site_ids: Vec<RecordId>, definition: StructuralPhaseDefinition, contributions: OwnedCwContributions, ) -> Result<Self, RietveldError>

Validate and own one phase with explicit stable asymmetric-site IDs.

Errors

Returns RietveldError when site IDs are missing or duplicated, or when another phase invariant is invalid.

pub fn from_lattice_domain( phase_id: RecordId, name: impl Into<String>, site_ids: Vec<RecordId>, definition: StructuralPhaseDefinition, reflection_domain: LatticeReflectionDomain, ) -> Result<Self, RietveldError>

Generate a structural phase from one bounded reflection-domain contract.

Reflection arrays are regenerated from the definition’s cell and start with neutral sample-physics contributions. Subsequent accepted cell changes transfer contribution arrays by stable reflection ID.

Errors

Returns RietveldError for an invalid domain, definition, or phase.

pub fn validate(&self) -> Result<(), RietveldError>

Revalidate adapter-decoded phase identity, structure, and topology.

Errors

Returns RietveldError for invalid phase state.

pub const fn phase_id(&self) -> &RecordId

Borrow the stable phase ID.

pub fn name(&self) -> &str

Borrow the human-readable phase name.

pub fn site_ids(&self) -> &[RecordId]

Borrow stable asymmetric-site IDs in structural-array order.

pub fn reflection_ids(&self) -> &[String]

Borrow stable reflection-family IDs in calculation order.

pub const fn definition(&self) -> &StructuralPhaseDefinition

Borrow the complete structural definition.

pub const fn contributions(&self) -> &OwnedCwContributions

Borrow the owned sample-physics contribution batch.

pub const fn sample_physics(&self) -> Option<&RietveldSamplePhysicsModel>

Borrow the optional built-in sample-physics model record.

pub fn with_sample_physics(self, model: RietveldSamplePhysicsModel) -> Self

Attach one built-in sample-physics model to this phase.

The static contribution batch is retained only as the fixed-provider fallback and is not composed with the built-in model.

pub fn without_sample_physics(self) -> Self

Remove the built-in sample-physics model without changing the phase’s structure, reflection topology, or fixed contribution fallback.

pub fn with_contributions( &self, contributions: OwnedCwContributions, ) -> Result<Self, RietveldError>

Replace sample-physics contributions without changing phase topology.

Errors

Returns RietveldError when the contribution reflection count does not match the current stable reflection list.

pub const fn reflection_domain(&self) -> Option<&LatticeReflectionDomain>

Borrow the guarded reflection domain for a dynamic phase.

pub fn regenerate_lattice_at_cell( &self, cell: UnitCell, ) -> Result<(Self, RietveldTopologyChange), RietveldError>

Regenerate a dynamic phase at another accepted bounded cell.

Existing sample-physics values and parameter derivatives transfer by stable reflection ID. New reflection families receive neutral values.

Errors

Returns RietveldError for a fixed phase, an out-of-domain cell, or invalid transferred contributions.

Trait Implementations

impl Clone for RietveldPhase

fn clone(&self) -> RietveldPhase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RietveldPhase

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

Formats the value using the given formatter.

impl PartialEq for RietveldPhase

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RietveldPhase