Skip to main content

Operator

Struct Operator 

Source
pub struct Operator {
    pub terms: Vec<Term>,
    pub origin: Vec3,
}
Expand description

A one-electron operator: a sum of Terms, polynomial in r and p, with a documented origin for its r factors (the multipole / gauge origin).

Adding a new integral type is constructing one of these — see the constructors (Operator::dipole, Operator::quadrupole, Operator::momentum, Operator::angular_momentum, …). The engines are untouched.

Fields§

§terms: Vec<Term>

The terms summed to form the operator.

§origin: Vec3

Origin for the r factors (multipole / gauge origin), in bohr.

Implementations§

Source§

impl Operator

Source

pub fn new(terms: Vec<Term>, origin: Vec3) -> Self

Construct an operator from its terms and r-origin.

Source

pub fn identity() -> Self

The identity operator — its integral is the plain overlap ⟨a|b⟩.

Source

pub fn dipole(axis: usize, origin: Vec3) -> Self

The dipole component r_axis about origin⟨a|(r−O)_axis|b⟩. Real-symmetric.

Source

pub fn quadrupole(i: usize, j: usize, origin: Vec3) -> Self

The second-moment / quadrupole component r_i r_j about origin⟨a|(r−O)_i (r−O)_j|b⟩. Real-symmetric.

Source

pub fn kinetic() -> Self

The kinetic-energy operator −½∇² = ½ p·p. Real-symmetric; reproduces crate::os::kinetic_into.

Source

pub fn momentum(axis: usize) -> Self

The momentum component p_axis = −i∂_axis. Imaginary/antisymmetric.

Source

pub fn angular_momentum(axis: usize, origin: Vec3) -> Self

The orbital-angular-momentum component (r × p)_axis about origin, e.g. L_x = (r−O)_y p_z − (r−O)_z p_y. Imaginary/antisymmetric (the i is carried explicitly).

Source

pub fn degree(&self) -> usize

The operator’s polynomial degree: the largest number of factors in any term. The ket is raised by at most this much, so a shell pair is evaluable iff l_ket + degree ≤ MAX_L.

Trait Implementations§

Source§

impl Clone for Operator

Source§

fn clone(&self) -> Operator

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 Operator

Source§

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

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

impl PartialEq for Operator

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Operator

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> 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.