Skip to main content

UffOptimizer

Struct UffOptimizer 

Source
pub struct UffOptimizer {
    pub max_iterations: usize,
    pub force_threshold: f64,
    pub verbose: bool,
    pub num_threads: usize,
    pub cutoff: f64,
    pub history_size: usize,
    pub max_displacement: f64,
    pub step_hook: Option<Arc<StepHook>>,
    pub cancel_flag: Option<Arc<AtomicBool>>,
}
Expand description

Optimizer for molecular structures using the FIRE (Fast Iterative Relaxation Engine) algorithm.

Fields§

§max_iterations: usize

Maximum number of iterations to perform.

§force_threshold: f64

Threshold for the maximum force on any atom (kcal/mol/Å).

§verbose: bool

Whether to print optimization progress to tracing logs.

§num_threads: usize

Number of threads to use. 0 means automatic based on system size.

§cutoff: f64

Cutoff distance for non-bonded interactions (Å).

§history_size: usize

Number of steps to average for convergence criteria.

§max_displacement: f64

Maximum distance an atom can move in a single step (Å).

§step_hook: Option<Arc<StepHook>>

Optional hook called after each iteration.

§cancel_flag: Option<Arc<AtomicBool>>

Optional flag to cancel optimization from another thread/context.

Implementations§

Source§

impl UffOptimizer

Source

pub fn new(max_iterations: usize, force_threshold: f64) -> Self

Creates a new optimizer with default settings.

Source

pub fn with_max_displacement(self, max: f64) -> Self

Source

pub fn with_num_threads(self, num_threads: usize) -> Self

Source

pub fn with_cutoff(self, cutoff: f64) -> Self

Source

pub fn with_history_size(self, size: usize) -> Self

Source

pub fn with_verbose(self, verbose: bool) -> Self

Source

pub fn with_step_hook<F>(self, hook: F) -> Self
where F: Fn(usize, f64, f64) + Send + Sync + 'static,

Source

pub fn with_cancel_flag(self, flag: Arc<AtomicBool>) -> Self

Source

pub fn optimize(&self, system: &mut System)

Optimized structural geometry using the FIRE algorithm.

Source

pub async fn optimize_async(&self, system: &mut System)

Asynchronous version of the optimizer for non-blocking environments (Wasm/UIs).

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more