SuperConfigEnum.hh

Go to the documentation of this file.

#ifndef CASM_SuperConfigEnum
#define CASM_SuperConfigEnum
 
#include "casm/clex/Configuration.hh"
#include "casm/clex/Supercell.hh"
#include "casm/container/Counter.hh"
#include "casm/crystallography/LinearIndexConverter.hh"
#include "casm/enumerator/InputEnumerator.hh"
#include "casm/misc/cloneable_ptr.hh"
 
namespace CASM {
 
class SuperConfigEnum : public InputEnumeratorBase<Configuration> {
  // -- Required members -------------------
 
 public:
  template <typename ConfigIterator>
  SuperConfigEnum(Supercell const &_target_scel,
                  ConfigIterator sub_config_begin,
                  ConfigIterator sub_config_end);
 
  std::string name() const override;
 
  static const std::string enumerator_name;
 
  // -- Unique -------------------
 
  std::vector<Configuration> const &sub_config() const { return m_sub_config; }
 
  Array<int> const &counter() const { return m_counter(); }
 
 private:
  // -- Required members -------------------
 
  void increment() override;
 
  // -- Unique -------------------
 
  void _init();
 
  bool _check_current() const;
 
  Supercell const &_target_supercell() { return m_target_scel; }
 
  Supercell const &_sub_supercell() const { return *m_sub_scel; }
 
  std::vector<Configuration> &_sub_config() { return m_sub_config; }
 
  xtal::UnitCellIndexConverter &_unitcell_index_converter() {
    return *m_unitcell_index_converter;
  }
 
  void _fill(Array<int> const &counter_val, Configuration &config);
 
  Supercell const &m_target_scel;
 
  std::vector<Configuration> m_sub_config;
 
  // All sub_config use the same supercell
  Supercell const *m_sub_scel;
 
  notstd::cloneable_ptr<Configuration> m_current;
 
  Counter<Array<int> > m_counter;
 
  notstd::cloneable_ptr<xtal::UnitCellIndexConverter>
      m_unitcell_index_converter;
 
  std::vector<std::vector<Index> > m_index_map;
};
 
template <typename ConfigIterator>
SuperConfigEnum::SuperConfigEnum(Supercell const &_target_scel,
                                 ConfigIterator sub_config_begin,
                                 ConfigIterator sub_config_end)
    : m_target_scel(_target_scel),
      m_sub_config(sub_config_begin, sub_config_end) {
  _init();
}
 
}  // namespace CASM
 
#endif