Struct qsym2::sandbox::target::real_space_function::real_space_function_analysis::RealSpaceFunctionSymmetryOrbit

pub struct RealSpaceFunctionSymmetryOrbit<'a, G, T, F>
where
    G: SymmetryGroupProperties,
    T: ComplexFloat + Debug + Lapack,
    F: Fn(&Point3<f64>) -> T,
    RealSpaceFunction<T, F>: SymmetryTransformable,
{ /* private fields */ }

Structure to manage symmetry orbits (i.e. orbits generated by symmetry groups) of real-space functions.

Implementations

impl<'a, G, T, F> RealSpaceFunctionSymmetryOrbit<'a, G, T, F>

where G: SymmetryGroupProperties + Clone, T: ComplexFloat + Debug + Lapack, F: Clone + Fn(&Point3<f64>) -> T, RealSpaceFunction<T, F>: SymmetryTransformable,

pub fn builder() -> RealSpaceFunctionSymmetryOrbitBuilder<'a, G, T, F>

Returns a builder for constructing a new real-space function symmetry orbit.

impl<'a, G, F> RealSpaceFunctionSymmetryOrbit<'a, G, f64, F>

where G: SymmetryGroupProperties + Clone, F: Clone + Fn(&Point3<f64>) -> f64,

pub fn calc_xmat( &mut self, preserves_full_rank: bool, ) -> Result<&mut Self, Error>

Calculates the $\mathbf{X}$ matrix for real and symmetric overlap matrix $\mathbf{S}$ between the symmetry-equivalent real-space functions in the orbit.

The resulting $\mathbf{X}$ is stored in the orbit.

Arguments

• preserves_full_rank - If true, when $\mathbf{S}$ is already of full rank, then $\mathbf{X}$ is set to be the identity matrix to avoid mixing the orbit real-space functions. If false, $\mathbf{X}$ also orthogonalises $\mathbf{S}$ even when it is already of full rank.

impl<'a, G, T, F> RealSpaceFunctionSymmetryOrbit<'a, G, Complex<T>, F>

where G: SymmetryGroupProperties + Clone, T: Float + Scalar<Complex = Complex<T>>, Complex<T>: ComplexFloat<Real = T> + Scalar<Real = T, Complex = Complex<T>> + Lapack, F: Clone + Fn(&Point3<f64>) -> Complex<T>, RealSpaceFunction<Complex<T>, F>: SymmetryTransformable + Overlap<Complex<T>, Ix1>,

pub fn calc_xmat( &mut self, preserves_full_rank: bool, ) -> Result<&mut Self, Error>

Calculates the $\mathbf{X}$ matrix for complex and symmetric or Hermitian overlap matrix $\mathbf{S}$ between the symmetry-equivalent real-space functions in the orbit.

The resulting $\mathbf{X}$ is stored in the orbit.

Arguments

• preserves_full_rank - If true, when $\mathbf{S}$ is already of full rank, then $\mathbf{X}$ is set to be the identity matrix to avoid mixing the orbit real-space functions. If false, $\mathbf{X}$ also orthogonalises $\mathbf{S}$ even when it is already of full rank.

Trait Implementations

impl<'a, G, T, F> Clone for RealSpaceFunctionSymmetryOrbit<'a, G, T, F>

where G: SymmetryGroupProperties + Clone, T: ComplexFloat + Debug + Lapack + Clone, F: Fn(&Point3<f64>) -> T + Clone, RealSpaceFunction<T, F>: SymmetryTransformable,

fn clone(&self) -> RealSpaceFunctionSymmetryOrbit<'a, G, T, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, G, T, F> Orbit<G, RealSpaceFunction<T, F>> for RealSpaceFunctionSymmetryOrbit<'a, G, T, F>

where G: SymmetryGroupProperties + Clone, T: ComplexFloat + Debug + Lapack, F: Fn(&Point3<f64>) -> T, RealSpaceFunction<T, F>: SymmetryTransformable,

type OrbitIter = OrbitIterator<'a, G, RealSpaceFunction<T, F>>

Type of the iterator over items in the orbit.

fn group(&self) -> &'a G

The group generating the orbit.

fn origin(&self) -> &RealSpaceFunction<T, F>

The origin of the orbit.

fn iter(&self) -> Self::OrbitIter

An iterator over items in the orbit arising from the action of the group on the origin.

impl<'a, G, T, F> RepAnalysis<G, RealSpaceFunction<T, F>, T, Dim<[usize; 1]>> for RealSpaceFunctionSymmetryOrbit<'a, G, T, F>

where G: SymmetryGroupProperties + Clone, G::CharTab: SubspaceDecomposable<T>, T: Lapack + ComplexFloat<Real = <T as Scalar>::Real> + Debug + Send + Sync + Mul<<T as ComplexFloat>::Real, Output = T>, <T as ComplexFloat>::Real: Debug + Zero + From<u16> + ToPrimitive + RelativeEq<<T as ComplexFloat>::Real> + AbsDiffEq<Epsilon = <T as Scalar>::Real>, F: Clone + Sync + Send + Fn(&Point3<f64>) -> T, RealSpaceFunction<T, F>: SymmetryTransformable,

fn analyse_rep( &self, ) -> Result<<<G as CharacterProperties>::CharTab as SubspaceDecomposable<T>>::Decomposition, DecompositionError>

Reduces the representation or corepresentation spanned by the real-space functions in the orbit to a direct sum of the irreducible representations or corepresentations of the generating symmetry group.

Returns

The decomposed result.

Errors

Errors if the decomposition fails, e.g. because one or more calculated multiplicities are non-integral.

fn set_smat(&mut self, smat: Array2<T>)

Sets the overlap matrix between the items in the orbit.

fn smat(&self) -> Option<&Array2<T>>

Returns the overlap matrix between the items in the orbit.

fn xmat(&self) -> &Array2<T>

Returns the transformation matrix $\mathbf{X}$ for the overlap matrix $\mathbf{S}$ between the items in the orbit.

fn norm_preserving_scalar_map(&self, i: usize) -> Result<fn(_: T) -> T, Error>

Returns the norm-preserving scalar map $f$ for every element of the generating group defined by

fn integrality_threshold(&self) -> <T as ComplexFloat>::Real

Returns the threshold for integrality checks of irreducible representation or corepresentation multiplicities.

fn eigenvalue_comparison_mode(&self) -> &EigenvalueComparisonMode

Returns the enumerated type specifying the comparison mode for filtering out orbit overlap eigenvalues.

fn calc_smat( &mut self, metric: Option<&Array<T, D>>, metric_h: Option<&Array<T, D>>, use_cayley_table: bool, ) -> Result<&mut Self, Error>

Calculates and stores the overlap matrix between items in the orbit, with respect to a metric of the basis in which these items are expressed.

fn normalise_smat(&mut self) -> Result<&mut Self, Error>

Normalises overlap matrix between items in the orbit such that its diagonal entries are unity.

fn calc_tmat(&self, op: &G::GroupElement) -> Result<Array2<T>, Error>

Computes the $\mathbf{T}(g)$ matrix for a particular element $g$ of the generating group.

fn calc_dmat(&self, op: &G::GroupElement) -> Result<Array2<T>, Error>

Computes the representation or corepresentation matrix $\mathbf{D}(g)$ for a particular element $g$ in the generating group in the basis of the orbit.

fn calc_character(&self, op: &G::GroupElement) -> Result<T, Error>

Computes the character of a particular element $g$ in the generating group in the basis of the orbit.

fn calc_characters( &self, ) -> Result<Vec<(<G as ClassProperties>::ClassSymbol, T)>, Error>

Computes the characters of the elements in a conjugacy-class transversal of the generating group in the basis of the orbit.