CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
Classes | Public Member Functions | Protected Attributes | List of all members
CASM::DoF Class Referenceabstract

#include <DoF.hh>

+ Inheritance diagram for CASM::DoF:

Detailed Description

Definition at line 21 of file DoF.hh.

Classes

class  RemoteHandle
 

Public Member Functions

 DoF (const std::string &_name="", Index _ID=-1)
 
virtual ~DoF ()
 
const std::string & type_name () const
 
std::string type_name_prefix () const
 
std::string type_name_suffix () const
 
Index ID () const
 
void set_ID (Index new_ID)
 
bool is_locked () const
 
void lock_ID ()
 
void unlock_ID ()
 
virtual jsonParser & to_json (jsonParser &json) const =0
 

Protected Attributes

std::string m_type_name
 
Index m_dof_ID
 
bool m_ID_lock
 

Constructor & Destructor Documentation

CASM::DoF::DoF ( const std::string &  _name = "",
Index  _ID = -1 
)
inline

Definition at line 45 of file DoF.hh.

virtual CASM::DoF::~DoF ( )
inlinevirtual

Definition at line 46 of file DoF.hh.

Member Function Documentation

Index CASM::DoF::ID ( ) const
inline

Definition at line 71 of file DoF.hh.

bool CASM::DoF::is_locked ( ) const
inline

Definition at line 82 of file DoF.hh.

void CASM::DoF::lock_ID ( )
inline

Definition at line 86 of file DoF.hh.

void CASM::DoF::set_ID ( Index  new_ID)
inline

Definition at line 75 of file DoF.hh.

virtual jsonParser& CASM::DoF::to_json ( jsonParser &  json) const
pure virtual

Implemented in CASM::ContinuousDoF, CASM::OccupantDoF< T >, CASM::OccupantDoF< Molecule >, CASM::DiscreteDoF, CASM::OccupantDoF< T >, and CASM::OccupantDoF< T >.

const std::string& CASM::DoF::type_name ( ) const
inline

Definition at line 49 of file DoF.hh.

std::string CASM::DoF::type_name_prefix ( ) const
inline

Definition at line 53 of file DoF.hh.

std::string CASM::DoF::type_name_suffix ( ) const
inline

Definition at line 62 of file DoF.hh.

void CASM::DoF::unlock_ID ( )
inline

Definition at line 90 of file DoF.hh.

Member Data Documentation

Index CASM::DoF::m_dof_ID
protected

dof_ID is a way to distinguish between DoFs with the same name but different identities dof_ID for now usually refers to the site index of a cluster (e.g., 0, 1, 2 of a triplet) or an index into the primitive cell neighbor list. Other usage cases may be introduced later

Definition at line 27 of file DoF.hh.

bool CASM::DoF::m_ID_lock
protected

Definition at line 28 of file DoF.hh.

std::string CASM::DoF::m_type_name
protected

Definition at line 23 of file DoF.hh.

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