CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::ConfigEnumData< EnumeratorType, InitialStateType > Struct Template Reference

#include <enumerate_configurations.hh>

Detailed Description

template<typename EnumeratorType, typename InitialStateType>
struct CASM::ConfigEnumData< EnumeratorType, InitialStateType >

Collect information during enumerate_configurations function for optional output

Definition at line 62 of file enumerate_configurations.hh.

Public Member Functions

 ConfigEnumData (PrimClex const &_primclex, Index _initial_state_index, std::string const &_initial_state_name, InitialStateType const &_initial_state, EnumeratorType const &_enumerator, Configuration const &_configuration)
 

Public Attributes

PrimClex const & primclex
 
Index initial_state_index
 
std::string const & initial_state_name
 
InitialStateType const & initial_state
 
EnumeratorType const & enumerator
 
Configuration const & configuration
 
bool is_excluded_by_filter = false
 
ConfigInsertResult insert_result
 

Constructor & Destructor Documentation

◆ ConfigEnumData()

template<typename EnumeratorType , typename InitialStateType >
CASM::ConfigEnumData< EnumeratorType, InitialStateType >::ConfigEnumData ( PrimClex const &  _primclex,
Index  _initial_state_index,
std::string const &  _initial_state_name,
InitialStateType const &  _initial_state,
EnumeratorType const &  _enumerator,
Configuration const &  _configuration 
)
inline

Definition at line 63 of file enumerate_configurations.hh.

Member Data Documentation

◆ configuration

template<typename EnumeratorType , typename InitialStateType >
Configuration const& CASM::ConfigEnumData< EnumeratorType, InitialStateType >::configuration

Definition at line 80 of file enumerate_configurations.hh.

◆ enumerator

template<typename EnumeratorType , typename InitialStateType >
EnumeratorType const& CASM::ConfigEnumData< EnumeratorType, InitialStateType >::enumerator

Definition at line 79 of file enumerate_configurations.hh.

◆ initial_state

template<typename EnumeratorType , typename InitialStateType >
InitialStateType const& CASM::ConfigEnumData< EnumeratorType, InitialStateType >::initial_state

Definition at line 78 of file enumerate_configurations.hh.

◆ initial_state_index

template<typename EnumeratorType , typename InitialStateType >
Index CASM::ConfigEnumData< EnumeratorType, InitialStateType >::initial_state_index

Definition at line 76 of file enumerate_configurations.hh.

◆ initial_state_name

template<typename EnumeratorType , typename InitialStateType >
std::string const& CASM::ConfigEnumData< EnumeratorType, InitialStateType >::initial_state_name

Definition at line 77 of file enumerate_configurations.hh.

◆ insert_result

template<typename EnumeratorType , typename InitialStateType >
ConfigInsertResult CASM::ConfigEnumData< EnumeratorType, InitialStateType >::insert_result

Definition at line 83 of file enumerate_configurations.hh.

◆ is_excluded_by_filter

template<typename EnumeratorType , typename InitialStateType >
bool CASM::ConfigEnumData< EnumeratorType, InitialStateType >::is_excluded_by_filter = false

Definition at line 82 of file enumerate_configurations.hh.

◆ primclex

template<typename EnumeratorType , typename InitialStateType >
PrimClex const& CASM::ConfigEnumData< EnumeratorType, InitialStateType >::primclex

Definition at line 75 of file enumerate_configurations.hh.


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