CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::VectorSpaceMixingInfo Struct Reference

#include <DoFSpace.hh>

Detailed Description

A struct which gives out the mixing information of given column_vector_space and a subspace.

For example, consider a column_vector_space of 3 dimensions. Let it be [q1, q2, q3] where q1, q2 and q3 are columns of the said vector space Let's say q1 - has a zero projection onto the given subspace, q2 - has partial projection onto the subspace, q3 - full projection onto the subspace Then axes_not_in_subspace will be {0} - where 0 is the index of the column of the column_vector_space which has zero projection onto the given subspace Similarly, axes_in_subspace will be {2} & axes_mixed_with_subspace will be {1} If any of the columns of the given column_vector_space has a partial projection onto the subspace, are_axes_mixed_with_subspace will be true; otherwise it will be false

Definition at line 264 of file DoFSpace.hh.

Public Member Functions

 VectorSpaceMixingInfo (Eigen::MatrixXd const &column_vector_space, Eigen::MatrixXd const &subspace, double tol)
 

Public Attributes

std::vector< Indexaxes_not_in_subspace
 
std::vector< Indexaxes_in_subspace
 
std::vector< Indexaxes_mixed_with_subspace
 
bool are_axes_mixed_with_subspace = true
 

Constructor & Destructor Documentation

◆ VectorSpaceMixingInfo()

CASM::VectorSpaceMixingInfo::VectorSpaceMixingInfo ( Eigen::MatrixXd const &  column_vector_space,
Eigen::MatrixXd const &  subspace,
double  tol 
)

Definition at line 809 of file DoFSpace.cc.

Member Data Documentation

◆ are_axes_mixed_with_subspace

bool CASM::VectorSpaceMixingInfo::are_axes_mixed_with_subspace = true

Definition at line 270 of file DoFSpace.hh.

◆ axes_in_subspace

std::vector<Index> CASM::VectorSpaceMixingInfo::axes_in_subspace

Definition at line 268 of file DoFSpace.hh.

◆ axes_mixed_with_subspace

std::vector<Index> CASM::VectorSpaceMixingInfo::axes_mixed_with_subspace

Definition at line 269 of file DoFSpace.hh.

◆ axes_not_in_subspace

std::vector<Index> CASM::VectorSpaceMixingInfo::axes_not_in_subspace

Definition at line 267 of file DoFSpace.hh.


The documentation for this struct was generated from the following files: