pub struct RandomFieldDisorder {
pub fields: Vec<Vector3<f64>>,
pub field_strength: f64,
pub correlation_length: f64,
}Expand description
Random field configuration at discrete lattice sites.
Each site gets a random field vector drawn from a Gaussian distribution
with standard deviation field_strength (in Tesla) and optional spatial
correlation length.
Fields§
§fields: Vec<Vector3<f64>>Random field vectors at each site [T].
field_strength: f64RMS field strength [T].
correlation_length: f64Spatial correlation length [m] (0 = uncorrelated).
Implementations§
Source§impl RandomFieldDisorder
impl RandomFieldDisorder
Sourcepub fn generate(
num_sites: usize,
field_strength: f64,
correlation_length: f64,
seed: u64,
) -> Result<Self>
pub fn generate( num_sites: usize, field_strength: f64, correlation_length: f64, seed: u64, ) -> Result<Self>
Generate random field disorder for num_sites lattice points.
§Arguments
num_sites- Number of lattice sitesfield_strength- RMS amplitude of the random field [T]correlation_length- Spatial correlation length [m] (currently uncorrelated; correlation is recorded for metadata)seed- PRNG seed
§Errors
Returns an error if num_sites is zero or field_strength is negative.
Sourcepub fn mean_magnitude(&self) -> f64
pub fn mean_magnitude(&self) -> f64
Mean magnitude of the random fields.
Trait Implementations§
Source§impl Clone for RandomFieldDisorder
impl Clone for RandomFieldDisorder
Source§fn clone(&self) -> RandomFieldDisorder
fn clone(&self) -> RandomFieldDisorder
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for RandomFieldDisorder
impl RefUnwindSafe for RandomFieldDisorder
impl Send for RandomFieldDisorder
impl Sync for RandomFieldDisorder
impl Unpin for RandomFieldDisorder
impl UnsafeUnpin for RandomFieldDisorder
impl UnwindSafe for RandomFieldDisorder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.