ConfigEnumInput.hh

Go to the documentation of this file.

#ifndef CASM_ConfigEnumInput
#define CASM_ConfigEnumInput
 
#include <set>
#include <string>
#include <vector>
 
#include "casm/clex/Configuration.hh"
#include "casm/global/definitions.hh"
 
namespace CASM {
 
class ConfigEnumInput {
 public:
  ConfigEnumInput(Configuration const &_configuration);
 
  ConfigEnumInput(Supercell const &_supercell);
 
  ConfigEnumInput(Configuration const &_configuration,
                  std::set<Index> const &_site_index_selection);
 
  ConfigEnumInput(Supercell const &_supercell,
                  std::set<Index> const &_site_index_selection);
 
  Configuration const &configuration() const;
 
  // /// (deprecated) Prefer using configuration()
  // Configuration const &config() const;
  //
  // /// (deprecated) Prefer using configuration().supercell()
  // Supercell const &supercell() const;
  //
  // /// (deprecated) Prefer using configuration().configdof()
  // ConfigDoF const &configdof() const;
 
  std::set<Index> const &sites() const;
 
  void clear_sites();
 
  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);
 
  void select_sublattice(Index sublattice_index);
 
  template <typename SublatticeIndexContainer>
  void select_sublattices(SublatticeIndexContainer const &_container);
 
 private:
  std::set<Index> m_site_index_selection;
  Configuration m_configuration;
};
 
std::vector<PermuteIterator> make_invariant_subgroup(
    ConfigEnumInput const &config_enum_input);
 
template <typename PermuteIteratorIt>
std::vector<PermuteIterator> make_invariant_subgroup(
    ConfigEnumInput const &config_enum_input, PermuteIteratorIt group_begin,
    PermuteIteratorIt group_end);
 
}  // namespace CASM
 
#endif