CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::TemplateSymRepBuilderBase< _uses_time_reversal > Class Template Referenceabstract

#include <SymRepBuilder.hh>

+ Inheritance diagram for CASM::TemplateSymRepBuilderBase< _uses_time_reversal >:

Detailed Description

template<bool _uses_time_reversal>
class CASM::TemplateSymRepBuilderBase< _uses_time_reversal >

Definition at line 73 of file SymRepBuilder.hh.

Public Member Functions

std::string const & name () const
 Returns name of SymRepBuilder type. More...
 
bool time_reversal_active () const
 Returns true if symmetry representation is affected by time-reversal. More...
 
virtual Eigen::MatrixXd symop_to_matrix (Eigen::Ref< const Eigen::Matrix3d > const &_matrix, Eigen::Ref< const Eigen::Vector3d > const &_tau, bool time_reversal, Index dim) const =0
 Given the 3x3 rotation/rotoreflection matrix, translation vector 'tau', and time_reversal operator of Cartesian SymOp, constructs a dim x dim matrix representation of the symop Derived implementations may require that dim have a specific value, or fall within a range of allowed values. More...
 
virtual Eigen::MatrixXcd symop_to_complex_matrix (Eigen::Ref< const Eigen::Matrix3d > const &_matrix, Eigen::Ref< const Eigen::Vector3d > const &_tau, bool time_reversal, Index dim) const
 Given the 3x3 rotation/rotoreflection matrix, translation vector 'tau', and time_reversal operator of Cartesian SymOp, constructs a dim x dim complexmatrix representation of the symop Derived implementations may require that dim have a specific value, or fall within a range of allowed values. More...
 
std::unique_ptr< SymRepBuilderInterfaceclone () const
 

Static Public Attributes

static const bool uses_time_reversal = _uses_time_reversal
 

Protected Member Functions

 TemplateSymRepBuilderBase (std::string const &_name)
 

Private Member Functions

virtual SymRepBuilderInterface_clone () const =0
 

Private Attributes

std::string m_name
 
bool m_time_reversal_active
 

Constructor & Destructor Documentation

◆ TemplateSymRepBuilderBase()

template<bool _uses_time_reversal>
CASM::TemplateSymRepBuilderBase< _uses_time_reversal >::TemplateSymRepBuilderBase ( std::string const &  _name)
inlineprotected

Definition at line 78 of file SymRepBuilder.hh.

Member Function Documentation

◆ _clone()

◆ clone()

std::unique_ptr<SymRepBuilderInterface> CASM::SymRepBuilderInterface::clone ( ) const
inlineinherited

Definition at line 61 of file SymRepBuilder.hh.

◆ name()

std::string const& CASM::SymRepBuilderInterface::name ( ) const
inlineinherited

Returns name of SymRepBuilder type.

Definition at line 29 of file SymRepBuilder.hh.

◆ symop_to_complex_matrix()

virtual Eigen::MatrixXcd CASM::SymRepBuilderInterface::symop_to_complex_matrix ( Eigen::Ref< const Eigen::Matrix3d > const &  _matrix,
Eigen::Ref< const Eigen::Vector3d > const &  _tau,
bool  time_reversal,
Index  dim 
) const
inlinevirtualinherited

Given the 3x3 rotation/rotoreflection matrix, translation vector 'tau', and time_reversal operator of Cartesian SymOp, constructs a dim x dim complexmatrix representation of the symop Derived implementations may require that dim have a specific value, or fall within a range of allowed values.

Definition at line 53 of file SymRepBuilder.hh.

◆ symop_to_matrix()

virtual Eigen::MatrixXd CASM::SymRepBuilderInterface::symop_to_matrix ( Eigen::Ref< const Eigen::Matrix3d > const &  _matrix,
Eigen::Ref< const Eigen::Vector3d > const &  _tau,
bool  time_reversal,
Index  dim 
) const
pure virtualinherited

Given the 3x3 rotation/rotoreflection matrix, translation vector 'tau', and time_reversal operator of Cartesian SymOp, constructs a dim x dim matrix representation of the symop Derived implementations may require that dim have a specific value, or fall within a range of allowed values.

Implemented in CASM::Rank2TensorSymRepBuilder, CASM::dOrbitalOccupationSymRepBuilder, CASM::TimeReversalSwapSymRepBuilder, CASM::TimeReversalSymRepBuilder, CASM::AngularMomentumSymRepBuilder, CASM::IdentitySymRepBuilder, CASM::KroneckerSymRepBuilder< Builder1, Builder2, Dim1, Dim2 >, CASM::KroneckerSymRepBuilder< TimeReversalSwapSymRepBuilder, dOrbitalOccupationSymRepBuilder, 2, 15 >, CASM::CartesianSymRepBuilder, and CASM::NullSymRepBuilder.

◆ time_reversal_active()

bool CASM::SymRepBuilderInterface::time_reversal_active ( ) const
inlineinherited

Returns true if symmetry representation is affected by time-reversal.

Definition at line 33 of file SymRepBuilder.hh.

Member Data Documentation

◆ m_name

std::string CASM::SymRepBuilderInterface::m_name
privateinherited

Definition at line 68 of file SymRepBuilder.hh.

◆ m_time_reversal_active

bool CASM::SymRepBuilderInterface::m_time_reversal_active
privateinherited

Definition at line 69 of file SymRepBuilder.hh.

◆ uses_time_reversal

template<bool _uses_time_reversal>
const bool CASM::TemplateSymRepBuilderBase< _uses_time_reversal >::uses_time_reversal = _uses_time_reversal
static

Definition at line 75 of file SymRepBuilder.hh.


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