CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Member Functions | Private Attributes | List of all members
CASM::ConfigEnumInput Class Reference
Container » Enumerator

#include <ConfigEnumInput.hh>

Detailed Description

Stores a Configuration and a selection of sites in the Configuration

Site naming convention:

  • "sites" and "site_index": Linear index of sites in ConfigDoF
  • "site_uccoord": UnitCellCoord index of a site in the Configuration
  • "sublattice_index": Linear index of basis site in the prim Structure

Definition at line 23 of file ConfigEnumInput.hh.

Public Member Functions

 ConfigEnumInput (Configuration const &_configuration)
 Construct with a Configuration and all sites selected. More...
 
 ConfigEnumInput (Supercell const &_supercell)
 Construct using a Supercell's default Configuration and all sites selected. More...
 
 ConfigEnumInput (Configuration const &_configuration, std::set< Index > const &_site_index_selection)
 Construct with a Configuration and initial site selection. More...
 
 ConfigEnumInput (Supercell const &_supercell, std::set< Index > const &_site_index_selection)
 
Configuration const & configuration () const
 
std::set< Index > const & sites () const
 
void clear_sites ()
 Clear site selection. After condition is no sites are selected. More...
 
void select_all_sites ()
 
void select_site (Index site_index)
 
void select_site (UnitCellCoord const &site_uccord)
 
template<typename SiteContainer >
void select_sites (SiteContainer const &_container)
 Select sites by "site_index" or "site_uccoord". More...
 
void select_sublattice (Index sublattice_index)
 Select all sites on a sublattice. More...
 
template<typename SublatticeIndexContainer >
void select_sublattices (SublatticeIndexContainer const &_container)
 Select all sites on multiples sublattices. More...
 

Private Attributes

std::set< Index > m_site_index_selection
 
Configuration m_configuration
 

Member Data Documentation

◆ m_configuration

Configuration CASM::ConfigEnumInput::m_configuration
private

Definition at line 77 of file ConfigEnumInput.hh.

◆ m_site_index_selection

std::set<Index> CASM::ConfigEnumInput::m_site_index_selection
private

Definition at line 76 of file ConfigEnumInput.hh.

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