CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::EnumerateSupercellsOptions Struct Reference

#include <enumerate_supercells.hh>

Detailed Description

Options for the enumerate_supercells function.

Definition at line 19 of file enumerate_supercells.hh.

Public Member Functions

 EnumerateSupercellsOptions (PrimClex const &primclex)
 

Public Attributes

std::string method_name
 Method name, for printing progress. More...
 
std::function< bool(Supercell const &)> filter
 If filter(supercell)==true, keep supercell, else skip. More...
 
bool dry_run = false
 If dry_run==true, do not save results, just print to screen. More...
 
int verbosity = 10
 Printing verbosity level. More...
 
PrimClex const * primclex_ptr = nullptr
 Use while transitioning Supercell to no longer need a PrimClex const * More...
 

Constructor & Destructor Documentation

◆ EnumerateSupercellsOptions()

CASM::EnumerateSupercellsOptions::EnumerateSupercellsOptions ( PrimClex const &  primclex)
inline

Definition at line 20 of file enumerate_supercells.hh.

Member Data Documentation

◆ dry_run

bool CASM::EnumerateSupercellsOptions::dry_run = false

If dry_run==true, do not save results, just print to screen.

Definition at line 30 of file enumerate_supercells.hh.

◆ filter

std::function<bool(Supercell const &)> CASM::EnumerateSupercellsOptions::filter

If filter(supercell)==true, keep supercell, else skip.

Definition at line 27 of file enumerate_supercells.hh.

◆ method_name

std::string CASM::EnumerateSupercellsOptions::method_name

Method name, for printing progress.

Definition at line 24 of file enumerate_supercells.hh.

◆ primclex_ptr

PrimClex const* CASM::EnumerateSupercellsOptions::primclex_ptr = nullptr

Use while transitioning Supercell to no longer need a PrimClex const *

Definition at line 36 of file enumerate_supercells.hh.

◆ verbosity

int CASM::EnumerateSupercellsOptions::verbosity = 10

Printing verbosity level.

Definition at line 33 of file enumerate_supercells.hh.


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