Skip to main content

RietveldSamplePhysicsModel

Enum RietveldSamplePhysicsModel 

Source
pub enum RietveldSamplePhysicsModel {
    IsotropicSize {
        crystallite_size_nm: f64,
        shape_factor: f64,
    },
    IsotropicMicrostrain {
        rms_microstrain: f64,
    },
    IsotropicLorentzianMicrostrain {
        microstrain: f64,
    },
    MarchDollase {
        ratio: f64,
        preferred_axis_hkl: [f64; 3],
    },
    Composite(Vec<Self>),
}
Expand description

One closed built-in sample-physics model.

Variants§

§

IsotropicSize

Lorentzian Scherrer broadening.

Fields

§crystallite_size_nm: f64

Coherent-domain size in nanometres.

§shape_factor: f64

Fixed positive Scherrer shape factor.

§

IsotropicMicrostrain

Gaussian broadening from RMS delta d / d.

Fields

§rms_microstrain: f64

Non-negative dimensionless RMS microstrain.

§

IsotropicLorentzianMicrostrain

Lorentzian broadening from a distribution of delta d / d.

Fields

§microstrain: f64

Non-negative dimensionless Lorentzian microstrain.

§

MarchDollase

March–Dollase integrated-intensity correction around a fixed axis.

Fields

§ratio: f64

Positive March ratio.

§preferred_axis_hkl: [f64; 3]

Non-zero preferred reciprocal-lattice axis.

§

Composite(Vec<Self>)

Ordered multiplicative/additive composition.

Implementations§

Source§

impl RietveldSamplePhysicsModel

Source

pub fn parameters( &self, ) -> Result<Vec<SamplePhysicsParameter>, SamplePhysicsError>

Return refinable model scalars in stable composition order.

§Errors

Returns SamplePhysicsError for invalid or duplicate model records.

Source

pub fn replace_parameters( &self, values: &BTreeMap<String, f64>, ) -> Result<Self, SamplePhysicsError>

Clone the model with replacement refinable scalar values.

§Errors

Returns SamplePhysicsError for missing, unknown, or invalid values.

Source

pub fn evaluate( &self, hkl: &[[i32; 3]], two_theta_deg: &[f64], cell: UnitCell, wavelength_angstrom: f64, ) -> Result<EvaluatedSamplePhysics, SamplePhysicsError>

Validate and evaluate the model for one reflection batch.

§Errors

Returns SamplePhysicsError for invalid model, reflection, cell, or contribution state.

Trait Implementations§

Source§

impl Clone for RietveldSamplePhysicsModel

Source§

fn clone(&self) -> RietveldSamplePhysicsModel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RietveldSamplePhysicsModel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RietveldSamplePhysicsModel

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RietveldSamplePhysicsModel

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.