Struct Rustb::Model

source ·
pub struct Model {
    pub dim_r: usize,
    pub norb: usize,
    pub nsta: usize,
    pub natom: usize,
    pub spin: bool,
    pub lat: Array2<f64>,
    pub orb: Array2<f64>,
    pub atom: Array2<f64>,
    pub atom_list: Vec<usize>,
    pub ham: Array3<Complex<f64>>,
    pub hamR: Array2<isize>,
    pub rmatrix: Array4<Complex<f64>>,
}
Expand description

This cate is used to perform various calculations on the TB model, currently including:

  • Calculate the band structure

  • Expand the cell and calculate the surface state

  • Calculate the first-order anomalous Hall conductivity and spin Hall conductivity

Fields§

§dim_r: usize
  • The real space dimension of the model.
§norb: usize
  • The number of orbitals in the model.
§nsta: usize
  • The number of states in the model. If spin is enabled, nsta=norb$\times$2
§natom: usize
  • The number of atoms in the model. The atom and atom_list at the back are used to store the positions of the atoms, and the number of orbitals corresponding to each atom.
§spin: bool
  • Whether the model has spin enabled. If enabled, spin=true
§lat: Array2<f64>
  • The lattice vector of the model, a dim_r$\times$dim_r matrix, the axis0 direction stores a 1$\times$dim_r lattice vector.
§orb: Array2<f64>
  • The position of the orbitals in the model. We use fractional coordinates uniformly.
§atom: Array2<f64>
  • The position of the atoms in the model, also in fractional coordinates.
§atom_list: Vec<usize>
  • The number of orbitals in the atoms, in the same order as the atom positions.
§ham: Array3<Complex<f64>>
  • The Hamiltonian of the model, $\bra{m0}\hat H\ket{nR}$, a three-dimensional complex tensor of size n_R$\times$nsta$\times$ nsta, where the first nsta*nsta matrix corresponds to hopping within the unit cell, i.e. <m0|H|n0>, and the subsequent matrices correspond to hopping within hamR.
§hamR: Array2<isize>
  • The distance between the unit cell hoppings, i.e. R in $\bra{m0}\hat H\ket{nR}$.
§rmatrix: Array4<Complex<f64>>
  • The position matrix, i.e. $\bra{m0}\hat{\bm r}\ket{nR}$.

Implementations§

source§

impl Model

这个模块是用 wilson loop 的方法来计算 berry phase 等数值的

source

pub fn berry_loop(&self, kvec: &Array2<f64>) -> Array1<f64>

Trait Implementations§

source§

impl Clone for Model

source§

fn clone(&self) -> Model

Returns a copy 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 Model

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl RefUnwindSafe for Model

§

impl Send for Model

§

impl Sync for Model

§

impl Unpin for Model

§

impl UnwindSafe for Model

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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, U> Into<U> for Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V