CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
CASM::ConfigEnumRandomLocal Class Reference
Clex » Configuration | Container » Enumerator » Configuration Enumerators

#include <ConfigEnumRandomLocal.hh>

+ Inheritance diagram for CASM::ConfigEnumRandomLocal:

Detailed Description

Enumerate random values for continuous degrees of freedom.

Definition at line 50 of file ConfigEnumRandomLocal.hh.

Public Types

typedef InputEnumIterator< Configuration, true > iterator
 
typedef ValueType value_type
 
typedef CASM_TMP::ConstSwitch< IsConst, ValueType > & reference
 
typedef long step_type
 

Public Member Functions

 ConfigEnumRandomLocal (ConfigEnumInput const &_in_config, ConfigEnumRandomLocalParams const &params)
 
 ConfigEnumRandomLocal (ConfigEnumInput const &_in_config, DoFKey const &_dof_key, Index _n_config, double _mag, bool _normal, MTRand &_mtrand)
 
std::string name () const override
 Derived enumerators must implement name, via ENUM_MEMBERS. More...
 
iterator begin ()
 
iterator end ()
 
reference current () const
 Access the current ObjectType by reference. More...
 
virtual std::string name () const=0
 Derived enumerators must implement name, via ENUM_MEMBERS. More...
 
virtual jsonParser source (step_type step) const
 
virtual jsonParser source (step_type step) const
 
step_type step () const
 Increments with each enumerated object. More...
 
step_type step () const
 Increments with each enumerated object. More...
 
bool valid () const
 Returns false if enumeration is complete. More...
 
bool valid () const
 Returns false if enumeration is complete. More...
 

Static Public Attributes

static const std::string enumerator_name
 

Protected Member Functions

void _initialize (CASM_TMP::ConstSwitch< IsConst, value_type > *_initial)
 
void _initialize ()
 
void _set_current_ptr (CASM_TMP::ConstSwitch< IsConst, value_type > *_new)
 Change the pointer. More...
 
void _decrement_step ()
 Decrement current step value. More...
 
void _increment_step ()
 Increment current step value. More...
 
void _invalidate ()
 Call if enumeration complete. More...
 
void _set_step (step_type val)
 Set current step value. More...
 
void _set_step (step_type val)
 Set current step value. More...
 
void _validate ()
 Used if random access enumerator step is moved into valid range. More...
 

Private Member Functions

void increment () override
 Implements increment. More...
 
void randomize ()
 

Private Attributes

DoFKey m_dof_key
 
Index m_n_config
 
LocalContinuousConfigDoFValues * m_dof_vals
 
MTRand & m_mtrand
 
double m_mag
 
bool m_normal
 
bool m_unit_length
 
std::vector< Index > m_site_selection
 
std::vector< Index > m_dof_dims
 
notstd::cloneable_ptr< Configuration > m_current
 
friend InputEnumIteratorBase< ValueType, IsConst >
 
CASM_TMP::ConstSwitch< IsConst, value_type > * m_current_ptr
 
bool m_valid
 
step_type m_step
 

Member Typedef Documentation

◆ iterator

typedef InputEnumIterator<Configuration , true > CASM::InputEnumeratorBase< Configuration , true >::iterator
inherited

Definition at line 204 of file InputEnumerator.hh.

◆ reference

template<typename ValueType , bool IsConst = true>
typedef CASM_TMP::ConstSwitch<IsConst, ValueType>& CASM::ValEnumerator< ValueType, IsConst >::reference
inherited

Definition at line 174 of file Enumerator.hh.

◆ step_type

template<typename ValueType , bool IsConst = true>
typedef long CASM::EnumeratorBase::step_type
inherited

Definition at line 107 of file Enumerator.hh.

◆ value_type

template<typename ValueType , bool IsConst = true>
typedef ValueType CASM::ValEnumerator< ValueType, IsConst >::value_type
inherited

Definition at line 173 of file Enumerator.hh.

Constructor & Destructor Documentation

◆ ConfigEnumRandomLocal() [1/2]

CASM::ConfigEnumRandomLocal::ConfigEnumRandomLocal ( ConfigEnumInput const &  _in_config,
ConfigEnumRandomLocalParams const &  params 
)

Definition at line 17 of file ConfigEnumRandomLocal.cc.

◆ ConfigEnumRandomLocal() [2/2]

CASM::ConfigEnumRandomLocal::ConfigEnumRandomLocal ( ConfigEnumInput const &  _in_config,
DoFKey const &  _dof_key,
Index  _n_config,
double  _mag,
bool  _normal,
MTRand &  _mtrand 
)

Definition at line 24 of file ConfigEnumRandomLocal.cc.

Member Function Documentation

◆ _decrement_step()

template<typename ValueType , bool IsConst = true>
void CASM::EnumeratorBase::_decrement_step
inlineprotectedinherited

Decrement current step value.

Definition at line 156 of file Enumerator.hh.

◆ _increment_step()

template<typename ValueType , bool IsConst = true>
void CASM::EnumeratorBase::_increment_step
inlineprotectedinherited

Increment current step value.

Definition at line 153 of file Enumerator.hh.

◆ _initialize() [1/2]

template<typename ValueType , bool IsConst = true>
void CASM::EnumeratorBase::_initialize
inlineprotectedinherited

Initialize

  • Sets step to 0
  • Sets valid to true

Definition at line 144 of file Enumerator.hh.

◆ _initialize() [2/2]

template<typename ValueType , bool IsConst = true>
void CASM::ValEnumerator< ValueType, IsConst >::_initialize ( CASM_TMP::ConstSwitch< IsConst, value_type > *  _initial)
inlineprotectedinherited

Initialize

  • Sets current to point at _initial
  • Sets step to 0
  • Sets valid to true

Definition at line 197 of file Enumerator.hh.

◆ _invalidate()

template<typename ValueType , bool IsConst = true>
void CASM::EnumeratorBase::_invalidate
inlineprotectedinherited

Call if enumeration complete.

Definition at line 159 of file Enumerator.hh.

◆ _set_current_ptr()

template<typename ValueType , bool IsConst = true>
void CASM::ValEnumerator< ValueType, IsConst >::_set_current_ptr ( CASM_TMP::ConstSwitch< IsConst, value_type > *  _new)
inlineprotectedinherited

Change the pointer.

Definition at line 215 of file Enumerator.hh.

◆ _set_step() [1/2]

void CASM::EnumeratorBase::_set_step ( step_type  val)
inlineprotectedinherited

Set current step value.

Definition at line 150 of file Enumerator.hh.

◆ _set_step() [2/2]

template<typename ValueType , bool IsConst = true>
void CASM::EnumeratorBase::_set_step
inlineprotectedinherited

Set current step value.

Definition at line 150 of file Enumerator.hh.

◆ _validate()

void CASM::EnumeratorBase::_validate ( )
inlineprotectedinherited

Used if random access enumerator step is moved into valid range.

Definition at line 162 of file Enumerator.hh.

◆ begin()

iterator CASM::InputEnumeratorBase< Configuration , true >::begin ( )
inlineinherited

Definition at line 216 of file InputEnumerator.hh.

◆ current()

template<typename ValueType , bool IsConst = true>
reference CASM::ValEnumerator< ValueType, IsConst >::current ( ) const
inlineinherited

Access the current ObjectType by reference.

Definition at line 211 of file Enumerator.hh.

◆ end()

iterator CASM::InputEnumeratorBase< Configuration , true >::end ( )
inlineinherited

Definition at line 220 of file InputEnumerator.hh.

◆ increment()

void CASM::ConfigEnumRandomLocal::increment ( )
overrideprivatevirtual

Implements increment.

Set m_current to correct value at specified step and return a reference to it

Implements CASM::InputEnumeratorBase< Configuration >.

Definition at line 75 of file ConfigEnumRandomLocal.cc.

◆ name() [1/2]

std::string CASM::ConfigEnumRandomLocal::name ( ) const
overridevirtual

Derived enumerators must implement name, via ENUM_MEMBERS.

Implements CASM::EnumeratorBase.

Definition at line 68 of file ConfigEnumRandomLocal.cc.

◆ name() [2/2]

template<typename ValueType , bool IsConst = true>
virtual std::string CASM::EnumeratorBase::name
inherited

Derived enumerators must implement name, via ENUM_MEMBERS.

◆ randomize()

void CASM::ConfigEnumRandomLocal::randomize ( )
private

Definition at line 85 of file ConfigEnumRandomLocal.cc.

◆ source() [1/2]

virtual jsonParser CASM::EnumeratorBase::source ( step_type  step) const
inlinevirtualinherited

Default Object source just uses step#

Returns:

{
"enumerated_by": "<enumerator_type>",
"step": <step #>
}
CASM::ValEnumerator::step
step_type step() const
Increments with each enumerated object.
Definition: Enumerator.hh:115

Definition at line 129 of file Enumerator.hh.

◆ source() [2/2]

template<typename ValueType , bool IsConst = true>
virtual jsonParser CASM::EnumeratorBase::source
inlineinherited

Default Object source just uses step#

Returns:

{
"enumerated_by": "<enumerator_type>",
"step": <step #>
}

Definition at line 129 of file Enumerator.hh.

◆ step() [1/2]

step_type CASM::EnumeratorBase::step ( ) const
inlineinherited

Increments with each enumerated object.

Definition at line 115 of file Enumerator.hh.

◆ step() [2/2]

template<typename ValueType , bool IsConst = true>
step_type CASM::EnumeratorBase::step
inlineinherited

Increments with each enumerated object.

Definition at line 115 of file Enumerator.hh.

◆ valid() [1/2]

bool CASM::EnumeratorBase::valid ( ) const
inlineinherited

Returns false if enumeration is complete.

Definition at line 118 of file Enumerator.hh.

◆ valid() [2/2]

template<typename ValueType , bool IsConst = true>
bool CASM::EnumeratorBase::valid
inlineinherited

Returns false if enumeration is complete.

Definition at line 118 of file Enumerator.hh.

Member Data Documentation

◆ enumerator_name

const std::string CASM::ConfigEnumRandomLocal::enumerator_name
static
Initial value:
=
"ConfigEnumRandomLocal"

Definition at line 63 of file ConfigEnumRandomLocal.hh.

◆ InputEnumIteratorBase< ValueType, IsConst >

friend CASM::InputEnumeratorBase< Configuration , true >::InputEnumIteratorBase< Configuration , true >
privateinherited

Definition at line 198 of file InputEnumerator.hh.

◆ m_current

notstd::cloneable_ptr<Configuration> CASM::ConfigEnumRandomLocal::m_current
private

Definition at line 102 of file ConfigEnumRandomLocal.hh.

◆ m_current_ptr

template<typename ValueType , bool IsConst = true>
CASM_TMP::ConstSwitch<IsConst, value_type>* CASM::ValEnumerator< ValueType, IsConst >::m_current_ptr
privateinherited

Definition at line 220 of file Enumerator.hh.

◆ m_dof_dims

std::vector<Index> CASM::ConfigEnumRandomLocal::m_dof_dims
private

Definition at line 100 of file ConfigEnumRandomLocal.hh.

◆ m_dof_key

DoFKey CASM::ConfigEnumRandomLocal::m_dof_key
private

Definition at line 74 of file ConfigEnumRandomLocal.hh.

◆ m_dof_vals

LocalContinuousConfigDoFValues* CASM::ConfigEnumRandomLocal::m_dof_vals
private

Definition at line 79 of file ConfigEnumRandomLocal.hh.

◆ m_mag

double CASM::ConfigEnumRandomLocal::m_mag
private

Definition at line 86 of file ConfigEnumRandomLocal.hh.

◆ m_mtrand

MTRand& CASM::ConfigEnumRandomLocal::m_mtrand
private

Definition at line 82 of file ConfigEnumRandomLocal.hh.

◆ m_n_config

Index CASM::ConfigEnumRandomLocal::m_n_config
private

Definition at line 77 of file ConfigEnumRandomLocal.hh.

◆ m_normal

bool CASM::ConfigEnumRandomLocal::m_normal
private

Definition at line 90 of file ConfigEnumRandomLocal.hh.

◆ m_site_selection

std::vector<Index> CASM::ConfigEnumRandomLocal::m_site_selection
private

Definition at line 97 of file ConfigEnumRandomLocal.hh.

◆ m_step

step_type CASM::EnumeratorBase::m_step
privateinherited

Definition at line 167 of file Enumerator.hh.

◆ m_unit_length

bool CASM::ConfigEnumRandomLocal::m_unit_length
private

Definition at line 94 of file ConfigEnumRandomLocal.hh.

◆ m_valid

bool CASM::EnumeratorBase::m_valid
privateinherited

Definition at line 165 of file Enumerator.hh.

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