#include <DoF.hh>

Inheritance diagram for CASM::DiscreteDoF:

Detailed Description

Definition at line 109 of file DoF.hh.

Public Member Functions
	DiscreteDoF ()

	DiscreteDoF (const std::string &_name, int _current_state=0, SymGroupRepID _id=SymGroupRepID::identity(0))

virtual	~DiscreteDoF ()

SymGroupRepID	sym_rep_ID () const

void	set_sym_rep_ID (SymGroupRepID _id)

bool	is_specified () const

void	invalidate ()

int	value () const

int	remote_value () const

int const *	remote_ptr () const

void	register_remote (const RemoteHandle &handle)

virtual DiscreteDoF *	copy () const =0

virtual Index	size () const =0

virtual void	set_value (int new_state)

virtual bool	operator== (const DiscreteDoF &RHS) const

void	print (std::ostream &out) const

virtual jsonParser &	to_json (jsonParser &json) const =0

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 ()

Protected Attributes
int	m_current_state
	index into domain of the current state, -1 if unspecified More...

const int *	m_remote_state
	Allows DoF to point to a remote value for faster/easier evaluation. More...

SymGroupRepID	m_sym_rep_ID

std::string	m_type_name

Index	m_dof_ID

bool	m_ID_lock

Constructor & Destructor Documentation

CASM::DiscreteDoF::DiscreteDoF ( )

inline

Definition at line 120 of file DoF.hh.

CASM::DiscreteDoF::DiscreteDoF	(	const std::string &	_name,
		int	_current_state = `0`,
		SymGroupRepID	_id = `SymGroupRepID::identity(0)`
	)

inline

Definition at line 122 of file DoF.hh.

virtual CASM::DiscreteDoF::~DiscreteDoF ( )

inlinevirtual

Definition at line 130 of file DoF.hh.

Member Function Documentation

virtual DiscreteDoF* CASM::DiscreteDoF::copy ( ) const

pure virtual

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

Index CASM::DoF::ID ( ) const

inlineinherited

Definition at line 71 of file DoF.hh.

void CASM::DiscreteDoF::invalidate ( )

inline

Definition at line 144 of file DoF.hh.

bool CASM::DoF::is_locked ( ) const

inlineinherited

Definition at line 82 of file DoF.hh.

bool CASM::DiscreteDoF::is_specified ( ) const

inline

Definition at line 140 of file DoF.hh.

void CASM::DoF::lock_ID ( )

inlineinherited

Definition at line 86 of file DoF.hh.

virtual bool CASM::DiscreteDoF::operator== ( const DiscreteDoF & RHS ) const

inlinevirtual

Definition at line 180 of file DoF.hh.

void CASM::DiscreteDoF::print ( std::ostream & out ) const

inline

Definition at line 190 of file DoF.hh.

void CASM::DiscreteDoF::register_remote ( const RemoteHandle & handle )

inline

Definition at line 162 of file DoF.hh.

int const* CASM::DiscreteDoF::remote_ptr ( ) const

inline

Definition at line 158 of file DoF.hh.

int CASM::DiscreteDoF::remote_value ( ) const

inline

Definition at line 153 of file DoF.hh.

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

inlineinherited

Definition at line 75 of file DoF.hh.

void CASM::DiscreteDoF::set_sym_rep_ID ( SymGroupRepID _id )

inline

Definition at line 136 of file DoF.hh.

virtual void CASM::DiscreteDoF::set_value ( int new_state )

inlinevirtual

Reimplemented in CASM::OccupantDoF< T >, and CASM::OccupantDoF< Molecule >.

Definition at line 175 of file DoF.hh.

virtual Index CASM::DiscreteDoF::size ( ) const

pure virtual

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

SymGroupRepID CASM::DiscreteDoF::sym_rep_ID ( ) const

inline

Definition at line 132 of file DoF.hh.

virtual jsonParser& CASM::DiscreteDoF::to_json ( jsonParser & json ) const

pure virtual

Implements CASM::DoF.

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

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

inlineinherited

Definition at line 49 of file DoF.hh.

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

inlineinherited

Definition at line 53 of file DoF.hh.

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

inlineinherited

Definition at line 62 of file DoF.hh.

void CASM::DoF::unlock_ID ( )

inlineinherited

Definition at line 90 of file DoF.hh.

int CASM::DiscreteDoF::value ( ) const

inline

Definition at line 149 of file DoF.hh.

Member Data Documentation

int CASM::DiscreteDoF::m_current_state

protected

index into domain of the current state, -1 if unspecified

Definition at line 112 of file DoF.hh.

Index CASM::DoF::m_dof_ID

protectedinherited

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

protectedinherited

Definition at line 28 of file DoF.hh.

const int* CASM::DiscreteDoF::m_remote_state

protected

Allows DoF to point to a remote value for faster/easier evaluation.

Definition at line 115 of file DoF.hh.

SymGroupRepID CASM::DiscreteDoF::m_sym_rep_ID

protected

Definition at line 117 of file DoF.hh.

std::string CASM::DoF::m_type_name

protectedinherited

Definition at line 23 of file DoF.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/basis_set/DoF.hh

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation