CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
CASM::ConfigInsertResult Struct Reference

#include <Configuration.hh>

Detailed Description

Holds results of Configuration::insert.

  • 'canonical' refers to the canonical form of the Configuration in it's canonical equivalent Supercell. The canonical form may be primitive or non-primitive
  • 'primitive' refers to the primitive canonical Configuration.

Definition at line 61 of file Configuration.hh.

Public Types

typedef ConfigIterator< const
Configuration, const PrimClex
config_const_iterator
 

Public Attributes

bool insert_primitive
 True if primitive did not exist before insertion. More...
 
config_const_iterator primitive_it
 Iterator pointing at primitive. More...
 
bool insert_canonical
 True if canonical configuration did not exist before insertion. More...
 
config_const_iterator canonical_it
 Iterator pointing at canonical, if existing. More...
 

Member Typedef Documentation

Member Data Documentation

config_const_iterator CASM::ConfigInsertResult::canonical_it

Iterator pointing at canonical, if existing.

Definition at line 75 of file Configuration.hh.

bool CASM::ConfigInsertResult::insert_canonical

True if canonical configuration did not exist before insertion.

Definition at line 72 of file Configuration.hh.

bool CASM::ConfigInsertResult::insert_primitive

True if primitive did not exist before insertion.

Definition at line 66 of file Configuration.hh.

config_const_iterator CASM::ConfigInsertResult::primitive_it

Iterator pointing at primitive.

Definition at line 69 of file Configuration.hh.


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