CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Types | Public Member Functions | Private Attributes | List of all members
CASM::ContinuousDoF Class Reference

#include <DoF.hh>

+ Inheritance diagram for CASM::ContinuousDoF:

Detailed Description

Definition at line 359 of file DoF.hh.

Public Types

using Base = DoF::Base
 
using BasicTraits = DoF::BasicTraits
 
using RemoteHandle = DoF::RemoteHandle
 

Public Member Functions

 ContinuousDoF (BasicTraits const &_traits, std::string const &_var_name, Index _ID)
 
 ContinuousDoF (BasicTraits const &_traits)
 
double value () const
 
bool compare (ContinuousDoF const &RHS, bool compare_value=false) const
 
bool operator== (ContinuousDoF const &RHS) const
 
double remote_value () const
 
double const * remote_ptr () const
 
void register_remote (RemoteHandle const &handle) const
 
std::unique_ptr< ContinuousDoF > clone () const
 
BasicTraits const & traits () const
 
std::string type_name () const
 Const access of DoF type name. More...
 
std::string var_name () const
 Const access of variable name. More...
 
Index ID () const
 Const access of integer ID. More...
 
RemoteHandle handle () const
 Create a RemoteHandle that refers to this DoF. More...
 
bool is_locked () const
 true if ID is locked More...
 
void set_ID (Index new_ID)
 mutator to set integer ID if it is unlocked More...
 
void lock_ID ()
 mutator to lock integer ID More...
 
void unlock_ID ()
 mutator to unlock integer ID More...
 

Private Attributes

double current_val
 
double const * m_remote_ptr
 Allows DoF to point to a remote value for faster/easier evaluation. More...
 
BasicTraits m_traits
 
std::string m_var_name
 
Index m_dof_ID
 
bool m_ID_lock
 Locks the ID so that it can't be updated. Is used for global DoF's. More...
 

Member Typedef Documentation

◆ Base

using CASM::ContinuousDoF::Base = DoF::Base

Definition at line 361 of file DoF.hh.

◆ BasicTraits

using CASM::ContinuousDoF::BasicTraits = DoF::BasicTraits

Definition at line 362 of file DoF.hh.

◆ RemoteHandle

using CASM::DoF::Base::RemoteHandle = DoF::RemoteHandle
inherited

Definition at line 121 of file DoF.hh.

Constructor & Destructor Documentation

◆ ContinuousDoF() [1/2]

CASM::ContinuousDoF::ContinuousDoF ( BasicTraits const &  _traits,
std::string const &  _var_name,
Index  _ID 
)
inline

Definition at line 364 of file DoF.hh.

◆ ContinuousDoF() [2/2]

CASM::ContinuousDoF::ContinuousDoF ( BasicTraits const &  _traits)
inline

Definition at line 370 of file DoF.hh.

Member Function Documentation

◆ clone()

std::unique_ptr<ContinuousDoF> CASM::ContinuousDoF::clone ( ) const
inline

Definition at line 401 of file DoF.hh.

◆ compare()

bool CASM::ContinuousDoF::compare ( ContinuousDoF const &  RHS,
bool  compare_value = false 
) const
inline

Definition at line 374 of file DoF.hh.

◆ handle()

RemoteHandle CASM::DoF::Base::handle ( ) const
inlineinherited

Create a RemoteHandle that refers to this DoF.

Definition at line 143 of file DoF.hh.

◆ ID()

Index CASM::DoF::Base::ID ( ) const
inlineinherited

Const access of integer ID.

Definition at line 140 of file DoF.hh.

◆ is_locked()

bool CASM::DoF::Base::is_locked ( ) const
inlineinherited

true if ID is locked

Definition at line 148 of file DoF.hh.

◆ lock_ID()

void CASM::DoF::Base::lock_ID ( )
inlineinherited

mutator to lock integer ID

Definition at line 159 of file DoF.hh.

◆ operator==()

bool CASM::ContinuousDoF::operator== ( ContinuousDoF const &  RHS) const
inline

Definition at line 381 of file DoF.hh.

◆ register_remote()

void CASM::ContinuousDoF::register_remote ( RemoteHandle const &  handle) const
inline

Definition at line 394 of file DoF.hh.

◆ remote_ptr()

double const* CASM::ContinuousDoF::remote_ptr ( ) const
inline

Definition at line 392 of file DoF.hh.

◆ remote_value()

double CASM::ContinuousDoF::remote_value ( ) const
inline

Definition at line 386 of file DoF.hh.

◆ set_ID()

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

mutator to set integer ID if it is unlocked

Definition at line 151 of file DoF.hh.

◆ traits()

BasicTraits const& CASM::DoF::Base::traits ( ) const
inlineinherited

Definition at line 131 of file DoF.hh.

◆ type_name()

std::string CASM::DoF::Base::type_name ( ) const
inlineinherited

Const access of DoF type name.

Definition at line 134 of file DoF.hh.

◆ unlock_ID()

void CASM::DoF::Base::unlock_ID ( )
inlineinherited

mutator to unlock integer ID

Definition at line 162 of file DoF.hh.

◆ value()

double CASM::ContinuousDoF::value ( ) const
inline

Definition at line 372 of file DoF.hh.

◆ var_name()

std::string CASM::DoF::Base::var_name ( ) const
inlineinherited

Const access of variable name.

Definition at line 137 of file DoF.hh.

Member Data Documentation

◆ current_val

double CASM::ContinuousDoF::current_val
private

Definition at line 406 of file DoF.hh.

◆ m_dof_ID

Index CASM::DoF::Base::m_dof_ID
privateinherited

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 172 of file DoF.hh.

◆ m_ID_lock

bool CASM::DoF::Base::m_ID_lock
privateinherited

Locks the ID so that it can't be updated. Is used for global DoF's.

Definition at line 175 of file DoF.hh.

◆ m_remote_ptr

double const* CASM::ContinuousDoF::m_remote_ptr
mutableprivate

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

Definition at line 409 of file DoF.hh.

◆ m_traits

BasicTraits CASM::DoF::Base::m_traits
privateinherited

Definition at line 165 of file DoF.hh.

◆ m_var_name

std::string CASM::DoF::Base::m_var_name
privateinherited

Definition at line 166 of file DoF.hh.

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