Skip to main content

Augmentation

Struct Augmentation 

Source
pub struct Augmentation {
Show 16 fields pub q_with_l: bool, pub nqf: usize, pub nqlc: usize, pub shape: String, pub ir_aug: usize, pub raug: f64, pub l_max_aug: i32, pub augmentation_epsilon: f64, pub cutoff_radius: Option<f64>, pub cutoff_radius_index: Option<usize>, pub q: Option<NumericData>, pub multipoles: Option<NumericData>, pub qfcoef: Option<NumericData>, pub rinner: Option<NumericData>, pub qijl: Vec<AugmentationQijl>, pub qij: Vec<AugmentationQij>,
}
Expand description

Public UPF data model. Augmentation charge data stored in <PP_AUGMENTATION>.

PP stands for pseudopotential.

Fields§

§q_with_l: bool

Whether the augmentation charge depends on angular momentum l.

§nqf: usize

Number of augmentation-function coefficients.

NQF stands for number of Q-function coefficients.

§nqlc: usize

Number of local charge components.

NQLC stands for number of local charge components.

§shape: String

Generator-declared augmentation shape.

§ir_aug: usize

Number of mesh points used for augmentation.

IR is the UPF short form for an integer radial index.

§raug: f64

Augmentation cutoff radius.

§l_max_aug: i32

Maximum angular momentum used by augmentation terms.

§augmentation_epsilon: f64

Small numerical tolerance used for augmentation data.

§cutoff_radius: Option<f64>

Optional augmentation cutoff radius from cutoff_r.

§cutoff_radius_index: Option<usize>

Optional augmentation cutoff radius mesh index from cutoff_r_index.

§q: Option<NumericData>

Aggregate augmentation charge Q(r) from <PP_Q>.

§multipoles: Option<NumericData>

Multipole moments from <PP_MULTIPOLES>.

§qfcoef: Option<NumericData>

Q-function coefficients from <PP_QFCOEF>.

QFCOEF stands for Q-function coefficients.

§rinner: Option<NumericData>

Inner radii from <PP_RINNER>.

RINNER stands for inner radius.

§qijl: Vec<AugmentationQijl>

Angular-momentum-resolved augmentation functions from tags such as <PP_QIJL.1.1.0>.

QIJL stands for the augmentation quantity Q_ij^l.

§qij: Vec<AugmentationQij>

Pairwise augmentation functions from tags such as <PP_QIJ.1.2>.

QIJ stands for the augmentation quantity Q_ij.

Implementations§

Source§

impl Augmentation

Source

pub fn q(&self) -> Option<&NumericData>

Returns the aggregate augmentation charge Q(r).

Trait Implementations§

Source§

impl Clone for Augmentation

Source§

fn clone(&self) -> Augmentation

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Augmentation

Source§

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

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

impl<'de> Deserialize<'de> for Augmentation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Augmentation

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Serialize for Augmentation

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Augmentation

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,