CASM  1.1.0
A Clusters Approach to Statistical Mechanics
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 415 of file Configuration.hh.

Public Types

typedef DB::DatabaseIterator< Configurationiterator
 

Public Attributes

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

Member Typedef Documentation

◆ iterator

Member Data Documentation

◆ canonical_it

iterator CASM::ConfigInsertResult::canonical_it

Iterator pointing at canonical, if existing.

Definition at line 428 of file Configuration.hh.

◆ insert_canonical

bool CASM::ConfigInsertResult::insert_canonical

True if canonical configuration did not exist before insertion.

Definition at line 425 of file Configuration.hh.

◆ insert_primitive

bool CASM::ConfigInsertResult::insert_primitive

True if primitive did not exist before insertion.

Definition at line 419 of file Configuration.hh.

◆ primitive_it

iterator CASM::ConfigInsertResult::primitive_it

Iterator pointing at primitive.

Definition at line 422 of file Configuration.hh.


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