CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::SymMatrixXd Class Reference

#include <SymMatrixXd.hh>

+ Inheritance diagram for CASM::SymMatrixXd:

Detailed Description

Generalized symmetry matrix representation for arbitrary dimension Can be used to describe application of symmetry to N-dimensional vector spaces Use for 3-dimensional transformations if they do not describe coordinate transformations.

Definition at line 26 of file SymMatrixXd.hh.

Public Member Functions

 SymMatrixXd (const Eigen::MatrixXd &init_mat)
 
SymOpRepresentationcopy () const override
 Make copy of Derived object through Base-class interface. More...
 
Eigen::MatrixXd const * MatrixXd () const override
 
double character () const override
 Calculates character of the representation (if well-defined) More...
 
virtual Permutation const * permutation () const
 
virtual SymBasisPermute const * ucc_permutation () const
 
std::unique_ptr< SymOpRepresentationinverse () const
 
SymOpRepresentation const & representation (SymGroupRepID _rep_ID) const
 
Eigen::MatrixXd const * get_matrix_rep (SymGroupRepID _rep_ID) const
 get pointer to matrix representation corresponding to rep_ID More...
 
Permutation const * get_permutation_rep (SymGroupRepID _rep_ID) const
 get pointer to permutation representation corresponding to _rep_ID More...
 
SymBasisPermute const * get_basis_permute_rep (SymGroupRepID _rep_ID) const
 get pointer to BasisPermute representation corresponding to _rep_ID More...
 
Array< Eigen::MatrixXd const * > get_matrix_reps (Array< SymGroupRepID > _rep_IDs) const
 
void set_rep (SymGroupRepID _rep_ID, const SymOpRepresentation &op_rep) const
 set representation for SymOp corresponding to _rep_ID More...
 
void set_identifiers (const MasterSymGroup &new_group, SymGroupRepID new_rep_ID)
 Change m_master_group and determine op_index. More...
 
void set_identifiers (const MasterSymGroup &new_group, SymGroupRepID new_rep_ID, Index new_op_index)
 Set m_master_group, _rep_ID, and op_index. More...
 
const MasterSymGroupmaster_group () const
 const access of head group More...
 
bool has_valid_master () const
 check if this representation is registered with a MasterSymGroup More...
 
void invalidate_index ()
 
Index index () const
 
Index master_group_index () const
 Index of this operation within the master_group. More...
 
SymGroupRepID rep_ID () const
 
Index ind_inverse () const
 
Index ind_prod (const SymOpRepresentation &RHS) const
 

Protected Member Functions

virtual SymOpRepresentationinverse_impl () const
 
virtual void _set_integral_tau ()
 

Protected Attributes

MasterSymGroup const * m_master_group
 Pointer to the MasterSymGroup where prototype of this SymOp lives. More...
 
SymGroupRepID m_rep_ID
 
Index m_op_index
 Index into MasterSymGroup that specifies the operation. More...
 

Private Attributes

Eigen::MatrixXd mat
 

Constructor & Destructor Documentation

◆ SymMatrixXd()

CASM::SymMatrixXd::SymMatrixXd ( const Eigen::MatrixXd &  init_mat)
inline

Definition at line 31 of file SymMatrixXd.hh.

Member Function Documentation

◆ _set_integral_tau()

virtual void CASM::SymOpRepresentation::_set_integral_tau ( )
inlineprotectedvirtualinherited

Reimplemented in CASM::SymOp.

Definition at line 130 of file SymOpRepresentation.hh.

◆ character()

double CASM::SymMatrixXd::character ( ) const
inlineoverridevirtual

Calculates character of the representation (if well-defined)

Reimplemented from CASM::SymOpRepresentation.

Definition at line 37 of file SymMatrixXd.hh.

◆ copy()

SymOpRepresentation* CASM::SymMatrixXd::copy ( ) const
inlineoverridevirtual

Make copy of Derived object through Base-class interface.

Implements CASM::SymOpRepresentation.

Definition at line 33 of file SymMatrixXd.hh.

◆ get_basis_permute_rep()

SymBasisPermute const * CASM::SymOpRepresentation::get_basis_permute_rep ( SymGroupRepID  _rep_ID) const
inherited

get pointer to BasisPermute representation corresponding to _rep_ID

Definition at line 36 of file SymOpRepresentation.cc.

◆ get_matrix_rep()

Eigen::MatrixXd const * CASM::SymOpRepresentation::get_matrix_rep ( SymGroupRepID  _rep_ID) const
inherited

get pointer to matrix representation corresponding to rep_ID

Definition at line 28 of file SymOpRepresentation.cc.

◆ get_matrix_reps()

Array< Eigen::MatrixXd const * > CASM::SymOpRepresentation::get_matrix_reps ( Array< SymGroupRepID _rep_IDs) const
inherited

get array of pointers to matrix representations for representations corresponding to _rep_IDs

Definition at line 51 of file SymOpRepresentation.cc.

◆ get_permutation_rep()

Permutation const * CASM::SymOpRepresentation::get_permutation_rep ( SymGroupRepID  _rep_ID) const
inherited

get pointer to permutation representation corresponding to _rep_ID

Definition at line 43 of file SymOpRepresentation.cc.

◆ has_valid_master()

bool CASM::SymOpRepresentation::has_valid_master ( ) const
inlineinherited

check if this representation is registered with a MasterSymGroup

Definition at line 91 of file SymOpRepresentation.hh.

◆ ind_inverse()

Index CASM::SymOpRepresentation::ind_inverse ( ) const
inherited

Get the operation index of the inverse of this operation, using the master_group's multiplication table

Definition at line 101 of file SymOpRepresentation.cc.

◆ ind_prod()

Index CASM::SymOpRepresentation::ind_prod ( const SymOpRepresentation RHS) const
inherited

Get the operation index of operation that is the product of this operation and

Parameters
RHS,usingthe master_group's multiplication table

Definition at line 110 of file SymOpRepresentation.cc.

◆ index()

Index CASM::SymOpRepresentation::index ( ) const
inlineinherited

Index of this operation within the master_group (equivalent to master_group_index)

Definition at line 97 of file SymOpRepresentation.hh.

◆ invalidate_index()

void CASM::SymOpRepresentation::invalidate_index ( )
inlineinherited

Definition at line 93 of file SymOpRepresentation.hh.

◆ inverse()

std::unique_ptr< SymOpRepresentation > CASM::SymOpRepresentation::inverse ( ) const
inherited

Definition at line 12 of file SymOpRepresentation.cc.

◆ inverse_impl()

virtual SymOpRepresentation* CASM::SymOpRepresentation::inverse_impl ( ) const
inlineprotectedvirtualinherited

Reimplemented in CASM::SymPermutation.

Definition at line 124 of file SymOpRepresentation.hh.

◆ master_group()

const MasterSymGroup& CASM::SymOpRepresentation::master_group ( ) const
inlineinherited

const access of head group

Definition at line 85 of file SymOpRepresentation.hh.

◆ master_group_index()

Index CASM::SymOpRepresentation::master_group_index ( ) const
inlineinherited

Index of this operation within the master_group.

Definition at line 100 of file SymOpRepresentation.hh.

◆ MatrixXd()

Eigen::MatrixXd const* CASM::SymMatrixXd::MatrixXd ( ) const
inlineoverridevirtual

Reimplemented from CASM::SymOpRepresentation.

Definition at line 35 of file SymMatrixXd.hh.

◆ permutation()

virtual Permutation const* CASM::SymOpRepresentation::permutation ( ) const
inlinevirtualinherited

Reimplemented in CASM::SymPermutation.

Definition at line 49 of file SymOpRepresentation.hh.

◆ rep_ID()

SymGroupRepID CASM::SymOpRepresentation::rep_ID ( ) const
inlineinherited

ID of representation that this operation belongs to within the master_group

Definition at line 104 of file SymOpRepresentation.hh.

◆ representation()

SymOpRepresentation const & CASM::SymOpRepresentation::representation ( SymGroupRepID  _rep_ID) const
inherited

Definition at line 21 of file SymOpRepresentation.cc.

◆ set_identifiers() [1/2]

void CASM::SymOpRepresentation::set_identifiers ( const MasterSymGroup new_group,
SymGroupRepID  new_rep_ID 
)
inherited

Change m_master_group and determine op_index.

Definition at line 69 of file SymOpRepresentation.cc.

◆ set_identifiers() [2/2]

void CASM::SymOpRepresentation::set_identifiers ( const MasterSymGroup new_group,
SymGroupRepID  new_rep_ID,
Index  new_op_index 
)
inherited

Set m_master_group, _rep_ID, and op_index.

Definition at line 89 of file SymOpRepresentation.cc.

◆ set_rep()

void CASM::SymOpRepresentation::set_rep ( SymGroupRepID  _rep_ID,
const SymOpRepresentation op_rep 
) const
inherited

set representation for SymOp corresponding to _rep_ID

Definition at line 61 of file SymOpRepresentation.cc.

◆ ucc_permutation()

virtual SymBasisPermute const* CASM::SymOpRepresentation::ucc_permutation ( ) const
inlinevirtualinherited

Reimplemented in CASM::SymBasisPermute.

Definition at line 53 of file SymOpRepresentation.hh.

Member Data Documentation

◆ m_master_group

MasterSymGroup const* CASM::SymOpRepresentation::m_master_group
protectedinherited

Pointer to the MasterSymGroup where prototype of this SymOp lives.

Definition at line 133 of file SymOpRepresentation.hh.

◆ m_op_index

Index CASM::SymOpRepresentation::m_op_index
protectedinherited

Index into MasterSymGroup that specifies the operation.

Definition at line 140 of file SymOpRepresentation.hh.

◆ m_rep_ID

SymGroupRepID CASM::SymOpRepresentation::m_rep_ID
protectedinherited

ID of this representation within the master_group. Default is uninitialized.

Definition at line 137 of file SymOpRepresentation.hh.

◆ mat

Eigen::MatrixXd CASM::SymMatrixXd::mat
private

Definition at line 28 of file SymMatrixXd.hh.


The documentation for this class was generated from the following file: