CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
Public Types | Public Member Functions | Private Attributes | List of all members
CASM::SiteMod< T > Class Template Reference

#include <DoFMod.hh>

Detailed Description

template<class T>
class CASM::SiteMod< T >

Describes the modification of a variable on a basis site.

SiteMod has information about the occupational change on a single site. It holds only an index corresponding to the site in the ConfigDoF and the final value a variable on that site will have after the modification takes place.

Definition at line 13 of file DoFMod.hh.

Public Types

typedef Index size_type
 

Public Member Functions

 SiteMod ()
 Default constructor. More...
 
 SiteMod (size_type _site_linear_index, size_type _sublat, const T &_to_value)
 Construct a SiteMod. More...
 
size_type site_index () const
 Returns the linear index corresponding to site in ConfigDoF. More...
 
size_type sublat () const
 Returns the sublattice index of site being modified. More...
 
const T & to_value () const
 Returns the value the variable on the site being modified will change to. More...
 
void set (size_type _site_linear_index, size_type _sublat, const T &_to_value)
 Set the values of a SiteMod. More...
 

Private Attributes

size_type m_site_index
 
size_type m_sublat
 
T m_to_value
 

Member Typedef Documentation

template<class T>
typedef Index CASM::SiteMod< T >::size_type

Definition at line 16 of file DoFMod.hh.

Constructor & Destructor Documentation

template<class T>
CASM::SiteMod< T >::SiteMod ( )
inline

Default constructor.

Definition at line 19 of file DoFMod.hh.

template<class T>
CASM::SiteMod< T >::SiteMod ( size_type  _site_linear_index,
size_type  _sublat,
const T &  _to_value 
)
inline

Construct a SiteMod.

Parameters
_site_linear_indexIndex into the unrolled array of sites in the ConfigDoF of site being modified
_sublatSublattice index of site being modified
_to_valueValue the variable on the site being modified will change to

Definition at line 27 of file DoFMod.hh.

Member Function Documentation

template<class T>
void CASM::SiteMod< T >::set ( size_type  _site_linear_index,
size_type  _sublat,
const T &  _to_value 
)
inline

Set the values of a SiteMod.

Parameters
_site_linear_indexIndex into the unrolled array of sites in the ConfigDoF of site being modified
_sublatSublattice index of site being modified
_to_valueValue the variable on the site being modified will change to

Definition at line 53 of file DoFMod.hh.

template<class T>
size_type CASM::SiteMod< T >::site_index ( ) const
inline

Returns the linear index corresponding to site in ConfigDoF.

Definition at line 32 of file DoFMod.hh.

template<class T>
size_type CASM::SiteMod< T >::sublat ( ) const
inline

Returns the sublattice index of site being modified.

Definition at line 37 of file DoFMod.hh.

template<class T>
const T& CASM::SiteMod< T >::to_value ( ) const
inline

Returns the value the variable on the site being modified will change to.

Definition at line 43 of file DoFMod.hh.

Member Data Documentation

template<class T>
size_type CASM::SiteMod< T >::m_site_index
private

Definition at line 62 of file DoFMod.hh.

template<class T>
size_type CASM::SiteMod< T >::m_sublat
private

Definition at line 63 of file DoFMod.hh.

template<class T>
T CASM::SiteMod< T >::m_to_value
private

Definition at line 64 of file DoFMod.hh.

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